{ "openapi": "3.0.0", "info": { "title": "Sandbox API", "version": "1.0.0" }, "servers": [ { "url": "/" }, { "url": "https://api.ati.su" } ], "security": [ { "BearerAuth": [] } ], "paths": { "/v1.2/auction": { "get": { "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": [ { "accept_second_pay_type": true, "active_deal_id": "adb51ee2-2eda-4e1b-9081-6d95f10e8466", "auction_id": "e1143412-6bf4-43f3-932b-d00f9a65849c", "auction_rates": [ { "added_at": "2023-04-24T11:31:51.9748922Z", "ati_id": "12345", "auction_rate_id": "8afae956-adcd-4bdd-9676-f3a8485a6d25", "contact_id": 0, "loading_date": null, "rate_with_nds": 5500, "rate_without_nds": 6600, "source": 0, "state": 0 }, { "added_at": "2023-04-24T11:32:51.9749001Z", "ati_id": "33345", "auction_rate_id": "789d9dea-98d5-4a71-8c9d-de9be2ca6b86", "contact_id": 0, "loading_date": null, "rate_with_nds": 5000, "rate_without_nds": 6000, "source": 0, "state": 1 } ], "auction_restart_parameters": { "auction_finish_action": 1, "current_change_winner_count": 2, "current_restart_count": 1, "duration_after_restart": 30, "init_change_winner_count": 2, "init_restart_count": 1, "is_manually_restarted": false, "rate_increase": null, "rate_increase_option": null }, "auto_renew": true, "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "deleted": false, "docs_expired_date": "2023-04-24T14:36:51.9749155Z", "duration": 6, "end_date": "2023-04-24T11:36:51.9749281Z", "end_date_boundary": "2023-04-24T11:36:51.9749281Z", "finish_type": 0, "finished": true, "is_docs_expired": false, "load_id": "aeae42f6-0102-46e4-8310-2fa8cd23d771", "max_rate": 6000, "max_renew_time": 60, "nds": 20, "participants_count": 2, "raise_bid": true, "raise_bid_interval": 30, "renew_time": 20, "response_in_minutes": 0, "response_prohibited": false, "server_date": "2023-04-24T11:36:51.9752751Z", "start_date": "2023-04-24T11:30:51.9749144Z", "start_since_first_bet": false, "state": 0, "step": 500, "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:51.9749244Z", "winner_criterion": 0 } ] } }, "schema": { "items": { "$ref": "#/components/schemas/AuctionOfLoadOwner" }, "type": "array" } }, "text/json": { "examples": { "response": { "value": [ { "accept_second_pay_type": true, "active_deal_id": "adb51ee2-2eda-4e1b-9081-6d95f10e8466", "auction_id": "e1143412-6bf4-43f3-932b-d00f9a65849c", "auction_rates": [ { "added_at": "2023-04-24T11:31:51.9748922Z", "ati_id": "12345", "auction_rate_id": "8afae956-adcd-4bdd-9676-f3a8485a6d25", "contact_id": 0, "loading_date": null, "rate_with_nds": 5500, "rate_without_nds": 6600, "source": 0, "state": 0 }, { "added_at": "2023-04-24T11:32:51.9749001Z", "ati_id": "33345", "auction_rate_id": "789d9dea-98d5-4a71-8c9d-de9be2ca6b86", "contact_id": 0, "loading_date": null, "rate_with_nds": 5000, "rate_without_nds": 6000, "source": 0, "state": 1 } ], "auction_restart_parameters": { "auction_finish_action": 1, "current_change_winner_count": 2, "current_restart_count": 1, "duration_after_restart": 30, "init_change_winner_count": 2, "init_restart_count": 1, "is_manually_restarted": false, "rate_increase": null, "rate_increase_option": null }, "auto_renew": true, "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "deleted": false, "docs_expired_date": "2023-04-24T14:36:51.9749155Z", "duration": 6, "end_date": "2023-04-24T11:36:51.9749281Z", "end_date_boundary": "2023-04-24T11:36:51.9749281Z", "finish_type": 0, "finished": true, "is_docs_expired": false, "load_id": "aeae42f6-0102-46e4-8310-2fa8cd23d771", "max_rate": 6000, "max_renew_time": 60, "nds": 20, "participants_count": 2, "raise_bid": true, "raise_bid_interval": 30, "renew_time": 20, "response_in_minutes": 0, "response_prohibited": false, "server_date": "2023-04-24T11:36:51.9752751Z", "start_date": "2023-04-24T11:30:51.9749144Z", "start_since_first_bet": false, "state": 0, "step": 500, "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:51.9749244Z", "winner_criterion": 0 } ] } }, "schema": { "items": { "$ref": "#/components/schemas/AuctionOfLoadOwner" }, "type": "array" } }, "text/plain": { "examples": { "response": { "value": [ { "accept_second_pay_type": true, "active_deal_id": "adb51ee2-2eda-4e1b-9081-6d95f10e8466", "auction_id": "e1143412-6bf4-43f3-932b-d00f9a65849c", "auction_rates": [ { "added_at": "2023-04-24T11:31:51.9748922Z", "ati_id": "12345", "auction_rate_id": "8afae956-adcd-4bdd-9676-f3a8485a6d25", "contact_id": 0, "loading_date": null, "rate_with_nds": 5500, "rate_without_nds": 6600, "source": 0, "state": 0 }, { "added_at": "2023-04-24T11:32:51.9749001Z", "ati_id": "33345", "auction_rate_id": "789d9dea-98d5-4a71-8c9d-de9be2ca6b86", "contact_id": 0, "loading_date": null, "rate_with_nds": 5000, "rate_without_nds": 6000, "source": 0, "state": 1 } ], "auction_restart_parameters": { "auction_finish_action": 1, "current_change_winner_count": 2, "current_restart_count": 1, "duration_after_restart": 30, "init_change_winner_count": 2, "init_restart_count": 1, "is_manually_restarted": false, "rate_increase": null, "rate_increase_option": null }, "auto_renew": true, "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "deleted": false, "docs_expired_date": "2023-04-24T14:36:51.9749155Z", "duration": 6, "end_date": "2023-04-24T11:36:51.9749281Z", "end_date_boundary": "2023-04-24T11:36:51.9749281Z", "finish_type": 0, "finished": true, "is_docs_expired": false, "load_id": "aeae42f6-0102-46e4-8310-2fa8cd23d771", "max_rate": 6000, "max_renew_time": 60, "nds": 20, "participants_count": 2, "raise_bid": true, "raise_bid_interval": 30, "renew_time": 20, "response_in_minutes": 0, "response_prohibited": false, "server_date": "2023-04-24T11:36:51.9752751Z", "start_date": "2023-04-24T11:30:51.9749144Z", "start_since_first_bet": false, "state": 0, "step": 500, "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:51.9749244Z", "winner_criterion": 0 } ] } }, "schema": { "items": { "$ref": "#/components/schemas/AuctionOfLoadOwner" }, "type": "array" } } }, "description": "Торги (аукционы) грузовладельца" } }, "tags": [ "Auctions" ], "summary": "Получение всех Торгов (аукционов) для грузовладельца" } }, "/v1.2/auction/{auctionId}": { "get": { "parameters": [ { "description": "Id Торгов (аукциона)", "in": "path", "name": "auctionId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "Возвращать удалённые торги", "in": "query", "name": "withDeleted", "schema": { "default": true, "type": "boolean" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "accept_second_pay_type": true, "active_deal_id": "4300ad9e-c164-447d-a00c-1b0f16355c89", "auction_id": "edfa4cbc-868f-4ce7-89e2-8764df59151a", "auction_rates": [ { "added_at": "2023-04-24T11:31:51.9296722Z", "ati_id": "12345", "auction_rate_id": "fb6093ff-28e8-4c45-ac33-5c88e68b349f", "contact_id": 0, "loading_date": null, "rate_with_nds": 5500, "rate_without_nds": 6600, "source": 0, "state": 0 }, { "added_at": "2023-04-24T11:32:51.9296877Z", "ati_id": "33345", "auction_rate_id": "fdae4ca4-8c8b-44ac-9174-21614de4341f", "contact_id": 0, "loading_date": null, "rate_with_nds": 5000, "rate_without_nds": 6000, "source": 0, "state": 1 } ], "auction_restart_parameters": { "auction_finish_action": 1, "current_change_winner_count": 2, "current_restart_count": 1, "duration_after_restart": 30, "init_change_winner_count": 2, "init_restart_count": 1, "is_manually_restarted": false, "rate_increase": null, "rate_increase_option": null }, "auto_renew": true, "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "deleted": false, "docs_expired_date": "2023-04-24T14:36:51.9297113Z", "duration": 6, "end_date": "2023-04-24T11:36:51.9297297Z", "end_date_boundary": "2023-04-24T11:36:51.9297268Z", "finish_type": 0, "finished": true, "is_docs_expired": false, "load_id": "a2f03352-d1f2-4d76-bc65-94d5c2914847", "max_rate": 6000, "max_renew_time": 60, "nds": 20, "participants_count": 2, "raise_bid": true, "raise_bid_interval": 30, "renew_time": 20, "response_in_minutes": 0, "response_prohibited": false, "server_date": "2023-04-24T11:36:51.9302947Z", "start_date": "2023-04-24T11:30:51.9297089Z", "start_since_first_bet": false, "state": 0, "step": 500, "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:51.9297244Z", "winner_criterion": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionOfLoadOwner" } }, "text/json": { "examples": { "response": { "value": { "accept_second_pay_type": true, "active_deal_id": "4300ad9e-c164-447d-a00c-1b0f16355c89", "auction_id": "edfa4cbc-868f-4ce7-89e2-8764df59151a", "auction_rates": [ { "added_at": "2023-04-24T11:31:51.9296722Z", "ati_id": "12345", "auction_rate_id": "fb6093ff-28e8-4c45-ac33-5c88e68b349f", "contact_id": 0, "loading_date": null, "rate_with_nds": 5500, "rate_without_nds": 6600, "source": 0, "state": 0 }, { "added_at": "2023-04-24T11:32:51.9296877Z", "ati_id": "33345", "auction_rate_id": "fdae4ca4-8c8b-44ac-9174-21614de4341f", "contact_id": 0, "loading_date": null, "rate_with_nds": 5000, "rate_without_nds": 6000, "source": 0, "state": 1 } ], "auction_restart_parameters": { "auction_finish_action": 1, "current_change_winner_count": 2, "current_restart_count": 1, "duration_after_restart": 30, "init_change_winner_count": 2, "init_restart_count": 1, "is_manually_restarted": false, "rate_increase": null, "rate_increase_option": null }, "auto_renew": true, "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "deleted": false, "docs_expired_date": "2023-04-24T14:36:51.9297113Z", "duration": 6, "end_date": "2023-04-24T11:36:51.9297297Z", "end_date_boundary": "2023-04-24T11:36:51.9297268Z", "finish_type": 0, "finished": true, "is_docs_expired": false, "load_id": "a2f03352-d1f2-4d76-bc65-94d5c2914847", "max_rate": 6000, "max_renew_time": 60, "nds": 20, "participants_count": 2, "raise_bid": true, "raise_bid_interval": 30, "renew_time": 20, "response_in_minutes": 0, "response_prohibited": false, "server_date": "2023-04-24T11:36:51.9302947Z", "start_date": "2023-04-24T11:30:51.9297089Z", "start_since_first_bet": false, "state": 0, "step": 500, "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:51.9297244Z", "winner_criterion": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionOfLoadOwner" } }, "text/plain": { "examples": { "response": { "value": { "accept_second_pay_type": true, "active_deal_id": "4300ad9e-c164-447d-a00c-1b0f16355c89", "auction_id": "edfa4cbc-868f-4ce7-89e2-8764df59151a", "auction_rates": [ { "added_at": "2023-04-24T11:31:51.9296722Z", "ati_id": "12345", "auction_rate_id": "fb6093ff-28e8-4c45-ac33-5c88e68b349f", "contact_id": 0, "loading_date": null, "rate_with_nds": 5500, "rate_without_nds": 6600, "source": 0, "state": 0 }, { "added_at": "2023-04-24T11:32:51.9296877Z", "ati_id": "33345", "auction_rate_id": "fdae4ca4-8c8b-44ac-9174-21614de4341f", "contact_id": 0, "loading_date": null, "rate_with_nds": 5000, "rate_without_nds": 6000, "source": 0, "state": 1 } ], "auction_restart_parameters": { "auction_finish_action": 1, "current_change_winner_count": 2, "current_restart_count": 1, "duration_after_restart": 30, "init_change_winner_count": 2, "init_restart_count": 1, "is_manually_restarted": false, "rate_increase": null, "rate_increase_option": null }, "auto_renew": true, "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "deleted": false, "docs_expired_date": "2023-04-24T14:36:51.9297113Z", "duration": 6, "end_date": "2023-04-24T11:36:51.9297297Z", "end_date_boundary": "2023-04-24T11:36:51.9297268Z", "finish_type": 0, "finished": true, "is_docs_expired": false, "load_id": "a2f03352-d1f2-4d76-bc65-94d5c2914847", "max_rate": 6000, "max_renew_time": 60, "nds": 20, "participants_count": 2, "raise_bid": true, "raise_bid_interval": 30, "renew_time": 20, "response_in_minutes": 0, "response_prohibited": false, "server_date": "2023-04-24T11:36:51.9302947Z", "start_date": "2023-04-24T11:30:51.9297089Z", "start_since_first_bet": false, "state": 0, "step": 500, "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:51.9297244Z", "winner_criterion": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionOfLoadOwner" } } }, "description": "Торги (аукцион) для грузовладельца (код 200)" }, "201": { "content": { "application/json": { "examples": { "response": { "value": { "auction_id": "248de03c-c445-4cca-8858-4e9b495ce3d7", "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "end_date": "2023-04-24T11:36:51.930351Z", "finished": false, "is_our_rate_best": true, "load_id": "dcbe9875-ebb8-4c06-bbb9-ab4093c5fe20", "next_rate_with_nds": 5500, "next_rate_without_nds": 6600, "our_rate": { "added_at": "2023-04-24T11:35:51.9303557Z", "auction_rate_id": "47c55885-1ca1-4d05-bc66-968d0e53f0ce", "contact_id": 1, "loading_date": null, "rate_with_nds": 4500, "rate_without_nds": 5400, "state": 0 }, "participants_count": 2, "response_prohibited": false, "server_date": "2023-04-24T11:36:51.9305017Z", "start_date": "2023-04-24T11:30:51.930351Z", "winner_criterion": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionOfTaker" } }, "text/json": { "examples": { "response": { "value": { "auction_id": "248de03c-c445-4cca-8858-4e9b495ce3d7", "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "end_date": "2023-04-24T11:36:51.930351Z", "finished": false, "is_our_rate_best": true, "load_id": "dcbe9875-ebb8-4c06-bbb9-ab4093c5fe20", "next_rate_with_nds": 5500, "next_rate_without_nds": 6600, "our_rate": { "added_at": "2023-04-24T11:35:51.9303557Z", "auction_rate_id": "47c55885-1ca1-4d05-bc66-968d0e53f0ce", "contact_id": 1, "loading_date": null, "rate_with_nds": 4500, "rate_without_nds": 5400, "state": 0 }, "participants_count": 2, "response_prohibited": false, "server_date": "2023-04-24T11:36:51.9305017Z", "start_date": "2023-04-24T11:30:51.930351Z", "winner_criterion": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionOfTaker" } }, "text/plain": { "examples": { "response": { "value": { "auction_id": "248de03c-c445-4cca-8858-4e9b495ce3d7", "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "end_date": "2023-04-24T11:36:51.930351Z", "finished": false, "is_our_rate_best": true, "load_id": "dcbe9875-ebb8-4c06-bbb9-ab4093c5fe20", "next_rate_with_nds": 5500, "next_rate_without_nds": 6600, "our_rate": { "added_at": "2023-04-24T11:35:51.9303557Z", "auction_rate_id": "47c55885-1ca1-4d05-bc66-968d0e53f0ce", "contact_id": 1, "loading_date": null, "rate_with_nds": 4500, "rate_without_nds": 5400, "state": 0 }, "participants_count": 2, "response_prohibited": false, "server_date": "2023-04-24T11:36:51.9305017Z", "start_date": "2023-04-24T11:30:51.930351Z", "winner_criterion": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionOfTaker" } } }, "description": "Торги (аукцион) для участника (код 200)" }, "202": { "content": { "application/json": { "examples": { "response": { "value": { "active_deal_id": "38bd5f61-d3e4-432f-be4c-6bcf0a5b7045", "auction_id": "fd831353-d13d-43a1-91d3-6ad06c84a8db", "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "docs_expired_date": "2023-04-24T14:36:51.9305482Z", "end_date": "2023-04-24T11:36:51.93054Z", "finished": true, "is_docs_expired": false, "load_id": "f0f98614-3fa3-4a6f-87ed-953b0f500eeb", "our_rate": { "added_at": "2023-04-24T11:35:51.9305428Z", "auction_rate_id": "242bc0ad-56d9-49c1-93eb-7e93f53b139e", "contact_id": 1, "loading_date": null, "rate_with_nds": 6000, "rate_without_nds": 5000, "state": 1 }, "participants_count": 2, "response_prohibited": false, "server_date": "2023-04-24T11:36:51.9306908Z", "start_date": "2023-04-24T11:30:51.93054Z", "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:51.9305506Z", "winner_criterion": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionOfTakerWinner" } }, "text/json": { "examples": { "response": { "value": { "active_deal_id": "38bd5f61-d3e4-432f-be4c-6bcf0a5b7045", "auction_id": "fd831353-d13d-43a1-91d3-6ad06c84a8db", "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "docs_expired_date": "2023-04-24T14:36:51.9305482Z", "end_date": "2023-04-24T11:36:51.93054Z", "finished": true, "is_docs_expired": false, "load_id": "f0f98614-3fa3-4a6f-87ed-953b0f500eeb", "our_rate": { "added_at": "2023-04-24T11:35:51.9305428Z", "auction_rate_id": "242bc0ad-56d9-49c1-93eb-7e93f53b139e", "contact_id": 1, "loading_date": null, "rate_with_nds": 6000, "rate_without_nds": 5000, "state": 1 }, "participants_count": 2, "response_prohibited": false, "server_date": "2023-04-24T11:36:51.9306908Z", "start_date": "2023-04-24T11:30:51.93054Z", "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:51.9305506Z", "winner_criterion": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionOfTakerWinner" } }, "text/plain": { "examples": { "response": { "value": { "active_deal_id": "38bd5f61-d3e4-432f-be4c-6bcf0a5b7045", "auction_id": "fd831353-d13d-43a1-91d3-6ad06c84a8db", "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "docs_expired_date": "2023-04-24T14:36:51.9305482Z", "end_date": "2023-04-24T11:36:51.93054Z", "finished": true, "is_docs_expired": false, "load_id": "f0f98614-3fa3-4a6f-87ed-953b0f500eeb", "our_rate": { "added_at": "2023-04-24T11:35:51.9305428Z", "auction_rate_id": "242bc0ad-56d9-49c1-93eb-7e93f53b139e", "contact_id": 1, "loading_date": null, "rate_with_nds": 6000, "rate_without_nds": 5000, "state": 1 }, "participants_count": 2, "response_prohibited": false, "server_date": "2023-04-24T11:36:51.9306908Z", "start_date": "2023-04-24T11:30:51.93054Z", "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:51.9305506Z", "winner_criterion": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionOfTakerWinner" } } }, "description": "Торги (аукцион) для победителя (код 200)" }, "404": { "description": "Торги (аукцион) не найдены" } }, "tags": [ "Auctions" ], "summary": "Получение Торгов (аукциона) по Id" }, "delete": { "parameters": [ { "description": "Id Торгов (аукциона)", "in": "path", "name": "auctionId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "Торги (аукцион) отменены" }, "403": { "description": "У Торгов (аукциона) имеются активные сделки" }, "404": { "description": "Торги (аукцион) не найдены" } }, "tags": [ "Auctions" ], "summary": "Отмена Торгов (аукциона) по Id" } }, "/v1.2/auction/byids": { "post": { "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": [ { "accept_second_pay_type": true, "active_deal_id": "11fd8b8d-1a68-4e02-a9ec-6af5b90d89a8", "auction_id": "a93234db-3ba6-44fc-b946-06c08c8f58f7", "auction_rates": [ { "added_at": "2023-04-24T11:31:51.9996831Z", "ati_id": "12345", "auction_rate_id": "1f8b6617-c717-47ec-8deb-2fef504e5a2f", "contact_id": 0, "loading_date": null, "rate_with_nds": 5500, "rate_without_nds": 6600, "source": 0, "state": 0 }, { "added_at": "2023-04-24T11:32:51.9996963Z", "ati_id": "33345", "auction_rate_id": "cac6be64-8b82-43fd-9a87-8208913f894b", "contact_id": 0, "loading_date": null, "rate_with_nds": 5000, "rate_without_nds": 6000, "source": 0, "state": 1 } ], "auction_restart_parameters": { "auction_finish_action": 1, "current_change_winner_count": 2, "current_restart_count": 1, "duration_after_restart": 30, "init_change_winner_count": 2, "init_restart_count": 1, "is_manually_restarted": false, "rate_increase": null, "rate_increase_option": null }, "auto_renew": true, "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "deleted": false, "docs_expired_date": "2023-04-24T14:36:51.9997183Z", "duration": 6, "end_date": "2023-04-24T11:36:51.9997338Z", "end_date_boundary": "2023-04-24T11:36:51.999732Z", "finish_type": 0, "finished": true, "is_docs_expired": false, "load_id": "62cec59c-fd1b-4545-95b7-08f1bb95e368", "max_rate": 6000, "max_renew_time": 60, "nds": 20, "participants_count": 2, "raise_bid": true, "raise_bid_interval": 30, "renew_time": 20, "response_in_minutes": 0, "response_prohibited": false, "server_date": "2023-04-24T11:36:52.0002292Z", "start_date": "2023-04-24T11:30:51.9997166Z", "start_since_first_bet": false, "state": 0, "step": 500, "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:51.9997291Z", "winner_criterion": 0 }, { "auction_id": "48866a07-b1b9-4f4e-8980-19118ed25c10", "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "end_date": "2023-04-24T11:36:51.9997534Z", "finished": false, "is_our_rate_best": true, "load_id": "ef34b355-62ae-428a-83b1-8bf5809209a2", "next_rate_with_nds": 5500, "next_rate_without_nds": 6600, "our_rate": { "added_at": "2023-04-24T11:35:51.9997573Z", "auction_rate_id": "981ccdef-5f13-4599-b994-76a1991255db", "contact_id": 1, "loading_date": null, "rate_with_nds": 4500, "rate_without_nds": 5400, "state": 0 }, "participants_count": 2, "response_prohibited": false, "server_date": "2023-04-24T11:36:52.0003727Z", "start_date": "2023-04-24T11:30:51.9997516Z", "winner_criterion": 0 }, { "active_deal_id": "143a9e3b-368b-4fca-9d12-1c035d45d074", "auction_id": "1acfb6a9-81bd-4abe-afb5-a1fe3be17653", "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "docs_expired_date": "2023-04-24T14:36:51.9997965Z", "end_date": "2023-04-24T11:36:51.9997816Z", "finished": true, "is_docs_expired": false, "load_id": "97c210ee-8431-4a64-93c6-4eeb2d95be7d", "our_rate": { "added_at": "2023-04-24T11:35:51.9997838Z", "auction_rate_id": "4567c7d0-83f4-49c5-9779-89473f976d0f", "contact_id": 1, "loading_date": null, "rate_with_nds": 6000, "rate_without_nds": 5000, "state": 1 }, "participants_count": 2, "response_prohibited": false, "server_date": "2023-04-24T11:36:52.0004775Z", "start_date": "2023-04-24T11:30:51.9997795Z", "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:51.9997995Z", "winner_criterion": 0 } ] } }, "schema": { "items": { "$ref": "#/components/schemas/AuctionOfLoadOwner" }, "type": "array" } }, "text/json": { "examples": { "response": { "value": [ { "accept_second_pay_type": true, "active_deal_id": "11fd8b8d-1a68-4e02-a9ec-6af5b90d89a8", "auction_id": "a93234db-3ba6-44fc-b946-06c08c8f58f7", "auction_rates": [ { "added_at": "2023-04-24T11:31:51.9996831Z", "ati_id": "12345", "auction_rate_id": "1f8b6617-c717-47ec-8deb-2fef504e5a2f", "contact_id": 0, "loading_date": null, "rate_with_nds": 5500, "rate_without_nds": 6600, "source": 0, "state": 0 }, { "added_at": "2023-04-24T11:32:51.9996963Z", "ati_id": "33345", "auction_rate_id": "cac6be64-8b82-43fd-9a87-8208913f894b", "contact_id": 0, "loading_date": null, "rate_with_nds": 5000, "rate_without_nds": 6000, "source": 0, "state": 1 } ], "auction_restart_parameters": { "auction_finish_action": 1, "current_change_winner_count": 2, "current_restart_count": 1, "duration_after_restart": 30, "init_change_winner_count": 2, "init_restart_count": 1, "is_manually_restarted": false, "rate_increase": null, "rate_increase_option": null }, "auto_renew": true, "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "deleted": false, "docs_expired_date": "2023-04-24T14:36:51.9997183Z", "duration": 6, "end_date": "2023-04-24T11:36:51.9997338Z", "end_date_boundary": "2023-04-24T11:36:51.999732Z", "finish_type": 0, "finished": true, "is_docs_expired": false, "load_id": "62cec59c-fd1b-4545-95b7-08f1bb95e368", "max_rate": 6000, "max_renew_time": 60, "nds": 20, "participants_count": 2, "raise_bid": true, "raise_bid_interval": 30, "renew_time": 20, "response_in_minutes": 0, "response_prohibited": false, "server_date": "2023-04-24T11:36:52.0002292Z", "start_date": "2023-04-24T11:30:51.9997166Z", "start_since_first_bet": false, "state": 0, "step": 500, "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:51.9997291Z", "winner_criterion": 0 }, { "auction_id": "48866a07-b1b9-4f4e-8980-19118ed25c10", "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "end_date": "2023-04-24T11:36:51.9997534Z", "finished": false, "is_our_rate_best": true, "load_id": "ef34b355-62ae-428a-83b1-8bf5809209a2", "next_rate_with_nds": 5500, "next_rate_without_nds": 6600, "our_rate": { "added_at": "2023-04-24T11:35:51.9997573Z", "auction_rate_id": "981ccdef-5f13-4599-b994-76a1991255db", "contact_id": 1, "loading_date": null, "rate_with_nds": 4500, "rate_without_nds": 5400, "state": 0 }, "participants_count": 2, "response_prohibited": false, "server_date": "2023-04-24T11:36:52.0003727Z", "start_date": "2023-04-24T11:30:51.9997516Z", "winner_criterion": 0 }, { "active_deal_id": "143a9e3b-368b-4fca-9d12-1c035d45d074", "auction_id": "1acfb6a9-81bd-4abe-afb5-a1fe3be17653", "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "docs_expired_date": "2023-04-24T14:36:51.9997965Z", "end_date": "2023-04-24T11:36:51.9997816Z", "finished": true, "is_docs_expired": false, "load_id": "97c210ee-8431-4a64-93c6-4eeb2d95be7d", "our_rate": { "added_at": "2023-04-24T11:35:51.9997838Z", "auction_rate_id": "4567c7d0-83f4-49c5-9779-89473f976d0f", "contact_id": 1, "loading_date": null, "rate_with_nds": 6000, "rate_without_nds": 5000, "state": 1 }, "participants_count": 2, "response_prohibited": false, "server_date": "2023-04-24T11:36:52.0004775Z", "start_date": "2023-04-24T11:30:51.9997795Z", "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:51.9997995Z", "winner_criterion": 0 } ] } }, "schema": { "items": { "$ref": "#/components/schemas/AuctionOfLoadOwner" }, "type": "array" } }, "text/plain": { "examples": { "response": { "value": [ { "accept_second_pay_type": true, "active_deal_id": "11fd8b8d-1a68-4e02-a9ec-6af5b90d89a8", "auction_id": "a93234db-3ba6-44fc-b946-06c08c8f58f7", "auction_rates": [ { "added_at": "2023-04-24T11:31:51.9996831Z", "ati_id": "12345", "auction_rate_id": "1f8b6617-c717-47ec-8deb-2fef504e5a2f", "contact_id": 0, "loading_date": null, "rate_with_nds": 5500, "rate_without_nds": 6600, "source": 0, "state": 0 }, { "added_at": "2023-04-24T11:32:51.9996963Z", "ati_id": "33345", "auction_rate_id": "cac6be64-8b82-43fd-9a87-8208913f894b", "contact_id": 0, "loading_date": null, "rate_with_nds": 5000, "rate_without_nds": 6000, "source": 0, "state": 1 } ], "auction_restart_parameters": { "auction_finish_action": 1, "current_change_winner_count": 2, "current_restart_count": 1, "duration_after_restart": 30, "init_change_winner_count": 2, "init_restart_count": 1, "is_manually_restarted": false, "rate_increase": null, "rate_increase_option": null }, "auto_renew": true, "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "deleted": false, "docs_expired_date": "2023-04-24T14:36:51.9997183Z", "duration": 6, "end_date": "2023-04-24T11:36:51.9997338Z", "end_date_boundary": "2023-04-24T11:36:51.999732Z", "finish_type": 0, "finished": true, "is_docs_expired": false, "load_id": "62cec59c-fd1b-4545-95b7-08f1bb95e368", "max_rate": 6000, "max_renew_time": 60, "nds": 20, "participants_count": 2, "raise_bid": true, "raise_bid_interval": 30, "renew_time": 20, "response_in_minutes": 0, "response_prohibited": false, "server_date": "2023-04-24T11:36:52.0002292Z", "start_date": "2023-04-24T11:30:51.9997166Z", "start_since_first_bet": false, "state": 0, "step": 500, "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:51.9997291Z", "winner_criterion": 0 }, { "auction_id": "48866a07-b1b9-4f4e-8980-19118ed25c10", "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "end_date": "2023-04-24T11:36:51.9997534Z", "finished": false, "is_our_rate_best": true, "load_id": "ef34b355-62ae-428a-83b1-8bf5809209a2", "next_rate_with_nds": 5500, "next_rate_without_nds": 6600, "our_rate": { "added_at": "2023-04-24T11:35:51.9997573Z", "auction_rate_id": "981ccdef-5f13-4599-b994-76a1991255db", "contact_id": 1, "loading_date": null, "rate_with_nds": 4500, "rate_without_nds": 5400, "state": 0 }, "participants_count": 2, "response_prohibited": false, "server_date": "2023-04-24T11:36:52.0003727Z", "start_date": "2023-04-24T11:30:51.9997516Z", "winner_criterion": 0 }, { "active_deal_id": "143a9e3b-368b-4fca-9d12-1c035d45d074", "auction_id": "1acfb6a9-81bd-4abe-afb5-a1fe3be17653", "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "docs_expired_date": "2023-04-24T14:36:51.9997965Z", "end_date": "2023-04-24T11:36:51.9997816Z", "finished": true, "is_docs_expired": false, "load_id": "97c210ee-8431-4a64-93c6-4eeb2d95be7d", "our_rate": { "added_at": "2023-04-24T11:35:51.9997838Z", "auction_rate_id": "4567c7d0-83f4-49c5-9779-89473f976d0f", "contact_id": 1, "loading_date": null, "rate_with_nds": 6000, "rate_without_nds": 5000, "state": 1 }, "participants_count": 2, "response_prohibited": false, "server_date": "2023-04-24T11:36:52.0004775Z", "start_date": "2023-04-24T11:30:51.9997795Z", "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:51.9997995Z", "winner_criterion": 0 } ] } }, "schema": { "items": { "$ref": "#/components/schemas/AuctionOfLoadOwner" }, "type": "array" } } }, "description": "Торги (аукционы) грузовладельца, участника, победителя" } }, "tags": [ "Auctions" ], "requestBody": { "content": { "application/*+json": { "schema": { "description": "Массив Id Торгов (аукционов)", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "application/json": { "schema": { "description": "Массив Id Торгов (аукционов)", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "application/json-patch+json": { "schema": { "description": "Массив Id Торгов (аукционов)", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "text/json": { "schema": { "description": "Массив Id Торгов (аукционов)", "items": { "format": "uuid", "type": "string" }, "type": "array" } } }, "description": "Массив Id Торгов (аукционов)" }, "summary": "Получение списка Торгов (аукционов) по массиву id Торгов (аукционов)" } }, "/v1.2/auction/{auctionId}/finish_aot": { "post": { "parameters": [ { "description": "Id Торгов (аукциона)", "in": "path", "name": "auctionId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "accept_second_pay_type": true, "active_deal_id": "aa30b2e3-778b-4125-ae26-75269311542e", "auction_id": "60a21a9c-727e-42b1-b092-cea3b87a0f56", "auction_rates": [ { "added_at": "2023-04-24T11:31:52.100118Z", "ati_id": "12345", "auction_rate_id": "057b35fd-59f8-4e42-a1b0-cf7c0e6e5260", "contact_id": 0, "loading_date": null, "rate_with_nds": 5500, "rate_without_nds": 6600, "source": 0, "state": 0 }, { "added_at": "2023-04-24T11:32:52.1001269Z", "ati_id": "33345", "auction_rate_id": "c057841f-0e55-45b3-b46f-def80b479e29", "contact_id": 0, "loading_date": null, "rate_with_nds": 5000, "rate_without_nds": 6000, "source": 0, "state": 1 } ], "auction_restart_parameters": { "auction_finish_action": 1, "current_change_winner_count": 2, "current_restart_count": 1, "duration_after_restart": 30, "init_change_winner_count": 2, "init_restart_count": 1, "is_manually_restarted": false, "rate_increase": null, "rate_increase_option": null }, "auto_renew": true, "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "deleted": false, "docs_expired_date": "2023-04-24T14:36:52.1001426Z", "duration": 6, "end_date": "2023-04-24T11:36:52.1001554Z", "end_date_boundary": "2023-04-24T11:36:52.1001542Z", "finish_type": 0, "finished": true, "is_docs_expired": false, "load_id": "aa5cfb62-de6d-4c3b-853f-3270fc8793a9", "max_rate": 6000, "max_renew_time": 60, "nds": 20, "participants_count": 2, "raise_bid": true, "raise_bid_interval": 30, "renew_time": 20, "response_in_minutes": 0, "response_prohibited": false, "server_date": "2023-04-24T11:36:52.1004411Z", "start_date": "2023-04-24T11:30:52.1001412Z", "start_since_first_bet": false, "state": 0, "step": 500, "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:52.1001516Z", "winner_criterion": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionOfLoadOwner" } }, "text/json": { "examples": { "response": { "value": { "accept_second_pay_type": true, "active_deal_id": "aa30b2e3-778b-4125-ae26-75269311542e", "auction_id": "60a21a9c-727e-42b1-b092-cea3b87a0f56", "auction_rates": [ { "added_at": "2023-04-24T11:31:52.100118Z", "ati_id": "12345", "auction_rate_id": "057b35fd-59f8-4e42-a1b0-cf7c0e6e5260", "contact_id": 0, "loading_date": null, "rate_with_nds": 5500, "rate_without_nds": 6600, "source": 0, "state": 0 }, { "added_at": "2023-04-24T11:32:52.1001269Z", "ati_id": "33345", "auction_rate_id": "c057841f-0e55-45b3-b46f-def80b479e29", "contact_id": 0, "loading_date": null, "rate_with_nds": 5000, "rate_without_nds": 6000, "source": 0, "state": 1 } ], "auction_restart_parameters": { "auction_finish_action": 1, "current_change_winner_count": 2, "current_restart_count": 1, "duration_after_restart": 30, "init_change_winner_count": 2, "init_restart_count": 1, "is_manually_restarted": false, "rate_increase": null, "rate_increase_option": null }, "auto_renew": true, "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "deleted": false, "docs_expired_date": "2023-04-24T14:36:52.1001426Z", "duration": 6, "end_date": "2023-04-24T11:36:52.1001554Z", "end_date_boundary": "2023-04-24T11:36:52.1001542Z", "finish_type": 0, "finished": true, "is_docs_expired": false, "load_id": "aa5cfb62-de6d-4c3b-853f-3270fc8793a9", "max_rate": 6000, "max_renew_time": 60, "nds": 20, "participants_count": 2, "raise_bid": true, "raise_bid_interval": 30, "renew_time": 20, "response_in_minutes": 0, "response_prohibited": false, "server_date": "2023-04-24T11:36:52.1004411Z", "start_date": "2023-04-24T11:30:52.1001412Z", "start_since_first_bet": false, "state": 0, "step": 500, "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:52.1001516Z", "winner_criterion": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionOfLoadOwner" } }, "text/plain": { "examples": { "response": { "value": { "accept_second_pay_type": true, "active_deal_id": "aa30b2e3-778b-4125-ae26-75269311542e", "auction_id": "60a21a9c-727e-42b1-b092-cea3b87a0f56", "auction_rates": [ { "added_at": "2023-04-24T11:31:52.100118Z", "ati_id": "12345", "auction_rate_id": "057b35fd-59f8-4e42-a1b0-cf7c0e6e5260", "contact_id": 0, "loading_date": null, "rate_with_nds": 5500, "rate_without_nds": 6600, "source": 0, "state": 0 }, { "added_at": "2023-04-24T11:32:52.1001269Z", "ati_id": "33345", "auction_rate_id": "c057841f-0e55-45b3-b46f-def80b479e29", "contact_id": 0, "loading_date": null, "rate_with_nds": 5000, "rate_without_nds": 6000, "source": 0, "state": 1 } ], "auction_restart_parameters": { "auction_finish_action": 1, "current_change_winner_count": 2, "current_restart_count": 1, "duration_after_restart": 30, "init_change_winner_count": 2, "init_restart_count": 1, "is_manually_restarted": false, "rate_increase": null, "rate_increase_option": null }, "auto_renew": true, "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "deleted": false, "docs_expired_date": "2023-04-24T14:36:52.1001426Z", "duration": 6, "end_date": "2023-04-24T11:36:52.1001554Z", "end_date_boundary": "2023-04-24T11:36:52.1001542Z", "finish_type": 0, "finished": true, "is_docs_expired": false, "load_id": "aa5cfb62-de6d-4c3b-853f-3270fc8793a9", "max_rate": 6000, "max_renew_time": 60, "nds": 20, "participants_count": 2, "raise_bid": true, "raise_bid_interval": 30, "renew_time": 20, "response_in_minutes": 0, "response_prohibited": false, "server_date": "2023-04-24T11:36:52.1004411Z", "start_date": "2023-04-24T11:30:52.1001412Z", "start_since_first_bet": false, "state": 0, "step": 500, "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:52.1001516Z", "winner_criterion": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionOfLoadOwner" } } }, "description": "Торги (аукцион) грузовладельца" }, "403": { "description": "Торги (аукцион) уже завершены" }, "410": { "description": "Торги (аукцион) были отменены" } }, "tags": [ "Auctions" ], "summary": "Досрочное завершение Торгов (аукциона)" } }, "/v1.2/auction/bet/win/{auctionRateId}": { "post": { "parameters": [ { "description": "Id ставки Торгов (аукциона) (выбирается одна из ставок со статусами state=[0,-3]) устанавливается победной (со статусом state=1)", "in": "path", "name": "auctionRateId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "accept_second_pay_type": true, "active_deal_id": "c7ba865c-6dd2-43e4-bb29-66df7583989a", "auction_id": "c771ed18-84e4-4ab8-8f91-1be412274d86", "auction_rates": [ { "added_at": "2023-04-24T11:31:52.0690515Z", "ati_id": "12345", "auction_rate_id": "5a2e6b1c-b02a-45b0-9136-f64a9236ab21", "contact_id": 0, "loading_date": null, "rate_with_nds": 5500, "rate_without_nds": 6600, "source": 0, "state": 0 }, { "added_at": "2023-04-24T11:32:52.0690605Z", "ati_id": "33345", "auction_rate_id": "cd342abc-ac8d-4b08-87d3-def8f125b28d", "contact_id": 0, "loading_date": null, "rate_with_nds": 5000, "rate_without_nds": 6000, "source": 0, "state": 1 } ], "auction_restart_parameters": { "auction_finish_action": 1, "current_change_winner_count": 2, "current_restart_count": 1, "duration_after_restart": 30, "init_change_winner_count": 2, "init_restart_count": 1, "is_manually_restarted": false, "rate_increase": null, "rate_increase_option": null }, "auto_renew": true, "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "deleted": false, "docs_expired_date": "2023-04-24T14:36:52.0690757Z", "duration": 6, "end_date": "2023-04-24T11:36:52.0690878Z", "end_date_boundary": "2023-04-24T11:36:52.0690866Z", "finish_type": 0, "finished": true, "is_docs_expired": false, "load_id": "a86db870-967e-4893-b6e1-fef16c73b054", "max_rate": 6000, "max_renew_time": 60, "nds": 20, "participants_count": 2, "raise_bid": true, "raise_bid_interval": 30, "renew_time": 20, "response_in_minutes": 0, "response_prohibited": false, "server_date": "2023-04-24T11:36:52.069361Z", "start_date": "2023-04-24T11:30:52.0690743Z", "start_since_first_bet": false, "state": 0, "step": 500, "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:52.0690844Z", "winner_criterion": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionOfLoadOwner" } }, "text/json": { "examples": { "response": { "value": { "accept_second_pay_type": true, "active_deal_id": "c7ba865c-6dd2-43e4-bb29-66df7583989a", "auction_id": "c771ed18-84e4-4ab8-8f91-1be412274d86", "auction_rates": [ { "added_at": "2023-04-24T11:31:52.0690515Z", "ati_id": "12345", "auction_rate_id": "5a2e6b1c-b02a-45b0-9136-f64a9236ab21", "contact_id": 0, "loading_date": null, "rate_with_nds": 5500, "rate_without_nds": 6600, "source": 0, "state": 0 }, { "added_at": "2023-04-24T11:32:52.0690605Z", "ati_id": "33345", "auction_rate_id": "cd342abc-ac8d-4b08-87d3-def8f125b28d", "contact_id": 0, "loading_date": null, "rate_with_nds": 5000, "rate_without_nds": 6000, "source": 0, "state": 1 } ], "auction_restart_parameters": { "auction_finish_action": 1, "current_change_winner_count": 2, "current_restart_count": 1, "duration_after_restart": 30, "init_change_winner_count": 2, "init_restart_count": 1, "is_manually_restarted": false, "rate_increase": null, "rate_increase_option": null }, "auto_renew": true, "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "deleted": false, "docs_expired_date": "2023-04-24T14:36:52.0690757Z", "duration": 6, "end_date": "2023-04-24T11:36:52.0690878Z", "end_date_boundary": "2023-04-24T11:36:52.0690866Z", "finish_type": 0, "finished": true, "is_docs_expired": false, "load_id": "a86db870-967e-4893-b6e1-fef16c73b054", "max_rate": 6000, "max_renew_time": 60, "nds": 20, "participants_count": 2, "raise_bid": true, "raise_bid_interval": 30, "renew_time": 20, "response_in_minutes": 0, "response_prohibited": false, "server_date": "2023-04-24T11:36:52.069361Z", "start_date": "2023-04-24T11:30:52.0690743Z", "start_since_first_bet": false, "state": 0, "step": 500, "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:52.0690844Z", "winner_criterion": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionOfLoadOwner" } }, "text/plain": { "examples": { "response": { "value": { "accept_second_pay_type": true, "active_deal_id": "c7ba865c-6dd2-43e4-bb29-66df7583989a", "auction_id": "c771ed18-84e4-4ab8-8f91-1be412274d86", "auction_rates": [ { "added_at": "2023-04-24T11:31:52.0690515Z", "ati_id": "12345", "auction_rate_id": "5a2e6b1c-b02a-45b0-9136-f64a9236ab21", "contact_id": 0, "loading_date": null, "rate_with_nds": 5500, "rate_without_nds": 6600, "source": 0, "state": 0 }, { "added_at": "2023-04-24T11:32:52.0690605Z", "ati_id": "33345", "auction_rate_id": "cd342abc-ac8d-4b08-87d3-def8f125b28d", "contact_id": 0, "loading_date": null, "rate_with_nds": 5000, "rate_without_nds": 6000, "source": 0, "state": 1 } ], "auction_restart_parameters": { "auction_finish_action": 1, "current_change_winner_count": 2, "current_restart_count": 1, "duration_after_restart": 30, "init_change_winner_count": 2, "init_restart_count": 1, "is_manually_restarted": false, "rate_increase": null, "rate_increase_option": null }, "auto_renew": true, "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "deleted": false, "docs_expired_date": "2023-04-24T14:36:52.0690757Z", "duration": 6, "end_date": "2023-04-24T11:36:52.0690878Z", "end_date_boundary": "2023-04-24T11:36:52.0690866Z", "finish_type": 0, "finished": true, "is_docs_expired": false, "load_id": "a86db870-967e-4893-b6e1-fef16c73b054", "max_rate": 6000, "max_renew_time": 60, "nds": 20, "participants_count": 2, "raise_bid": true, "raise_bid_interval": 30, "renew_time": 20, "response_in_minutes": 0, "response_prohibited": false, "server_date": "2023-04-24T11:36:52.069361Z", "start_date": "2023-04-24T11:30:52.0690743Z", "start_since_first_bet": false, "state": 0, "step": 500, "time_to_provide_documents": 3, "win_date": "2023-04-24T11:36:52.0690844Z", "winner_criterion": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionOfLoadOwner" } } }, "description": "Торги (аукцион) грузовладельца" }, "403": { "description": "У вас нет доступа на установление победной ставки" }, "404": { "description": "Торги (аукцион) не найдены, либо груз не найден" } }, "tags": [ "Auctions" ], "summary": "Смена победителя Торгов (аукциона)" } }, "/v1.2/auction/bet": { "post": { "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "auction": { "auction_id": "8ef73743-fb35-4bdc-83a9-5904fa517ded", "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "end_date": "2023-04-24T11:36:52.0301243Z", "finished": false, "is_our_rate_best": true, "load_id": "2f86f429-334a-4dae-be3f-624f92870829", "next_rate_with_nds": 5500, "next_rate_without_nds": 6600, "our_rate": { "added_at": "2023-04-24T11:35:52.0301298Z", "auction_rate_id": "d4aa20cc-500b-494d-b67e-77a9fe8826bf", "contact_id": 1, "loading_date": null, "rate_with_nds": 4500, "rate_without_nds": 5400, "state": 0 }, "participants_count": 2, "response_prohibited": false, "server_date": "2023-04-24T11:36:52.0302924Z", "start_date": "2023-04-24T11:30:52.0301216Z", "winner_criterion": 0 }, "auction_end_date": "2023-04-24T11:36:52.0300965Z", "result_status": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionRateStatusOfTaker" } }, "text/json": { "examples": { "response": { "value": { "auction": { "auction_id": "8ef73743-fb35-4bdc-83a9-5904fa517ded", "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "end_date": "2023-04-24T11:36:52.0301243Z", "finished": false, "is_our_rate_best": true, "load_id": "2f86f429-334a-4dae-be3f-624f92870829", "next_rate_with_nds": 5500, "next_rate_without_nds": 6600, "our_rate": { "added_at": "2023-04-24T11:35:52.0301298Z", "auction_rate_id": "d4aa20cc-500b-494d-b67e-77a9fe8826bf", "contact_id": 1, "loading_date": null, "rate_with_nds": 4500, "rate_without_nds": 5400, "state": 0 }, "participants_count": 2, "response_prohibited": false, "server_date": "2023-04-24T11:36:52.0302924Z", "start_date": "2023-04-24T11:30:52.0301216Z", "winner_criterion": 0 }, "auction_end_date": "2023-04-24T11:36:52.0300965Z", "result_status": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionRateStatusOfTaker" } }, "text/plain": { "examples": { "response": { "value": { "auction": { "auction_id": "8ef73743-fb35-4bdc-83a9-5904fa517ded", "currency": 1, "current_rate_with_nds": 5000, "current_rate_without_nds": 6000, "end_date": "2023-04-24T11:36:52.0301243Z", "finished": false, "is_our_rate_best": true, "load_id": "2f86f429-334a-4dae-be3f-624f92870829", "next_rate_with_nds": 5500, "next_rate_without_nds": 6600, "our_rate": { "added_at": "2023-04-24T11:35:52.0301298Z", "auction_rate_id": "d4aa20cc-500b-494d-b67e-77a9fe8826bf", "contact_id": 1, "loading_date": null, "rate_with_nds": 4500, "rate_without_nds": 5400, "state": 0 }, "participants_count": 2, "response_prohibited": false, "server_date": "2023-04-24T11:36:52.0302924Z", "start_date": "2023-04-24T11:30:52.0301216Z", "winner_criterion": 0 }, "auction_end_date": "2023-04-24T11:36:52.0300965Z", "result_status": 0 } } }, "schema": { "$ref": "#/components/schemas/AuctionRateStatusOfTaker" } } }, "description": "Статус ставки" }, "403": { "description": "У вас нет доступа на сохранение ставки" }, "404": { "description": "Торги (аукцион) не найдены" } }, "tags": [ "Auctions" ], "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/AuctionRateOfTakerDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AuctionRateOfTakerDto" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/AuctionRateOfTakerDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AuctionRateOfTakerDto" } } }, "description": "Объект ставки Торгов (аукциона)" }, "summary": "Выставление ставки в Торгах (аукционе)" } }, "/v1.2/auction/bet/refuse/{auctionRateId}": { "post": { "parameters": [ { "description": "Id ставки Торгов (аукциона)", "in": "path", "name": "auctionRateId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": 0 } }, "schema": { "$ref": "#/components/schemas/AuctionRateRefusingResult" } }, "text/json": { "examples": { "response": { "value": 0 } }, "schema": { "$ref": "#/components/schemas/AuctionRateRefusingResult" } }, "text/plain": { "examples": { "response": { "value": 0 } }, "schema": { "$ref": "#/components/schemas/AuctionRateRefusingResult" } } }, "description": "Результат отмены ставки:\r\n \r\n * `0` - Ставка удалена;\r\n * `5` - Ставка удалена, уже есть другие ставки;\r\n * Остальные зарезервированы" }, "403": { "description": "Время вышло, ставку по Торгам (аукциону) отменить нельзя" }, "404": { "description": "Ставка не найдена" } }, "tags": [ "Auctions" ], "summary": "Отмена ставки в Торгах (аукционе)" } }, "/v1.2/auction/{auctionId}/refuse": { "post": { "parameters": [ { "description": "Id Торгов (аукциона)", "in": "path", "name": "auctionId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "Успешное выполнение" }, "403": { "description": "Торги (аукцион) не завершены, либо вы не являетесь победителем Торгов (аукциона)" }, "404": { "description": "Торги (аукцион) не найдены" } }, "tags": [ "Auctions" ], "summary": "Отказ от победы в Торгах (аукционе)" } }, "/v1.0/balance": { "get": { "tags": [ "VirtualAccounts" ], "summary": "Получает текущий баланс контакта.", "operationId": "get_v1.0_billing_virtual-accounts_balance", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "number", "format": "double" } } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "402": { "description": "Метод доступен только платным пользователям.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": "payment_required", "reason": "Метод доступен только платным пользователям." } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "504": { "description": "Сервер не ответил во время.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" }, "example": { "error": "timeout", "reason": "Сервер не ответил во время." } } } } } } }, "/v2/boards/public/boards/create": { "post": { "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/IntegratorBoardDigestView" } } }, "description": "Данные о площадке", "x-nullable": false }, "400": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SingleErrorModel" } } }, "description": "Ошибка валидации или другая", "x-nullable": false } }, "tags": [ "Площадки" ], "operationId": "BoardsForIntegrator_Create", "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/IntegratorBoardCreateDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntegratorBoardCreateDto" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/IntegratorBoardCreateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegratorBoardCreateDto" } } }, "description": "Параметры площадки" }, "summary": "Создать площадку" } }, "/v2/boards/public/boards/{id}": { "get": { "parameters": [ { "description": "ID площадки", "example": "507f1f77bcf86cd799439011", "in": "path", "name": "id", "required": true, "schema": { "type": "string" }, "x-nullable": false } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/IntegratorBoardDigestView" } } }, "description": "Данные о площадке", "x-nullable": false }, "400": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SingleErrorModel" } } }, "description": "Ошибка валидации или другая", "x-nullable": false } }, "tags": [ "Площадки" ], "operationId": "BoardsForIntegrator_GetBoardInfo", "summary": "Загрузить информацию по площадке" } }, "/v2/boards/public/boards/list": { "get": { "responses": { "200": { "content": { "*/*": { "schema": { "items": { "$ref": "#/components/schemas/ExtendedIntegratorBoardDigestView" }, "type": "array" } } }, "description": "Список площадок с их данными", "x-nullable": false } }, "tags": [ "Площадки" ], "operationId": "BoardsForIntegrator_GetUserBoards", "summary": "Список площадок, на которые пользователь может добавлять грузы или машины" } }, "/v2/boards/public/boards/canAdd": { "get": { "responses": { "200": { "content": { "*/*": { "schema": { "items": { "$ref": "#/components/schemas/IntegratorBoardDigestView" }, "type": "array" } } }, "description": "Список площадок с их данными", "x-nullable": false } }, "tags": [ "Площадки" ], "operationId": "BoardsForIntegrator_GetUserCanAdd", "summary": "Список площадок, на которые пользователь может добавлять грузы или машины" } }, "/v2/boards/public/boards/canView": { "get": { "responses": { "200": { "content": { "*/*": { "schema": { "items": { "$ref": "#/components/schemas/IntegratorBoardDigestView" }, "type": "array" } } }, "description": "Список площадок с их данными", "x-nullable": false } }, "tags": [ "Площадки" ], "operationId": "BoardsForIntegrator_GetUserCanView", "summary": "Получает список площадок, на которых участник может видеть грузы/машины" } }, "/v2/boards/public/boards/my": { "get": { "responses": { "200": { "content": { "*/*": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "Список ID площадок", "x-nullable": false } }, "tags": [ "Площадки" ], "operationId": "BoardsForIntegrator_GetMyBoards", "summary": "Получает список ID площадок, принадлежащих участнику АТИ." } }, "/v2/boards/public/boards/participating": { "get": { "responses": { "200": { "content": { "*/*": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "Список ID площадок", "x-nullable": false } }, "tags": [ "Площадки" ], "operationId": "BoardsForIntegrator_GetParticipatingBoards", "summary": "Получает список ID площадок, на которых состоит участник АТИ." } }, "/v2/boards/public/participants/invite": { "post": { "responses": { "200": { "content": { "*/*": { "schema": { "type": "string" } } }, "description": "ID приглашения", "x-nullable": false }, "400": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SingleErrorModel" } } }, "description": "Ошибка валидации", "x-nullable": false } }, "tags": [ "Участники" ], "operationId": "ParticipantsForIntegrator_InviteToBoard", "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/IntegratorInviteFirmDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntegratorInviteFirmDto" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/IntegratorInviteFirmDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegratorInviteFirmDto" } } }, "description": "Параметры приглашения" }, "summary": "Пригласить участника АТИ на площадку" } }, "/v2/boards/public/participants/invite/my": { "get": { "responses": { "200": { "content": { "*/*": { "schema": { "items": { "$ref": "#/components/schemas/IntegratorInviteView" }, "type": "array" } } }, "description": "Список приглашений", "x-nullable": false }, "400": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ExceptionResult" } } }, "description": "Ошибка валидации или другая", "x-nullable": false } }, "tags": [ "Участники" ], "operationId": "ParticipantsForIntegrator_Get", "summary": "Получает список приглашений" } }, "/v2/boards/public/participants/list": { "post": { "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/IntegratorSearchResultsViewOfIntegratorParticipantDigestView" } } }, "description": "Список участий", "x-nullable": false }, "400": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SingleErrorModel" } } }, "description": "Ошибка валидации или другая", "x-nullable": false } }, "tags": [ "Участники" ], "operationId": "ParticipantsForIntegrator_GetBoardParticipants", "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/IntegratorParticipantsListDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntegratorParticipantsListDto" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/IntegratorParticipantsListDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegratorParticipantsListDto" } } }, "description": "Критерии для получения списка участников" }, "summary": "Получить список участников площадки" } }, "/v2/boards/public/participants/modify": { "post": { "responses": { "200": { "content": { "*/*": { "schema": { "type": "boolean" } } }, "description": "успешно/не успешно", "x-nullable": false }, "400": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/SingleErrorModel" } } }, "description": "Ошибка валидации или другая", "x-nullable": false } }, "tags": [ "Участники" ], "description": "Для любой смены участия, в том числе для принятия приглашения (смена Type с \"Invited\" на \"User\")\nНе от всякого типа можно перейти к другому.\nНапример, удалённого пользователя участником не сделать, а участника площадки нельзя сделать обратно\nприглашённым.\nНе все поля можно поменять, например, права участия может менять только владелец площадки,\nа не участник. ( `ViewParticipants`, `ViewContent`, `CanAdd` ).", "operationId": "ParticipantsForIntegrator_ModifyParticipant", "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/IntegratorParticipantModifyDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntegratorParticipantModifyDto" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/IntegratorParticipantModifyDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegratorParticipantModifyDto" } } }, "description": "Запрос с изменениями" }, "summary": "Поменять параметры участника площадки" } }, "/v1.2/catalogs/trucks": { "get": { "tags": [ "Автопарк" ], "summary": "Получение транспортных средств пользователя", "operationId": "Trucks_GetTrucks", "responses": { "200": { "description": "Список транспортных средств", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TruckView4" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "post": { "tags": [ "Автопарк" ], "summary": "Создание транспортного средства", "operationId": "Trucks_CreateTruck", "requestBody": { "x-name": "dto", "description": "Информация о транспортном средстве", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckDto2" } } }, "x-position": 1 }, "responses": { "200": { "description": "Созданное транспортное средство", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckView4" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/gw/oauth2/catalogs/v1.2/trucks": { "get": { "tags": [ "Автопарк" ], "summary": "Получение транспортных средств пользователя", "operationId": "Trucks_GetTrucks2", "responses": { "200": { "description": "Список транспортных средств", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TruckView4" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "post": { "tags": [ "Автопарк" ], "summary": "Создание транспортного средства", "operationId": "Trucks_CreateTruck2", "requestBody": { "x-name": "dto", "description": "Информация о транспортном средстве", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckDto2" } } }, "x-position": 1 }, "responses": { "200": { "description": "Созданное транспортное средство", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckView4" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/v1.2/catalogs/trucks/{truckId}": { "get": { "tags": [ "Автопарк" ], "summary": "Получение транспортного средства пользователя", "operationId": "Trucks_GetTruck", "parameters": [ { "name": "truckId", "in": "path", "required": true, "description": "Id транспотрного средства", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "responses": { "200": { "description": "Транспортное средство", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckView4" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "put": { "tags": [ "Автопарк" ], "summary": "Редактирование транспортного средства", "operationId": "Trucks_UpdateTruck", "parameters": [ { "name": "truckId", "in": "path", "required": true, "description": "Id транспортного средства", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "requestBody": { "x-name": "dto", "description": "Данные транспортного средства", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckDto2" } } }, "x-position": 2 }, "responses": { "200": { "description": "Отредактированное транспортное средство", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckView4" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "delete": { "tags": [ "Автопарк" ], "summary": "Удаление транспортного средства", "operationId": "Trucks_DeleteTruck", "parameters": [ { "name": "truckId", "in": "path", "required": true, "description": "Id транспортного средства", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "responses": { "200": { "description": "Успешное удаление транспортного средства", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/gw/oauth2/catalogs/v1.2/trucks/{truckId}": { "get": { "tags": [ "Автопарк" ], "summary": "Получение транспортного средства пользователя", "operationId": "Trucks_GetTruck2", "parameters": [ { "name": "truckId", "in": "path", "required": true, "description": "Id транспотрного средства", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "responses": { "200": { "description": "Транспортное средство", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckView4" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "put": { "tags": [ "Автопарк" ], "summary": "Редактирование транспортного средства", "operationId": "Trucks_UpdateTruck2", "parameters": [ { "name": "truckId", "in": "path", "required": true, "description": "Id транспортного средства", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "requestBody": { "x-name": "dto", "description": "Данные транспортного средства", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckDto2" } } }, "x-position": 2 }, "responses": { "200": { "description": "Отредактированное транспортное средство", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckView4" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "delete": { "tags": [ "Автопарк" ], "summary": "Удаление транспортного средства", "operationId": "Trucks_DeleteTruck2", "parameters": [ { "name": "truckId", "in": "path", "required": true, "description": "Id транспортного средства", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "responses": { "200": { "description": "Успешное удаление транспортного средства", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/v1.2/catalogs/drivers": { "get": { "tags": [ "Водители" ], "summary": "Получение водителей пользователя", "operationId": "Drivers_GetDrivers", "parameters": [ { "name": "cargoOwnerAtiId", "in": "query", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "Список водителей", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DriverView4" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "post": { "tags": [ "Водители" ], "summary": "Создание водителя", "operationId": "Drivers_CreateDriver", "requestBody": { "x-name": "dto", "description": "Данные водителя", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverDto2" } } }, "x-position": 1 }, "responses": { "200": { "description": "Созданный водитель", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverView4" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/gw/oauth2/catalogs/v1.2/drivers": { "get": { "tags": [ "Водители" ], "summary": "Получение водителей пользователя", "operationId": "Drivers_GetDrivers2", "parameters": [ { "name": "cargoOwnerAtiId", "in": "query", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "Список водителей", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DriverView4" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "post": { "tags": [ "Водители" ], "summary": "Создание водителя", "operationId": "Drivers_CreateDriver2", "requestBody": { "x-name": "dto", "description": "Данные водителя", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverDto2" } } }, "x-position": 1 }, "responses": { "200": { "description": "Созданный водитель", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverView4" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/v1.2/catalogs/drivers/{driverId}": { "get": { "tags": [ "Водители" ], "summary": "Получение водителя пользователя", "operationId": "Drivers_GetDriver", "parameters": [ { "name": "driverId", "in": "path", "required": true, "description": "Id водителя", "schema": { "type": "string", "format": "guid" }, "x-position": 1 }, { "name": "cargoOwnerAtiId", "in": "query", "description": "Код АТИ фирмы-грузовладельца, для проверки Черного списка", "schema": { "type": "string" }, "x-position": 2 } ], "responses": { "200": { "description": "Водитель", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverView4" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "put": { "tags": [ "Водители" ], "summary": "Редактирование водителя", "operationId": "Drivers_UpdateDriver", "parameters": [ { "name": "driverId", "in": "path", "required": true, "description": "Id водителя", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "requestBody": { "x-name": "dto", "description": "Данные водителя", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverDto2" } } }, "x-position": 2 }, "responses": { "200": { "description": "Отредактированный водитель", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverView4" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "delete": { "tags": [ "Водители" ], "summary": "Удаление водителя", "operationId": "Drivers_DeleteDriver", "parameters": [ { "name": "driverId", "in": "path", "required": true, "description": "Id водителя", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "responses": { "200": { "description": "Успешное удаление водителя, в ответе Id удалённого водителя", "content": { "application/json": { "schema": { "type": "string", "format": "guid" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/gw/oauth2/catalogs/v1.2/drivers/{driverId}": { "get": { "tags": [ "Водители" ], "summary": "Получение водителя пользователя", "operationId": "Drivers_GetDriver2", "parameters": [ { "name": "driverId", "in": "path", "required": true, "description": "Id водителя", "schema": { "type": "string", "format": "guid" }, "x-position": 1 }, { "name": "cargoOwnerAtiId", "in": "query", "description": "Код АТИ фирмы-грузовладельца, для проверки Черного списка", "schema": { "type": "string" }, "x-position": 2 } ], "responses": { "200": { "description": "Водитель", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverView4" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "put": { "tags": [ "Водители" ], "summary": "Редактирование водителя", "operationId": "Drivers_UpdateDriver2", "parameters": [ { "name": "driverId", "in": "path", "required": true, "description": "Id водителя", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "requestBody": { "x-name": "dto", "description": "Данные водителя", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverDto2" } } }, "x-position": 2 }, "responses": { "200": { "description": "Отредактированный водитель", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriverView4" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "delete": { "tags": [ "Водители" ], "summary": "Удаление водителя", "operationId": "Drivers_DeleteDriver2", "parameters": [ { "name": "driverId", "in": "path", "required": true, "description": "Id водителя", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "responses": { "200": { "description": "Успешное удаление водителя, в ответе Id удалённого водителя", "content": { "application/json": { "schema": { "type": "string", "format": "guid" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/v1.2/catalogs/relations": { "post": { "tags": [ "Связи" ], "summary": "Создание связей", "description": "Старые связи разрываются. Возможно передавать Id одной сущности для отвязывания её.", "operationId": "Relations_Create", "requestBody": { "x-name": "dto", "description": "Информация о связях", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriversTrucksRelationDto" } } }, "x-position": 1 }, "responses": { "200": { "description": "Успешное создание", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/gw/oauth2/catalogs/v1.2/relations": { "post": { "tags": [ "Связи" ], "summary": "Создание связей", "description": "Старые связи разрываются. Возможно передавать Id одной сущности для отвязывания её.", "operationId": "Relations_Create2", "requestBody": { "x-name": "dto", "description": "Информация о связях", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DriversTrucksRelationDto" } } }, "x-position": 1 }, "responses": { "200": { "description": "Успешное создание", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/scrolls/v1/firms": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/FirmListElementPublicFirmListPublicShort" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Client Error" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" } }, "tags": [ "FirmLists" ], "summary": "Метод получения списков фирмы" }, "post": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmListElementPublicFirmListPublicShort" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Client Error" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" } }, "tags": [ "FirmLists" ], "requestBody": { "$ref": "#/components/requestBodies/FirmListElementPublicFirmListPublic" }, "summary": "Метод добавления списка фирм" }, "put": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmListElementPublicFirmListPublicShort" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Client Error" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" } }, "tags": [ "FirmLists" ], "requestBody": { "$ref": "#/components/requestBodies/FirmListElementPublicFirmListPublic" }, "summary": "Метод изменения списка фирм" } }, "/scrolls/v1/firms/ids": { "post": { "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/FirmListElementPublicFirmListPublicShort" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Client Error" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" } }, "tags": [ "FirmLists" ], "requestBody": { "content": { "application/*+json": { "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "application/json": { "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "application/json-patch+json": { "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "text/json": { "schema": { "items": { "format": "uuid", "type": "string" }, "type": "array" } } } }, "summary": "Метод получения списков фирмы по идентификаторам списокв" } }, "/scrolls/v1/firms/{listId}": { "delete": { "parameters": [ { "description": "Идентификатор списка", "in": "path", "name": "listId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Client Error" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" } }, "tags": [ "CommonList" ], "summary": "Метод удаляет список заданной фирмы" } }, "/scrolls/v1/firms/elements": { "post": { "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/FirmListElementPublicBatchResultItem" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Client Error" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" } }, "tags": [ "ListElementsBatch" ], "requestBody": { "content": { "application/*+json": { "schema": { "description": "\"Элементы списка", "items": { "$ref": "#/components/schemas/FirmListElementPublicShort" }, "type": "array" } }, "application/json": { "schema": { "description": "\"Элементы списка", "items": { "$ref": "#/components/schemas/FirmListElementPublicShort" }, "type": "array" } }, "application/json-patch+json": { "schema": { "description": "\"Элементы списка", "items": { "$ref": "#/components/schemas/FirmListElementPublicShort" }, "type": "array" } }, "text/json": { "schema": { "description": "\"Элементы списка", "items": { "$ref": "#/components/schemas/FirmListElementPublicShort" }, "type": "array" } } }, "description": "\"Элементы списка" }, "summary": "Метод добавления элементов в список фирм" }, "delete": { "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/GuidBatchResultItem" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Client Error" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" } }, "tags": [ "ListElementsBatch" ], "requestBody": { "$ref": "#/components/requestBodies/Body" }, "summary": "Метод удаления элементов из списков по их идентификаторам" } }, "/v1.0/firms/search/summaries-emails": { "post": { "tags": [ "FirmSummarySearch" ], "summary": "Групповое получение краткой информации о фирмаx по email", "operationId": "post_v1.0_firms_search_summaries-emails", "requestBody": { "description": "Адреса электронной почты", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "description": "Элемент результата поиска фирм по ключу.", "$ref": "#/components/schemas/SummaryWithContactsPublicFirmSummarySearchResultElement" }, "example": [ { "key": "string", "value": [ { "contact_names": [ "string" ], "query_first_change_date": "1970-01-01T00:00:00Z", "ati_id": "string", "full_name": "string", "firm_type": "string", "firm_type_id": "string", "location": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" }, "address": "string", "position_in_city": 0, "position_in_country": 0, "firm_documents": [ { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } ], "web_site": "string", "info_reference": "string", "passport_reference": "string", "city": "string", "score": 0, "bad_partner_mentions_count": 0, "claims_count": 0, "recommendations_count": 0, "inn": "string", "ogrn": "string", "kpp": "string", "okpo": "string", "affiliated_firms": [ { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } ], "negative_points_sum": 0, "tf_firm_color": "string", "tf_account_color": "string", "tf_has_signals": false, "registration_date": "1970-01-01T00:00:00Z", "contact_info_changed": "1970-01-01T00:00:00Z", "last_month_active_days": 0, "verified_trucks": 0 } ] } ] }, "example": [ { "key": "string", "value": [ { "contact_names": [ "string" ], "query_first_change_date": "1970-01-01T00:00:00Z", "ati_id": "string", "full_name": "string", "firm_type": "string", "firm_type_id": "string", "location": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" }, "address": "string", "position_in_city": 0, "position_in_country": 0, "firm_documents": [ { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } ], "web_site": "string", "info_reference": "string", "passport_reference": "string", "city": "string", "score": 0, "bad_partner_mentions_count": 0, "claims_count": 0, "recommendations_count": 0, "inn": "string", "ogrn": "string", "kpp": "string", "okpo": "string", "affiliated_firms": [ { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } ], "negative_points_sum": 0, "tf_firm_color": "string", "tf_account_color": "string", "tf_has_signals": false, "registration_date": "1970-01-01T00:00:00Z", "contact_info_changed": "1970-01-01T00:00:00Z", "last_month_active_days": 0, "verified_trucks": 0 } ] } ] } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "503": { "description": "Произошла ошибка при получении данных", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "external_service_error", "reason": "Произошла ошибка при получении данных" } } } } } } }, "/v1.0/firms/search/summaries": { "post": { "tags": [ "FirmSummarySearch" ], "summary": "Групповое получение краткой информации о фирмаx по ИНН", "operationId": "post_v1.0_firms_search_summaries", "requestBody": { "description": "Список ИНН", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string" } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "description": "Элемент результата поиска фирм по ключу.", "$ref": "#/components/schemas/AffiliatedFirmPublicAccountSummaryPublicFirmSummarySearchResultElement" }, "example": [ { "key": "string", "value": [ { "ati_id": "string", "full_name": "string", "firm_type": "string", "firm_type_id": "string", "location": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" }, "address": "string", "position_in_city": 0, "position_in_country": 0, "firm_documents": [ { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } ], "web_site": "string", "info_reference": "string", "passport_reference": "string", "city": "string", "score": 0, "bad_partner_mentions_count": 0, "claims_count": 0, "recommendations_count": 0, "inn": "string", "ogrn": "string", "kpp": "string", "okpo": "string", "affiliated_firms": [ { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } ], "negative_points_sum": 0, "tf_firm_color": "string", "tf_account_color": "string", "tf_has_signals": false, "registration_date": "1970-01-01T00:00:00Z", "contact_info_changed": "1970-01-01T00:00:00Z", "last_month_active_days": 0, "verified_trucks": 0 } ] } ] }, "example": [ { "key": "string", "value": [ { "ati_id": "string", "full_name": "string", "firm_type": "string", "firm_type_id": "string", "location": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" }, "address": "string", "position_in_city": 0, "position_in_country": 0, "firm_documents": [ { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } ], "web_site": "string", "info_reference": "string", "passport_reference": "string", "city": "string", "score": 0, "bad_partner_mentions_count": 0, "claims_count": 0, "recommendations_count": 0, "inn": "string", "ogrn": "string", "kpp": "string", "okpo": "string", "affiliated_firms": [ { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } ], "negative_points_sum": 0, "tf_firm_color": "string", "tf_account_color": "string", "tf_has_signals": false, "registration_date": "1970-01-01T00:00:00Z", "contact_info_changed": "1970-01-01T00:00:00Z", "last_month_active_days": 0, "verified_trucks": 0 } ] } ] } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "503": { "description": "Произошла ошибка при получении данных", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "external_service_error", "reason": "Произошла ошибка при получении данных" } } } } } } }, "/v1.0/firms/search/summary": { "get": { "tags": [ "FirmSummarySearch" ], "summary": "Получение краткой информации о фирме по номеру телефона или ИНН", "operationId": "get_v1.0_firms_search_summary", "parameters": [ { "name": "phone", "in": "query", "description": "Номер телефона", "schema": { "type": "string" }, "example": "+7-495-000-00-00" }, { "name": "inn", "in": "query", "description": "ИНН", "schema": { "type": "string" }, "example": "7707083893" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "description": "Краткая информация о фирме с данными по контактам.", "$ref": "#/components/schemas/SummaryWithContactsPublic" }, "example": [ { "contact_names": [ "string" ], "query_first_change_date": "1970-01-01T00:00:00Z", "ati_id": "string", "full_name": "string", "firm_type": "string", "firm_type_id": "string", "location": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" }, "address": "string", "position_in_city": 0, "position_in_country": 0, "firm_documents": [ { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } ], "web_site": "string", "info_reference": "string", "passport_reference": "string", "city": "string", "score": 0, "bad_partner_mentions_count": 0, "claims_count": 0, "recommendations_count": 0, "inn": "string", "ogrn": "string", "kpp": "string", "okpo": "string", "affiliated_firms": [ { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } ], "negative_points_sum": 0, "tf_firm_color": "string", "tf_account_color": "string", "tf_has_signals": false, "registration_date": "1970-01-01T00:00:00Z", "contact_info_changed": "1970-01-01T00:00:00Z", "last_month_active_days": 0, "verified_trucks": 0 } ] }, "example": [ { "contact_names": [ "string" ], "query_first_change_date": "1970-01-01T00:00:00Z", "ati_id": "string", "full_name": "string", "firm_type": "string", "firm_type_id": "string", "location": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" }, "address": "string", "position_in_city": 0, "position_in_country": 0, "firm_documents": [ { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } ], "web_site": "string", "info_reference": "string", "passport_reference": "string", "city": "string", "score": 0, "bad_partner_mentions_count": 0, "claims_count": 0, "recommendations_count": 0, "inn": "string", "ogrn": "string", "kpp": "string", "okpo": "string", "affiliated_firms": [ { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } ], "negative_points_sum": 0, "tf_firm_color": "string", "tf_account_color": "string", "tf_has_signals": false, "registration_date": "1970-01-01T00:00:00Z", "contact_info_changed": "1970-01-01T00:00:00Z", "last_month_active_days": 0, "verified_trucks": 0 } ] } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "503": { "description": "Произошла ошибка при получении данных", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "external_service_error", "reason": "Произошла ошибка при получении данных" } } } } } } }, "/scrolls/v1/geo": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/GeoListElementPublicGeoListPublic" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Client Error" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" } }, "tags": [ "GeoLists" ], "summary": "Метод получения списка Гео списков пользователя" }, "post": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoListElementPublicGeoListPublic" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Client Error" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" } }, "tags": [ "GeoLists" ], "requestBody": { "$ref": "#/components/requestBodies/GeoListElementPublicGeoListPublic" }, "summary": "Метод добавления Гео списка" }, "put": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoListElementPublicGeoListPublic" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Client Error" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" } }, "tags": [ "GeoLists" ], "requestBody": { "$ref": "#/components/requestBodies/GeoListElementPublicGeoListPublic" }, "summary": "Метод изменения Гео списка" } }, "/scrolls/v1/geo/{listId}": { "get": { "parameters": [ { "description": "Идентификатор Гео списка", "in": "path", "name": "listId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeoListElementPublicGeoListPublic" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Client Error" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" } }, "tags": [ "GeoLists" ], "summary": "Метод получения Гео списка по идентификатору" }, "delete": { "parameters": [ { "description": "Идентификатор списка", "in": "path", "name": "listId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "responses": { "200": { "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Client Error" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" } }, "tags": [ "CommonList" ], "summary": "Метод удаляет список заданной фирмы" } }, "/scrolls/v1/geo/ids": { "post": { "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/GeoListElementPublicGeoListPublic" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Client Error" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" } }, "tags": [ "GeoLists" ], "requestBody": { "content": { "application/*+json": { "schema": { "description": "Идентификаторы Гео списка", "items": { "format": "uuid", "type": "string" }, "type": "array", "uniqueItems": true } }, "application/json": { "schema": { "description": "Идентификаторы Гео списка", "items": { "format": "uuid", "type": "string" }, "type": "array", "uniqueItems": true } }, "application/json-patch+json": { "schema": { "description": "Идентификаторы Гео списка", "items": { "format": "uuid", "type": "string" }, "type": "array", "uniqueItems": true } }, "text/json": { "schema": { "description": "Идентификаторы Гео списка", "items": { "format": "uuid", "type": "string" }, "type": "array", "uniqueItems": true } } }, "description": "Идентификаторы Гео списка" }, "summary": "Публичный метод получения Гео списков по идентификаторам" } }, "/scrolls/v1/geo/elements": { "post": { "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/GeoListElementPublicBatchResultItem" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Client Error" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" } }, "tags": [ "ListElementsBatch" ], "requestBody": { "content": { "application/*+json": { "schema": { "description": "\"Элементы списка", "items": { "$ref": "#/components/schemas/GeoListElementPublic" }, "type": "array" } }, "application/json": { "schema": { "description": "\"Элементы списка", "items": { "$ref": "#/components/schemas/GeoListElementPublic" }, "type": "array" } }, "application/json-patch+json": { "schema": { "description": "\"Элементы списка", "items": { "$ref": "#/components/schemas/GeoListElementPublic" }, "type": "array" } }, "text/json": { "schema": { "description": "\"Элементы списка", "items": { "$ref": "#/components/schemas/GeoListElementPublic" }, "type": "array" } } }, "description": "\"Элементы списка" }, "summary": "Метод добавления элементов в Гео список" }, "delete": { "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/GuidBatchResultItem" }, "type": "array" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Bad Request" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Unauthorized" }, "402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Client Error" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Forbidden" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Not Found" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" }, "504": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/scrolls__ErrorResponse" } } }, "description": "Server Error" } }, "tags": [ "ListElementsBatch" ], "requestBody": { "$ref": "#/components/requestBodies/Body" }, "summary": "Метод удаления элементов из списков по их идентификаторам" } }, "/v1.2/catalogs/organizations": { "get": { "tags": [ "Организации" ], "summary": "Получение всех доступных организаций пользователя", "description": "Возвращает доступные вызывающему метод контакту организации", "operationId": "Organizations_GetOrganizations", "responses": { "200": { "description": "Организации", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationView" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "post": { "tags": [ "Организации" ], "summary": "Добавление организации", "operationId": "Organizations_CreateOrganization", "requestBody": { "x-name": "dto", "description": "Данные организации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationEditDto" } } }, "x-position": 1 }, "responses": { "200": { "description": "Добавленная организация", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/gw/oauth2/catalogs/v1.2/organizations": { "get": { "tags": [ "Организации" ], "summary": "Получение всех доступных организаций пользователя", "description": "Возвращает доступные вызывающему метод контакту организации", "operationId": "Organizations_GetOrganizations2", "responses": { "200": { "description": "Организации", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationView" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "post": { "tags": [ "Организации" ], "summary": "Добавление организации", "operationId": "Organizations_CreateOrganization2", "requestBody": { "x-name": "dto", "description": "Данные организации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationEditDto" } } }, "x-position": 1 }, "responses": { "200": { "description": "Добавленная организация", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/v1.2/catalogs/organizations/filter": { "post": { "tags": [ "Организации" ], "summary": "Получение организаций пользователя по подразделениям", "description": "Позволяет получить все организации, доступные подразделению, указанному в запросе.\nЕсли организация доступна всем подразделениям, то она всегда будет присутствовать в ответе", "operationId": "Organizations_GetOrganizationsByDepartments", "requestBody": { "x-name": "dto", "description": "Модель для фильтрации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterOrganizationsDto" } } }, "x-position": 1 }, "responses": { "200": { "description": "Организации", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationView" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/gw/oauth2/catalogs/v1.2/organizations/filter": { "post": { "tags": [ "Организации" ], "summary": "Получение организаций пользователя по подразделениям", "description": "Позволяет получить все организации, доступные подразделению, указанному в запросе.\nЕсли организация доступна всем подразделениям, то она всегда будет присутствовать в ответе", "operationId": "Organizations_GetOrganizationsByDepartments2", "requestBody": { "x-name": "dto", "description": "Модель для фильтрации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterOrganizationsDto" } } }, "x-position": 1 }, "responses": { "200": { "description": "Организации", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrganizationView" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/v1.2/catalogs/organizations/{organizationId}": { "get": { "tags": [ "Организации" ], "summary": "Получение организации пользователя по id", "operationId": "Organizations_GetOrganization", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "description": "Id организации", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "responses": { "200": { "description": "Организация", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "put": { "tags": [ "Организации" ], "summary": "Изменение организации", "operationId": "Organizations_UpdateOrganization", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "description": "Id организации", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "requestBody": { "x-name": "dto", "description": "Данные организации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationEditDto" } } }, "x-position": 2 }, "responses": { "200": { "description": "Измененная организация", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "delete": { "tags": [ "Организации" ], "summary": "Удаление организации", "operationId": "Organizations_DeleteOrganization", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "description": "Id организации", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "responses": { "200": { "description": "Успешное удаление организации" }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/gw/oauth2/catalogs/v1.2/organizations/{organizationId}": { "get": { "tags": [ "Организации" ], "summary": "Получение организации пользователя по id", "operationId": "Organizations_GetOrganization2", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "description": "Id организации", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "responses": { "200": { "description": "Организация", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "put": { "tags": [ "Организации" ], "summary": "Изменение организации", "operationId": "Organizations_UpdateOrganization2", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "description": "Id организации", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "requestBody": { "x-name": "dto", "description": "Данные организации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationEditDto" } } }, "x-position": 2 }, "responses": { "200": { "description": "Измененная организация", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "delete": { "tags": [ "Организации" ], "summary": "Удаление организации", "operationId": "Organizations_DeleteOrganization2", "parameters": [ { "name": "organizationId", "in": "path", "required": true, "description": "Id организации", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "responses": { "200": { "description": "Успешное удаление организации" }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/v1.2/catalogs/organizations/addresses": { "get": { "tags": [ "Адреса организаций" ], "summary": "Получение всех адресов пользователя", "operationId": "Addresses_GetAddresses", "responses": { "200": { "description": "Адреса", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddressView" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "post": { "tags": [ "Адреса организаций" ], "summary": "Добавление адреса", "operationId": "Addresses_CreateAddress", "requestBody": { "x-name": "dto", "description": "Модель добавляемого адреса", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressUpsertDto" } } }, "x-position": 1 }, "responses": { "200": { "description": "Добавленный адрес", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/gw/oauth2/catalogs/v1.2/organizations/addresses": { "get": { "tags": [ "Адреса организаций" ], "summary": "Получение всех адресов пользователя", "operationId": "Addresses_GetAddresses2", "responses": { "200": { "description": "Адреса", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AddressView" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "post": { "tags": [ "Адреса организаций" ], "summary": "Добавление адреса", "operationId": "Addresses_CreateAddress2", "requestBody": { "x-name": "dto", "description": "Модель добавляемого адреса", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressUpsertDto" } } }, "x-position": 1 }, "responses": { "200": { "description": "Добавленный адрес", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/v1.2/catalogs/organizations/addresses/{addressId}": { "get": { "tags": [ "Адреса организаций" ], "summary": "Получение адреса пользователя по id", "operationId": "Addresses_GetAddress", "parameters": [ { "name": "addressId", "in": "path", "required": true, "description": "Id адреса", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "responses": { "200": { "description": "Адрес", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "put": { "tags": [ "Адреса организаций" ], "summary": "Изменение адреса", "operationId": "Addresses_UpdateAddress", "parameters": [ { "name": "addressId", "in": "path", "required": true, "description": "Id изменяемого адреса", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "requestBody": { "x-name": "dto", "description": "Модель изменяемого адреса", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressUpsertDto" } } }, "x-position": 2 }, "responses": { "200": { "description": "Измененный адрес", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "delete": { "tags": [ "Адреса организаций" ], "summary": "Удаление адреса", "operationId": "Addresses_DeleteAddress", "parameters": [ { "name": "addressId", "in": "path", "required": true, "description": "Id удаляемого адреса", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "responses": { "200": { "description": "Удаление адреса" }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/gw/oauth2/catalogs/v1.2/organizations/addresses/{addressId}": { "get": { "tags": [ "Адреса организаций" ], "summary": "Получение адреса пользователя по id", "operationId": "Addresses_GetAddress2", "parameters": [ { "name": "addressId", "in": "path", "required": true, "description": "Id адреса", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "responses": { "200": { "description": "Адрес", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "put": { "tags": [ "Адреса организаций" ], "summary": "Изменение адреса", "operationId": "Addresses_UpdateAddress2", "parameters": [ { "name": "addressId", "in": "path", "required": true, "description": "Id изменяемого адреса", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "requestBody": { "x-name": "dto", "description": "Модель изменяемого адреса", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressUpsertDto" } } }, "x-position": 2 }, "responses": { "200": { "description": "Измененный адрес", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "delete": { "tags": [ "Адреса организаций" ], "summary": "Удаление адреса", "operationId": "Addresses_DeleteAddress2", "parameters": [ { "name": "addressId", "in": "path", "required": true, "description": "Id удаляемого адреса", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "responses": { "200": { "description": "Удаление адреса" }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/v1.2/catalogs/organizations/addresses/types": { "get": { "tags": [ "Адреса организаций" ], "summary": "Получение типов адресов", "operationId": "Addresses_GetAddressTypes", "responses": { "200": { "description": "Типы адресов", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RawAddressType" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/gw/oauth2/catalogs/v1.2/organizations/addresses/types": { "get": { "tags": [ "Адреса организаций" ], "summary": "Получение типов адресов", "operationId": "Addresses_GetAddressTypes2", "responses": { "200": { "description": "Типы адресов", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RawAddressType" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/v1.2/catalogs/organizations/contactPersons": { "get": { "tags": [ "Контактные лица организаций" ], "summary": "Получение всех контактных лиц пользователя", "operationId": "ContactPerson_GetContactPersons", "responses": { "200": { "description": "Контактные лица", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPersonView" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "post": { "tags": [ "Контактные лица организаций" ], "summary": "Добавление контактного лица пользователя", "operationId": "ContactPerson_CreateContactPerson", "requestBody": { "x-name": "dto", "description": "Модель контактного лица", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactPersonSaveDto" } } }, "x-position": 1 }, "responses": { "200": { "description": "Добавленное контактное лицо", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactPersonView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/gw/oauth2/catalogs/v1.2/organizations/contactPersons": { "get": { "tags": [ "Контактные лица организаций" ], "summary": "Получение всех контактных лиц пользователя", "operationId": "ContactPerson_GetContactPersons2", "responses": { "200": { "description": "Контактные лица", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPersonView" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "post": { "tags": [ "Контактные лица организаций" ], "summary": "Добавление контактного лица пользователя", "operationId": "ContactPerson_CreateContactPerson2", "requestBody": { "x-name": "dto", "description": "Модель контактного лица", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactPersonSaveDto" } } }, "x-position": 1 }, "responses": { "200": { "description": "Добавленное контактное лицо", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactPersonView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/v1.2/catalogs/organizations/contactPersons/{contactPersonId}": { "get": { "tags": [ "Контактные лица организаций" ], "summary": "Получение контактного лица пользователя по id", "operationId": "ContactPerson_GetContactPerson", "parameters": [ { "name": "contactPersonId", "in": "path", "required": true, "description": "Id контактного лица", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "responses": { "200": { "description": "Контактное лицо", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactPersonView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "put": { "tags": [ "Контактные лица организаций" ], "summary": "Изменение контактного лица пользователя", "operationId": "ContactPerson_UpdateContactPerson", "parameters": [ { "name": "contactPersonId", "in": "path", "required": true, "description": "Id контактного лица", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "requestBody": { "x-name": "dto", "description": "Модель контактного лица", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactPersonSaveDto" } } }, "x-position": 2 }, "responses": { "200": { "description": "Измененное контактное лицо", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactPersonView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "delete": { "tags": [ "Контактные лица организаций" ], "summary": "Удаление контактного лица пользователя", "operationId": "ContactPerson_DeleteContactPerson", "parameters": [ { "name": "contactPersonId", "in": "path", "required": true, "description": "Id контактного лица", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "responses": { "200": { "description": "Удаление контактного лица пользователя" }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/gw/oauth2/catalogs/v1.2/organizations/contactPersons/{contactPersonId}": { "get": { "tags": [ "Контактные лица организаций" ], "summary": "Получение контактного лица пользователя по id", "operationId": "ContactPerson_GetContactPerson2", "parameters": [ { "name": "contactPersonId", "in": "path", "required": true, "description": "Id контактного лица", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "responses": { "200": { "description": "Контактное лицо", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactPersonView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "put": { "tags": [ "Контактные лица организаций" ], "summary": "Изменение контактного лица пользователя", "operationId": "ContactPerson_UpdateContactPerson2", "parameters": [ { "name": "contactPersonId", "in": "path", "required": true, "description": "Id контактного лица", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "requestBody": { "x-name": "dto", "description": "Модель контактного лица", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactPersonSaveDto" } } }, "x-position": 2 }, "responses": { "200": { "description": "Измененное контактное лицо", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactPersonView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] }, "delete": { "tags": [ "Контактные лица организаций" ], "summary": "Удаление контактного лица пользователя", "operationId": "ContactPerson_DeleteContactPerson2", "parameters": [ { "name": "contactPersonId", "in": "path", "required": true, "description": "Id контактного лица", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "responses": { "200": { "description": "Удаление контактного лица пользователя" }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/gw/claims/integration/v1/claims/documents/upload": { "post": { "tags": [ "IntegrationClaims" ], "summary": "Загрузка документа в плюшкин (внешние интеграторы)", "operationId": "post_integration_v1_claims_documents_upload", "requestBody": { "description": "Данные о документе претензии", "content": { "multipart/form-data": { "schema": { "required": [ "ClaimDocTypeId", "File" ], "type": "object", "properties": { "File": { "type": "string", "description": "Прикрепленный файл", "format": "binary", "example": "document.pdf" }, "ClaimDocTypeId": { "maximum": 2147483647, "minimum": 0, "type": "integer", "description": "Тип прикрепленного файла из ClaimDocTypes", "format": "int32", "example": 2 } }, "example": { "File": "document.pdf", "ClaimDocTypeId": 2 } }, "example": { "File": "document.pdf", "ClaimDocTypeId": 2 }, "encoding": { "File": { "style": "form" }, "ClaimDocTypeId": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationClaimDocumentUploadResultDto" }, "example": { "file_key": "string" } } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "402": { "description": "Метод доступен только платным пользователям.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "payment_required", "reason": "Метод доступен только платным пользователям." } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "504": { "description": "Сервер не ответил во время.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "timeout", "reason": "Сервер не ответил во время." } } } } } } }, "/gw/claims/integration/v1/claims/defendants": { "get": { "tags": [ "IntegrationClaims" ], "summary": "Получение имён ответчика из связанных фирм (внешние интеграторы)", "operationId": "get_integration_v1_claims_defendants", "parameters": [ { "name": "atiId", "in": "query", "description": "Код фирмы ответчика в ATI.SU", "schema": { "type": "string" }, "example": "12345" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationClaimDefendantFirmsDto" }, "example": { "defendant_firms": [ { "name": "string", "inn": "string" } ] } } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "402": { "description": "Метод доступен только платным пользователям.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "payment_required", "reason": "Метод доступен только платным пользователям." } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "504": { "description": "Сервер не ответил во время.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "timeout", "reason": "Сервер не ответил во время." } } } } } } }, "/gw/claims/integration/v1/claims/add": { "post": { "tags": [ "IntegrationClaims" ], "summary": "Добавление новой претензии с прикрепленными документами для внешних интеграторов", "operationId": "post_integration_v1_claims_add", "requestBody": { "description": "Данные претензии с документами", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IntegrationClaimAddRequestDto" } ], "description": "Тело запроса на добавление претензии для внешних интеграторов." } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IntegrationClaimAddRequestDto" } ], "description": "Тело запроса на добавление претензии для внешних интеграторов." } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IntegrationClaimAddRequestDto" } ], "description": "Тело запроса на добавление претензии для внешних интеграторов." } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/IntegrationClaimAddRequestDto" } ], "description": "Тело запроса на добавление претензии для внешних интеграторов." } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IntegrationClaimAddResultDto" }, "example": { "id": "00000000-0000-0000-0000-000000000000", "claim_level": 0 } } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "402": { "description": "Метод доступен только платным пользователям.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "payment_required", "reason": "Метод доступен только платным пользователям." } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "504": { "description": "Сервер не ответил во время.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "timeout", "reason": "Сервер не ответил во время." } } } } } } }, "/gw/marshak/v1/cartypes": { "get": { "tags": [ "Словари" ], "summary": "Получение списка кузовов", "parameters": [ { "name": "attributeFieldFormat", "in": "query", "description": "Формат атрибутов в ответе. Для человекочитаемого варианта используйте значение `2` — атрибуты вернутся словарём `ключ: значение`.", "schema": { "type": "integer", "enum": [ 0, 1, 2 ], "default": 2 } }, { "name": "locale", "in": "query", "description": "Локаль ответа, например `ru` или `en`.", "schema": { "type": "string" } }, { "name": "lastUpdate", "in": "query", "description": "Вернуть только элементы, обновлённые после указанной даты.", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Элементы словаря", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DictionaryItemWithAttributeDictionary" } } } } } } } }, "/v1.0/dictionaries/carTypes": { "get": { "tags": [ "Справочники" ], "summary": "Получение справочника типов кузовов.", "description": "API для интеграции. Справочник отдаётся целиком: фильтров и постраничной выдачи нет. Кузов указывается в требованиях к транспорту.", "operationId": "Dictionaries_CarTypes", "responses": { "200": { "description": "Справочник целиком.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarType" } } } } } } } }, "/gw/marshak/v1/cargo_typ": { "get": { "tags": [ "Словари" ], "summary": "Получение наименований грузов", "parameters": [ { "name": "attributeFieldFormat", "in": "query", "description": "Формат атрибутов в ответе. Для человекочитаемого варианта используйте значение `2` — атрибуты вернутся словарём `ключ: значение`.", "schema": { "type": "integer", "enum": [ 0, 1, 2 ], "default": 2 } }, { "name": "locale", "in": "query", "schema": { "type": "string" } }, { "name": "lastUpdate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Элементы словаря", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DictionaryItemWithAttributeDictionary" } } } } } } } }, "/v1.0/dictionaries/cargoTypes": { "get": { "tags": [ "Справочники" ], "summary": "Получение справочника наименований грузов.", "description": "API для интеграции. Справочник отдаётся целиком: фильтров и постраничной выдачи нет. Наименования грузов используются в поле груза, описывающем его содержимое.", "operationId": "Dictionaries_CargoTypes", "responses": { "200": { "description": "Справочник целиком.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CargoType" } } } } } } } }, "/gw/marshak/v1/currency": { "get": { "tags": [ "Словари" ], "summary": "Получение списка валют", "parameters": [ { "name": "attributeFieldFormat", "in": "query", "description": "Формат атрибутов в ответе. Для человекочитаемого варианта используйте значение `2` — атрибуты вернутся словарём `ключ: значение`.", "schema": { "type": "integer", "enum": [ 0, 1, 2 ], "default": 2 } }, { "name": "locale", "in": "query", "schema": { "type": "string" } }, { "name": "lastUpdate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Элементы словаря", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DictionaryItemWithAttributeDictionary" } } } } } } } }, "/v1.0/dictionaries/currencyTypes": { "get": { "tags": [ "Справочники" ], "summary": "Получение справочника валют.", "description": "API для интеграции. Справочник отдаётся целиком: фильтров и постраничной выдачи нет. Валюта указывается в ставке груза.", "operationId": "Dictionaries_CurrencyTypes", "responses": { "200": { "description": "Справочник целиком.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StrippedCurrencyTypeModel" } } } } } } } }, "/gw/marshak/v1/ati_docs_document_types": { "get": { "tags": [ "Словари" ], "summary": "Получение списка типов документов для груза", "parameters": [ { "name": "attributeFieldFormat", "in": "query", "description": "Формат атрибутов в ответе. Для человекочитаемого варианта используйте значение `2` — атрибуты вернутся словарём `ключ: значение`.", "schema": { "type": "integer", "enum": [ 0, 1, 2 ], "default": 2 } }, { "name": "locale", "in": "query", "schema": { "type": "string" } }, { "name": "lastUpdate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Элементы словаря", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DictionaryItemWithAttributeDictionary" } } } } } } } }, "/v1.0/dictionaries/documenttypes": { "get": { "tags": [ "Справочники" ], "summary": "Получение справочника типов документов для груза.", "description": "API для интеграции. Тип документа указывается при работе с документами груза в ATI.Docs.", "operationId": "Dictionaries_DocumentTypes", "responses": { "200": { "description": "Названия типов документов.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "заказ" ] } } } } } }, "/gw/marshak/v1/money_type": { "get": { "tags": [ "Словари" ], "summary": "Получение списка вариантов оплаты", "parameters": [ { "name": "attributeFieldFormat", "in": "query", "description": "Формат атрибутов в ответе. Для человекочитаемого варианта используйте значение `2` — атрибуты вернутся словарём `ключ: значение`.", "schema": { "type": "integer", "enum": [ 0, 1, 2 ], "default": 2 } }, { "name": "locale", "in": "query", "schema": { "type": "string" } }, { "name": "lastUpdate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Элементы словаря", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DictionaryItemWithAttributeDictionary" } } } } } } } }, "/v1.0/dictionaries/moneyTypes": { "get": { "tags": [ "Справочники" ], "summary": "Получение справочника вариантов оплаты.", "description": "API для интеграции. Справочник отдаётся целиком: фильтров и постраничной выдачи нет. Вариант оплаты указывается в условиях оплаты груза.", "operationId": "Dictionaries_MoneyTypes", "responses": { "200": { "description": "Справочник целиком.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MoneyType" } } } } } } } }, "/gw/marshak/v1/pack_types": { "get": { "tags": [ "Словари" ], "summary": "Получение списка наименований упаковок", "parameters": [ { "name": "attributeFieldFormat", "in": "query", "description": "Формат атрибутов в ответе. Для человекочитаемого варианта используйте значение `2` — атрибуты вернутся словарём `ключ: значение`.", "schema": { "type": "integer", "enum": [ 0, 1, 2 ], "default": 2 } }, { "name": "locale", "in": "query", "schema": { "type": "string" } }, { "name": "lastUpdate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Элементы словаря", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DictionaryItemWithAttributeDictionary" } } } } } } } }, "/v1.0/dictionaries/packTypes": { "get": { "tags": [ "Справочники" ], "summary": "Получение справочника типов упаковки.", "description": "API для интеграции. Справочник отдаётся целиком: фильтров и постраничной выдачи нет. Тип упаковки указывается в описании груза.", "operationId": "Dictionaries_PackTypes", "responses": { "200": { "description": "Справочник целиком.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PackType" } } } } } } } }, "/gw/marshak/v1/load_type": { "get": { "tags": [ "Словари" ], "summary": "Получение списка вариантов загрузки и разгрузки", "parameters": [ { "name": "attributeFieldFormat", "in": "query", "description": "Формат атрибутов в ответе. Для человекочитаемого варианта используйте значение `2` — атрибуты вернутся словарём `ключ: значение`.", "schema": { "type": "integer", "enum": [ 0, 1, 2 ], "default": 2 } }, { "name": "locale", "in": "query", "schema": { "type": "string" } }, { "name": "lastUpdate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Элементы словаря", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DictionaryItemWithAttributeDictionary" } } } } } } } }, "/v1.0/dictionaries/unloadingTypes": { "get": { "tags": [ "Справочники" ], "summary": "Получение справочника вариантов разгрузки.", "description": "API для интеграции. Справочник отдаётся целиком: фильтров и постраничной выдачи нет. Вариант разгрузки указывается в точке выгрузки груза. Сейчас список совпадает с вариантами загрузки.", "operationId": "Dictionaries_UnloadingTypes", "responses": { "200": { "description": "Справочник целиком.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LoadingType" } } } } } } } }, "/gw/marshak/v1/load_access_denied_reasons": { "get": { "tags": [ "Словари" ], "summary": "Получение списка пояснений к отказу в доступе к работе с грузом", "parameters": [ { "name": "attributeFieldFormat", "in": "query", "description": "Формат атрибутов в ответе. Для человекочитаемого варианта используйте значение `2` — атрибуты вернутся словарём `ключ: значение`.", "schema": { "type": "integer", "enum": [ 0, 1, 2 ], "default": 2 } }, { "name": "locale", "in": "query", "schema": { "type": "string" } }, { "name": "lastUpdate", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "Элементы словаря", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DictionaryItemWithAttributeDictionary" } } } } } } } }, "/v1.0/dictionaries/load_access_denied_reasons": { "get": { "tags": [ "Справочники" ], "summary": "Получение расшифровок причин отказа в доступе к грузу.", "description": "API для интеграции. Ключ — код причины из ошибки доступа к грузу, значение — пояснение на русском.", "operationId": "Dictionaries_LoadAccessDeniedReasons", "responses": { "200": { "description": "Причины отказа. Ключ — код причины.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "example": { "3": "Превышен лимит актуальных грузов" } } } } } } }, "/v1.2/catalogs/dictionaries/truckbrands": { "get": { "tags": [ "Словари ТС" ], "summary": "Получение словаря со всеми брендами ТС", "operationId": "TruckDictionaries_GetTruckBrands", "parameters": [ { "name": "ids", "in": "query", "style": "form", "explode": true, "description": "Массив идентификаторов брэндов, необязательный параметр", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "x-position": 1 } ], "responses": { "200": { "description": "Список брендов ТС", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TruckBrandView" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/gw/oauth2/catalogs/v1.2/dictionaries/truckbrands": { "get": { "tags": [ "Словари ТС" ], "summary": "Получение словаря со всеми брендами ТС", "operationId": "TruckDictionaries_GetTruckBrands2", "parameters": [ { "name": "ids", "in": "query", "style": "form", "explode": true, "description": "Массив идентификаторов брэндов, необязательный параметр", "schema": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "x-position": 1 } ], "responses": { "200": { "description": "Список брендов ТС", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TruckBrandView" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/v1.2/catalogs/dictionaries/truckmodels": { "get": { "tags": [ "Словари ТС" ], "summary": "Получение словаря со всеми моделями ТС", "operationId": "TruckDictionaries_GetTruckModels", "parameters": [ { "name": "brandId", "in": "query", "description": "Идентификатор брэнда, необязательный параметр", "schema": { "type": "integer", "format": "int32", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Список моделей ТС", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TruckModelView" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/gw/oauth2/catalogs/v1.2/dictionaries/truckmodels": { "get": { "tags": [ "Словари ТС" ], "summary": "Получение словаря со всеми моделями ТС", "operationId": "TruckDictionaries_GetTruckModels2", "parameters": [ { "name": "brandId", "in": "query", "description": "Идентификатор брэнда, необязательный параметр", "schema": { "type": "integer", "format": "int32", "nullable": true }, "x-position": 1 } ], "responses": { "200": { "description": "Список моделей ТС", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/TruckModelView" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/v1.2/catalogs/dictionaries/container_dimensions": { "get": { "tags": [ "Словари ТС" ], "summary": "Получение словаря со всеми размерностями контейнера ТС", "operationId": "TruckDictionaries_GetContainerDimensions", "responses": { "200": { "description": "Список размерностей контейнера ТС", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ContainerDimensionView" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/gw/oauth2/catalogs/v1.2/dictionaries/container_dimensions": { "get": { "tags": [ "Словари ТС" ], "summary": "Получение словаря со всеми размерностями контейнера ТС", "operationId": "TruckDictionaries_GetContainerDimensions2", "responses": { "200": { "description": "Список размерностей контейнера ТС", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/ContainerDimensionView" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionView" } } } } }, "security": [ { "catalogs__JWT": [] } ] } }, "/gw/marshak/v1/dictionaries/claim_types": { "get": { "tags": [ "claim_types" ], "summary": "Получение словаря claim_types", "description": "Типы претензий ATI.SU: за что участник выставляет претензию контрагенту — неоплата, простой транспорта, утрата груза и прочие основания.", "operationId": "getPublicDictionary_claim_types", "parameters": [ { "name": "locale", "in": "query", "description": "Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy", "schema": { "type": "string", "example": "ru" }, "example": "ru" } ], "responses": { "200": { "description": "Элементы словаря claim_types", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/claim_typesResponse" } } } } }, "security": [ { "bearer": [] } ] } }, "/gw/marshak/v1/dictionaries/claim_for_types": { "get": { "tags": [ "claim_for_types" ], "summary": "Получение словаря claim_for_types", "description": "Сторона, к которой выставлена претензия: заказчик или исполнитель перевозки.", "operationId": "getPublicDictionary_claim_for_types", "parameters": [ { "name": "locale", "in": "query", "description": "Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy", "schema": { "type": "string", "example": "ru" }, "example": "ru" } ], "responses": { "200": { "description": "Элементы словаря claim_for_types", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/claim_for_typesResponse" } } } } }, "security": [ { "bearer": [] } ] } }, "/gw/marshak/v1/dictionaries/claim_levels": { "get": { "tags": [ "claim_levels" ], "summary": "Получение словаря claim_levels", "description": "Уровни претензии: лайт — поданная по минимальному комплекту документов, про — по полному комплекту.", "operationId": "getPublicDictionary_claim_levels", "parameters": [ { "name": "locale", "in": "query", "description": "Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy", "schema": { "type": "string", "example": "ru" }, "example": "ru" } ], "responses": { "200": { "description": "Элементы словаря claim_levels", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/claim_levelsResponse" } } } } }, "security": [ { "bearer": [] } ] } }, "/gw/marshak/v1/dictionaries/claim_statuses": { "get": { "tags": [ "claim_statuses" ], "summary": "Получение словаря claim_statuses", "description": "Статусы претензии: опубликована, отклонена, урегулирована и прочие состояния её жизненного цикла.", "operationId": "getPublicDictionary_claim_statuses", "parameters": [ { "name": "locale", "in": "query", "description": "Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy", "schema": { "type": "string", "example": "ru" }, "example": "ru" } ], "responses": { "200": { "description": "Элементы словаря claim_statuses", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/claim_statusesResponse" } } } } }, "security": [ { "bearer": [] } ] } }, "/gw/marshak/v1/dictionaries/claim_moderator_statuses": { "get": { "tags": [ "claim_moderator_statuses" ], "summary": "Получение словаря claim_moderator_statuses", "description": "Статусы модерации претензии: проверил ли претензию модератор ATI.SU и с каким результатом.", "operationId": "getPublicDictionary_claim_moderator_statuses", "parameters": [ { "name": "locale", "in": "query", "description": "Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy", "schema": { "type": "string", "example": "ru" }, "example": "ru" } ], "responses": { "200": { "description": "Элементы словаря claim_moderator_statuses", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/claim_moderator_statusesResponse" } } } } }, "security": [ { "bearer": [] } ] } }, "/gw/marshak/v1/dictionaries/claim_connection_statuses": { "get": { "tags": [ "claim_connection_statuses" ], "summary": "Получение словаря claim_connection_statuses", "description": "Статусы связи ответчика по претензии с юр. лицом, указанным в её документах: подтверждена ли связь и на каком основании.", "operationId": "getPublicDictionary_claim_connection_statuses", "parameters": [ { "name": "locale", "in": "query", "description": "Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy", "schema": { "type": "string", "example": "ru" }, "example": "ru" } ], "responses": { "200": { "description": "Элементы словаря claim_connection_statuses", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/claim_connection_statusesResponse" } } } } }, "security": [ { "bearer": [] } ] } }, "/gw/marshak/v1/dictionaries/claim_challenge_statuses": { "get": { "tags": [ "claim_challenge_statuses" ], "summary": "Получение словаря claim_challenge_statuses", "description": "Статусы оспоренности претензии: заявил ли ответчик несогласие с претензией по существу.", "operationId": "getPublicDictionary_claim_challenge_statuses", "parameters": [ { "name": "locale", "in": "query", "description": "Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy", "schema": { "type": "string", "example": "ru" }, "example": "ru" } ], "responses": { "200": { "description": "Элементы словаря claim_challenge_statuses", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/claim_challenge_statusesResponse" } } } } }, "security": [ { "bearer": [] } ] } }, "/gw/marshak/v1/dictionaries/claim_roles": { "get": { "tags": [ "claim_roles" ], "summary": "Получение словаря claim_roles", "description": "Роли участника претензии: истец — тот, кто выставил претензию, ответчик — тот, кому она выставлена.", "operationId": "getPublicDictionary_claim_roles", "parameters": [ { "name": "locale", "in": "query", "description": "Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy", "schema": { "type": "string", "example": "ru" }, "example": "ru" } ], "responses": { "200": { "description": "Элементы словаря claim_roles", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/claim_rolesResponse" } } } } }, "security": [ { "bearer": [] } ] } }, "/gw/marshak/v1/dictionaries/claim_sort_types": { "get": { "tags": [ "claim_sort_types" ], "summary": "Получение словаря claim_sort_types", "description": "Поля, по которым упорядочивается список претензий: дата, сумма, имя стороны.", "operationId": "getPublicDictionary_claim_sort_types", "parameters": [ { "name": "locale", "in": "query", "description": "Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy", "schema": { "type": "string", "example": "ru" }, "example": "ru" } ], "responses": { "200": { "description": "Элементы словаря claim_sort_types", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/claim_sort_typesResponse" } } } } }, "security": [ { "bearer": [] } ] } }, "/gw/marshak/v1/dictionaries/claim_doc_types": { "get": { "tags": [ "claim_doc_types" ], "summary": "Получение словаря claim_doc_types", "description": "Типы документов, которые прикладываются к претензии: договор, заявка, транспортная накладная, акт и прочие.", "operationId": "getPublicDictionary_claim_doc_types", "parameters": [ { "name": "locale", "in": "query", "description": "Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy", "schema": { "type": "string", "example": "ru" }, "example": "ru" } ], "responses": { "200": { "description": "Элементы словаря claim_doc_types", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/claim_doc_typesResponse" } } } } }, "security": [ { "bearer": [] } ] } }, "/gw/marshak/v1/dictionaries/claim_doc_statuses": { "get": { "tags": [ "claim_doc_statuses" ], "summary": "Получение словаря claim_doc_statuses", "description": "Статусы отдельного документа претензии: проверен ли документ модератором ATI.SU.", "operationId": "getPublicDictionary_claim_doc_statuses", "parameters": [ { "name": "locale", "in": "query", "description": "Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy", "schema": { "type": "string", "example": "ru" }, "example": "ru" } ], "responses": { "200": { "description": "Элементы словаря claim_doc_statuses", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/claim_doc_statusesResponse" } } } } }, "security": [ { "bearer": [] } ] } }, "/gw/marshak/v1/dictionaries/claim_digital_document_statuses": { "get": { "tags": [ "claim_digital_document_statuses" ], "summary": "Получение словаря claim_digital_document_statuses", "description": "Состояния проверки электронного документа претензии.", "operationId": "getPublicDictionary_claim_digital_document_statuses", "parameters": [ { "name": "locale", "in": "query", "description": "Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy", "schema": { "type": "string", "example": "ru" }, "example": "ru" } ], "responses": { "200": { "description": "Элементы словаря claim_digital_document_statuses", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/claim_digital_document_statusesResponse" } } } } }, "security": [ { "bearer": [] } ] } }, "/gw/marshak/v1/dictionaries/claim_draft_statuses": { "get": { "tags": [ "claim_draft_statuses" ], "summary": "Получение словаря claim_draft_statuses", "description": "Состояния черновика претензии, поданной с электронными документами: идёт ли по нему проверка и чем она закончилась.", "operationId": "getPublicDictionary_claim_draft_statuses", "parameters": [ { "name": "locale", "in": "query", "description": "Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy", "schema": { "type": "string", "example": "ru" }, "example": "ru" } ], "responses": { "200": { "description": "Элементы словаря claim_draft_statuses", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/claim_draft_statusesResponse" } } } } }, "security": [ { "bearer": [] } ] } }, "/gw/marshak/v1/dictionaries/firm_documents_template": { "get": { "tags": [ "firm_documents_template" ], "summary": "Получение словаря firm_documents_template", "description": "Типы документов фирмы: свидетельства, лицензии, договоры и другие документы, которые фирма прикладывает к своему профилю", "operationId": "getPublicDictionary_firm_documents_template", "parameters": [ { "name": "locale", "in": "query", "description": "Локаль значений полей. Доступные варианты: ru, en, kk, ky, uz, hy", "schema": { "type": "string", "example": "ru" }, "example": "ru" } ], "responses": { "200": { "description": "Элементы словаря firm_documents_template", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firm_documents_templateResponse" } } } } }, "security": [ { "bearer": [] } ] } }, "/v1.0/dictionaries/ownerships": { "get": { "tags": [ "Справочники" ], "summary": "Получение справочника организационно-правовых форм.", "description": "API для интеграции. Справочник отдаётся целиком: фильтров и постраничной выдачи нет. Организационно-правовая форма указывается в реквизитах фирмы.", "operationId": "Dictionaries_OwnShips", "responses": { "200": { "description": "Справочник целиком.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Ownership" } } } } } } } }, "/v1.0/firms/dictionaries/account/firmtypes": { "get": { "tags": [ "AccountDictionaries" ], "summary": "Метод получения профилей деятельности фирм", "parameters": [ { "name": "enableForRegistration", "in": "query", "description": "Доступность профиля при регистрации", "schema": { "type": "boolean", "description": "Доступность профиля при регистрации", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FirmType" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "504": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } } } } }, "/v1.0/firms/dictionaries/account/firmtypes/{id}": { "get": { "tags": [ "AccountDictionaries" ], "summary": "Метод получения профилей деятельности фирм", "parameters": [ { "name": "id", "in": "path", "description": "Идентификатор профиля фирмы", "required": true, "schema": { "type": "integer", "description": "Идентификатор профиля фирмы", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmType" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "504": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } } } } }, "/v1.0/firms/requisites/countries": { "get": { "tags": [ "RequisiteDictionaries" ], "summary": "Возвращает справочник стран, доступных в реквизитах.", "operationId": "get_v1.0_firms_requisites_countries", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/billing-requisites__Country" }, "example": [ { "id": 1, "name": "Россия", "short_name": "РФ", "default_ownership": { "id": 1, "name": "Общество с ограниченной ответственностью", "name_eng": "Limited Liability Company", "short_name": "ООО", "short_name_eng": "LLC", "ownership_type": "LegalPerson", "ownership_type_name": "LegalPerson", "requisite_types": [ 0 ] }, "ownerships": [ { "id": 1, "name": "Общество с ограниченной ответственностью", "name_eng": "Limited Liability Company", "short_name": "ООО", "short_name_eng": "LLC", "ownership_type": "LegalPerson", "ownership_type_name": "LegalPerson", "requisite_types": [ 0 ] } ] } ] }, "example": [ { "id": 1, "name": "Россия", "short_name": "РФ", "default_ownership": { "id": 1, "name": "Общество с ограниченной ответственностью", "name_eng": "Limited Liability Company", "short_name": "ООО", "short_name_eng": "LLC", "ownership_type": "LegalPerson", "ownership_type_name": "LegalPerson", "requisite_types": [ 0 ] }, "ownerships": [ { "id": 1, "name": "Общество с ограниченной ответственностью", "name_eng": "Limited Liability Company", "short_name": "ООО", "short_name_eng": "LLC", "ownership_type": "LegalPerson", "ownership_type_name": "LegalPerson", "requisite_types": [ 0 ] } ] } ] } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "402": { "description": "Метод доступен только платным пользователям.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "payment_required", "reason": "Метод доступен только платным пользователям." } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "504": { "description": "Сервер не ответил во время.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "timeout", "reason": "Сервер не ответил во время." } } } } } } }, "/v1.0/firms/requisites/addressparts": { "get": { "tags": [ "RequisiteDictionaries" ], "summary": "Возвращает справочник частей адреса (типы улиц, зданий, частей строений, помещений).", "operationId": "get_v1.0_firms_requisites_addressparts", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing-requisites__AddressParts" }, "example": { "street_types": [ { "id": 1, "name": "проспект", "short_name": "пр-кт" } ], "building_types": [ { "id": 1, "name": "проспект", "short_name": "пр-кт" } ], "building_part_types": [ { "id": 1, "name": "проспект", "short_name": "пр-кт" } ], "room_types": [ { "id": 1, "name": "проспект", "short_name": "пр-кт" } ] } } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "402": { "description": "Метод доступен только платным пользователям.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "payment_required", "reason": "Метод доступен только платным пользователям." } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "504": { "description": "Сервер не ответил во время.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "timeout", "reason": "Сервер не ответил во время." } } } } } } }, "/v1.0/firms/requisites/ownerships/{countryId}": { "get": { "tags": [ "RequisiteDictionaries" ], "summary": "Возвращает список форм собственности, доступных для указанной страны.", "operationId": "get_v1.0_firms_requisites_ownerships__countryId_", "parameters": [ { "name": "countryId", "in": "path", "description": "Идентификатор страны (из `GET /v1.0/firms/requisites/countries`).", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 1 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/billing-requisites__Ownership" }, "example": [ { "id": 1, "name": "Общество с ограниченной ответственностью", "name_eng": "Limited Liability Company", "short_name": "ООО", "short_name_eng": "LLC", "ownership_type": "LegalPerson", "ownership_type_name": "LegalPerson", "requisite_types": [ 0 ] } ] }, "example": [ { "id": 1, "name": "Общество с ограниченной ответственностью", "name_eng": "Limited Liability Company", "short_name": "ООО", "short_name_eng": "LLC", "ownership_type": "LegalPerson", "ownership_type_name": "LegalPerson", "requisite_types": [ 0 ] } ] } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "402": { "description": "Метод доступен только платным пользователям.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "payment_required", "reason": "Метод доступен только платным пользователям." } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "504": { "description": "Сервер не ответил во время.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "timeout", "reason": "Сервер не ответил во время." } } } } } } }, "/gw/gis-dict/v1/cities/by-ids": { "post": { "tags": [ "Cities" ], "summary": "Получение населённых пунктов по списку идентификаторов (кодов ATI.SU)", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByIdsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByIdsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByIdsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/oauth2/gis-dict/v1/cities/by-ids": { "post": { "tags": [ "Cities" ], "summary": "Получение населённых пунктов по списку идентификаторов (кодов ATI.SU)", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByIdsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByIdsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByIdsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/gis-dict/v1/cities/by-coordinate": { "post": { "tags": [ "Cities" ], "summary": "Получение населённого пункта по координате", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.City" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.City" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.City" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/oauth2/gis-dict/v1/cities/by-coordinate": { "post": { "tags": [ "Cities" ], "summary": "Получение населённого пункта по координате", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.City" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.City" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.City" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/gis-dict/v1/cities/by-fias-ids": { "post": { "tags": [ "Cities" ], "summary": "Получение населённых пунктов по списку идентификаторов ФИАС", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByGarIdsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByGarIdsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByGarIdsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/oauth2/gis-dict/v1/cities/by-fias-ids": { "post": { "tags": [ "Cities" ], "summary": "Получение населённых пунктов по списку идентификаторов ФИАС", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByGarIdsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByGarIdsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByGarIdsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/gis-dict/v1/cities/by-kladr-codes": { "post": { "tags": [ "Cities" ], "summary": "Получение населённых пунктов по списку идентификаторов КЛАДР", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByKladrCodesRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByKladrCodesRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByKladrCodesRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/oauth2/gis-dict/v1/cities/by-kladr-codes": { "post": { "tags": [ "Cities" ], "summary": "Получение населённых пунктов по списку идентификаторов КЛАДР", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByKladrCodesRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByKladrCodesRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCitiesByKladrCodesRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCitiesResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/gis-dict/v1/city-types": { "get": { "tags": [ "CityTypes" ], "summary": "Получение всех типов населённых пунктов", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCityTypesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCityTypesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCityTypesResponse" } } } }, "304": { "description": "Not Modified" } } } }, "/gw/oauth2/gis-dict/v1/city-types": { "get": { "tags": [ "CityTypes" ], "summary": "Получение всех типов населённых пунктов", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCityTypesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCityTypesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCityTypesResponse" } } } }, "304": { "description": "Not Modified" } } } }, "/gw/gis-dict/v1/districts/by-ids": { "post": { "tags": [ "Districts" ], "summary": "Получение районов по списку идентификаторов (кодов ATI.SU)", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetDistrictsByIdsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetDistrictsByIdsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetDistrictsByIdsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetDistrictsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetDistrictsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetDistrictsResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/oauth2/gis-dict/v1/districts/by-ids": { "post": { "tags": [ "Districts" ], "summary": "Получение районов по списку идентификаторов (кодов ATI.SU)", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetDistrictsByIdsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetDistrictsByIdsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetDistrictsByIdsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetDistrictsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetDistrictsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetDistrictsResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/gis-dict/v1/federal-districts": { "get": { "tags": [ "FederalDistricts" ], "summary": "Получение всех федеральных округов", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetFederalDistrictsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetFederalDistrictsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetFederalDistrictsResponse" } } } }, "304": { "description": "Not Modified" } } } }, "/gw/oauth2/gis-dict/v1/federal-districts": { "get": { "tags": [ "FederalDistricts" ], "summary": "Получение всех федеральных округов", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetFederalDistrictsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetFederalDistrictsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetFederalDistrictsResponse" } } } }, "304": { "description": "Not Modified" } } } }, "/gw/gis-dict/v1/regions/by-ids": { "post": { "tags": [ "Regions" ], "summary": "Получение регионов по списку идентификаторов (кодов ATI.SU)", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetRegionsByIdsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetRegionsByIdsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetRegionsByIdsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetRegionsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetRegionsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetRegionsResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/oauth2/gis-dict/v1/regions/by-ids": { "post": { "tags": [ "Regions" ], "summary": "Получение регионов по списку идентификаторов (кодов ATI.SU)", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetRegionsByIdsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetRegionsByIdsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetRegionsByIdsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetRegionsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetRegionsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetRegionsResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/gis-dict/v1/regions/by-coordinate": { "post": { "tags": [ "Regions" ], "summary": "Получение региона по координате", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Region" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Region" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Region" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/oauth2/gis-dict/v1/regions/by-coordinate": { "post": { "tags": [ "Regions" ], "summary": "Получение региона по координате", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Region" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Region" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Region" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/gis-dict/v1/regions/by-fias-ids": { "post": { "tags": [ "Regions" ], "summary": "Получение регионов по списку идентификаторов ФИАС", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetRegionsByGarIdsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetRegionsByGarIdsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetRegionsByGarIdsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetRegionsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetRegionsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetRegionsResponse" } } } } } } }, "/gw/oauth2/gis-dict/v1/regions/by-fias-ids": { "post": { "tags": [ "Regions" ], "summary": "Получение регионов по списку идентификаторов ФИАС", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetRegionsByGarIdsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetRegionsByGarIdsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetRegionsByGarIdsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetRegionsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetRegionsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetRegionsResponse" } } } } } } }, "/gw/gis-dict/v1/countries/by-ids": { "post": { "tags": [ "Countries" ], "summary": "Получение стран по списку идентификаторов (кодов ATI.SU)", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCountriesByIdsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCountriesByIdsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCountriesByIdsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCountriesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCountriesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCountriesResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/oauth2/gis-dict/v1/countries/by-ids": { "post": { "tags": [ "Countries" ], "summary": "Получение стран по списку идентификаторов (кодов ATI.SU)", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCountriesByIdsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCountriesByIdsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GetCountriesByIdsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCountriesResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCountriesResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetCountriesResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/gis-dict/v1/countries/by-coordinate": { "post": { "tags": [ "Countries" ], "summary": "Получение страны по координате", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Country" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Country" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Country" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/oauth2/gis-dict/v1/countries/by-coordinate": { "post": { "tags": [ "Countries" ], "summary": "Получение страны по координате", "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Country" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Country" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Country" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/gis-dict/v1/directions": { "get": { "tags": [ "Directions" ], "summary": "Получение всех направлений", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetDirectionsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetDirectionsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetDirectionsResponse" } } } }, "304": { "description": "Not Modified" } } } }, "/gw/oauth2/gis-dict/v1/directions": { "get": { "tags": [ "Directions" ], "summary": "Получение всех направлений", "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetDirectionsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetDirectionsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GetDirectionsResponse" } } } }, "304": { "description": "Not Modified" } } } }, "/gw/gis-dict/v1/direction/from/{from}/to/{to}": { "get": { "tags": [ "Directions" ], "summary": "Получение направления между городами", "parameters": [ { "name": "from", "in": "path", "description": "Код ATI.SU для населённого пункта \"откуда\"", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "to", "in": "path", "description": "Код ATI.SU для населённого пункта \"куда\"", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.DirectionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.DirectionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.DirectionResponse" } } } } } } }, "/gw/oauth2/gis-dict/v1/direction/from/{from}/to/{to}": { "get": { "tags": [ "Directions" ], "summary": "Получение направления между городами", "parameters": [ { "name": "from", "in": "path", "description": "Код ATI.SU для населённого пункта \"откуда\"", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "to", "in": "path", "description": "Код ATI.SU для населённого пункта \"куда\"", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.DirectionResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.DirectionResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.DirectionResponse" } } } } } } }, "/v1.0/dictionaries/streetTypes": { "get": { "tags": [ "Справочники" ], "summary": "Получение справочника типов улиц.", "description": "API для интеграции. Справочник отдаётся целиком: фильтров и постраничной выдачи нет.", "operationId": "Dictionaries_StreetTypes", "responses": { "200": { "description": "Справочник целиком.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StreetType" } } } } } } } }, "/gw/gis-dict/v1/autocomplete/suggestions": { "post": { "tags": [ "AutoComplete" ], "summary": "Автокомплит до населённого пункта", "requestBody": { "description": "GeoService.Dictionaries.Models.AutoComplete.SuggestionsRequest", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SuggestionsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SuggestionsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SuggestionsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SuggestionsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SuggestionsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SuggestionsResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/oauth2/gis-dict/v1/autocomplete/suggestions": { "post": { "tags": [ "AutoComplete" ], "summary": "Автокомплит до населённого пункта", "requestBody": { "description": "GeoService.Dictionaries.Models.AutoComplete.SuggestionsRequest", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SuggestionsRequest" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SuggestionsRequest" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SuggestionsRequest" } ] } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SuggestionsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SuggestionsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SuggestionsResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/gis-dict/v1/direct-geocoding": { "post": { "tags": [ "GeoCoding" ], "summary": "Получение координаты гео-объекта по адресной строке (платный)", "requestBody": { "content": { "application/json": { "schema": { "required": [ "address", "max_level" ], "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoCoding.GetGeoCodingDirectRequest" } ], "description": "Запрос на гео-кодирование по адресной строке" } }, "text/json": { "schema": { "required": [ "address", "max_level" ], "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoCoding.GetGeoCodingDirectRequest" } ], "description": "Запрос на гео-кодирование по адресной строке" } }, "application/*+json": { "schema": { "required": [ "address", "max_level" ], "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoCoding.GetGeoCodingDirectRequest" } ], "description": "Запрос на гео-кодирование по адресной строке" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.ValidationErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.ValidationErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.ValidationErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/oauth2/gis-dict/v1/direct-geocoding": { "post": { "tags": [ "GeoCoding" ], "summary": "Получение координаты гео-объекта по адресной строке (платный)", "requestBody": { "content": { "application/json": { "schema": { "required": [ "address", "max_level" ], "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoCoding.GetGeoCodingDirectRequest" } ], "description": "Запрос на гео-кодирование по адресной строке" } }, "text/json": { "schema": { "required": [ "address", "max_level" ], "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoCoding.GetGeoCodingDirectRequest" } ], "description": "Запрос на гео-кодирование по адресной строке" } }, "application/*+json": { "schema": { "required": [ "address", "max_level" ], "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoCoding.GetGeoCodingDirectRequest" } ], "description": "Запрос на гео-кодирование по адресной строке" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.ValidationErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.ValidationErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.ValidationErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/gis-dict/v1/reverse-geocoding": { "post": { "tags": [ "GeoCoding" ], "summary": "Получение адресной структуры гео-объекта по координате (платный)", "requestBody": { "content": { "application/json": { "schema": { "required": [ "location", "max_level" ], "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoCoding.GetReverseGeoCodingRequest" } ], "description": "Модель, представляющая настройки обратного гео-кодирования" } }, "text/json": { "schema": { "required": [ "location", "max_level" ], "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoCoding.GetReverseGeoCodingRequest" } ], "description": "Модель, представляющая настройки обратного гео-кодирования" } }, "application/*+json": { "schema": { "required": [ "location", "max_level" ], "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoCoding.GetReverseGeoCodingRequest" } ], "description": "Модель, представляющая настройки обратного гео-кодирования" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.ValidationErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.ValidationErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.ValidationErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/gw/oauth2/gis-dict/v1/reverse-geocoding": { "post": { "tags": [ "GeoCoding" ], "summary": "Получение адресной структуры гео-объекта по координате (платный)", "requestBody": { "content": { "application/json": { "schema": { "required": [ "location", "max_level" ], "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoCoding.GetReverseGeoCodingRequest" } ], "description": "Модель, представляющая настройки обратного гео-кодирования" } }, "text/json": { "schema": { "required": [ "location", "max_level" ], "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoCoding.GetReverseGeoCodingRequest" } ], "description": "Модель, представляющая настройки обратного гео-кодирования" } }, "application/*+json": { "schema": { "required": [ "location", "max_level" ], "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoCoding.GetReverseGeoCodingRequest" } ], "description": "Модель, представляющая настройки обратного гео-кодирования" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.ValidationErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.ValidationErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.ValidationErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } } } } } } }, "/v1.0/dictionaries/cities": { "get": { "tags": [ "Справочники" ], "summary": "Поиск городов по названию или получение городов по списку идентификаторов.", "description": "API для интеграции. При заданном названии поиск идёт по нему, а список идентификаторов не учитывается; без обоих параметров отдаётся весь справочник.\nСписок полей сокращает состав ответа, идентификатор города отдаётся всегда.", "operationId": "Dictionaries_CitiesAll", "parameters": [ { "name": "name", "in": "query", "description": "Подстрока названия, регистр не важен. При cityNameOnly=false ищется во всём названии с регионом и страной.", "schema": { "type": "string" }, "x-position": 1, "example": "Санкт" }, { "name": "cityNameOnly", "in": "query", "description": "Искать только по названию города, а не по полному имени с регионом и страной.", "schema": { "type": "boolean" }, "x-position": 2, "example": false }, { "name": "ids", "in": "query", "style": "form", "explode": true, "description": "Идентификаторы городов: повтором параметра или через запятую в одном значении.", "schema": { "type": "array", "items": { "type": "string" } }, "x-position": 3, "example": [ "1", "2" ] }, { "name": "includedFields", "in": "query", "style": "form", "explode": true, "description": "Какие поля оставить в ответе: повтором параметра или через запятую в одном значении.", "schema": { "type": "array", "items": { "type": "string" } }, "x-position": 4, "example": [ "CityId", "CityName" ] } ], "responses": { "200": { "description": "Найденные города.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ati.search-loadsAndDictionaries__City" } } } } } } } }, "/v1.0/dictionaries/cities/byfias/{fias}": { "get": { "tags": [ "Справочники" ], "summary": "Получение конкретного города по его идентификатору в базе ФИАС.", "description": "API для интеграции. Способ найти город АТИ, если на вашей стороне адрес хранится в кодах ФИАС.", "operationId": "Dictionaries_Cities2", "parameters": [ { "name": "fias", "in": "path", "required": true, "description": "Идентификатор города в базе ФИАС.", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "c2deb16a-0330-4f05-821f-1d09c93331e6" } ], "responses": { "200": { "description": "Город.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ati.search-loadsAndDictionaries__City" } } } }, "404": { "description": "Города с таким кодом ФИАС нет в справочнике.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfCityNotFoundException" } } } } } } }, "/v1.0/dictionaries/cities/{cityId}": { "get": { "tags": [ "Справочники" ], "summary": "Получение конкретного города по его идентификатору.", "description": "API для интеграции. Идентификаторы городов возвращают методы поиска городов и поля точек погрузки и выгрузки в грузе.", "operationId": "Dictionaries_Cities", "parameters": [ { "name": "cityId", "in": "path", "required": true, "description": "Идентификатор города.", "schema": { "type": "integer", "format": "int32" }, "x-position": 1, "example": 1 } ], "responses": { "200": { "description": "Город.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ati.search-loadsAndDictionaries__City" } } } }, "404": { "description": "Города с таким идентификатором нет в справочнике.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfCityNotFoundException" } } } } } } }, "/v1.0/dictionaries/regions": { "get": { "tags": [ "Справочники" ], "summary": "Получение справочника регионов.", "description": "API для интеграции. Справочник отдаётся целиком: фильтров и постраничной выдачи нет. Идентификаторы регионов приходят в записях городов.", "operationId": "Dictionaries_Regions", "responses": { "200": { "description": "Справочник целиком.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Region" } } } } } } } }, "/v1.0/dictionaries/locations/parse": { "post": { "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "$ref": "#/components/schemas/PublicGeoParserResultView" }, "type": "object" } } }, "description": "Результат геокодирования", "x-nullable": false } }, "security": [ { "JWT": [] } ], "tags": [ "Работа с адресами" ], "description": "За один запрос можно передать не более 20 адресов, они должны быть уникальны в рамках запроса", "operationId": "Locations_ParseLocations", "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/InternalLocationsParseDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/InternalLocationsParseDto" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/InternalLocationsParseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InternalLocationsParseDto" } } }, "description": "Адреса, которые нужно обработать" }, "summary": "Получение города, соответствующего указанному адресу" } }, "/v1.0/dictionaries/cities/{cityId}/near": { "get": { "tags": [ "Справочники" ], "summary": "Получение списка ближайших городов по городу.", "description": "API для интеграции. Исходный город в выдачу не входит. Сначала идут крупные города, затем остальные по расстоянию.", "operationId": "Dictionaries_NearCities", "parameters": [ { "name": "cityId", "in": "path", "required": true, "description": "Идентификатор города.", "schema": { "type": "integer", "format": "int32" }, "x-position": 1, "example": 1 }, { "name": "count", "in": "query", "description": "Сколько городов вернуть, не больше 20.", "schema": { "type": "integer", "format": "int32", "default": 5 }, "x-position": 2, "example": 5 }, { "name": "radius", "in": "query", "description": "Радиус поиска в километрах, не больше 300.", "schema": { "type": "integer", "format": "int32", "default": 200 }, "x-position": 3, "example": 200 }, { "name": "largeCityCount", "in": "query", "description": "Сколько из них должно быть крупными городами.", "schema": { "type": "integer", "format": "int32", "default": 3 }, "x-position": 4, "example": 3 } ], "responses": { "200": { "description": "Ближайшие города с расстоянием до исходного.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CityWithDistance" } } } } }, "400": { "description": "Количество или радиус вне допустимых границ.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfRequestValidationException" } } } }, "404": { "description": "Исходного города нет в справочнике.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfCityNotFoundException" } } } } } } }, "/v1.0/dictionaries/loadingTypes": { "get": { "tags": [ "Справочники" ], "summary": "Получение справочника вариантов загрузки.", "description": "API для интеграции. Справочник отдаётся целиком: фильтров и постраничной выдачи нет. Вариант загрузки указывается в точке погрузки груза.", "operationId": "Dictionaries_LoadingTypes", "responses": { "200": { "description": "Справочник целиком.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LoadingType" } } } } } } } }, "/v1.0/dictionaries/truck_access_denied_reasons": { "get": { "tags": [ "Справочники" ], "summary": "Получение расшифровок причин отказа в доступе к машине.", "description": "API для интеграции. Ключ — код причины из ошибки доступа к машине, значение — пояснение на русском.", "operationId": "Dictionaries_TruckAccessDeniedReasons", "responses": { "200": { "description": "Причины отказа. Ключ — код причины.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "string" } }, "example": { "1": "Ваша фирма не имеет доступа к работе с машинами" } } } } } } }, "/gw/sign_checker/v4/verify-account-by-signature": { "post": { "tags": [ "Подтверждение аккаунта по сертификату ЭЦП (public)" ], "summary": "Подтверждение аккаунта с помощью сертификата КЭП", "description": "Подтверждает аккаунт с помощью сертификата КЭП, а также выполняет проверку подписи.", "operationId": "verify_account_by_signature_v4_verify_account_by_signature_post", "security": [ { "api-secret": [] }, { "user-id": [] }, { "client-name": [] }, { "baggage": [] }, { "x-baggage-passthrough": [] } ], "parameters": [ { "name": "verify_signature", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Флаг для проверки подписи", "default": true, "title": "Verify Signature" }, "description": "Флаг для проверки подписи" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_verify_account_by_signature_v4_verify_account_by_signature_post" } } } }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/sign_checker/v4/certificates/{certificate_id}/registration": { "post": { "tags": [ "Получение списка сертификатов по списку id" ], "summary": "Регистрация сертификата ИП в системе ЭПД", "description": "Запускает подключение ИП к системе оператора ЭПД Калуга Астрал с указанием адреса регистрациии.", "operationId": "register_certificate_with_legal_address_v4_certificates__certificate_id__registration_post", "security": [ { "api-secret": [] }, { "user-id": [] }, { "client-name": [] }, { "baggage": [] }, { "x-baggage-passthrough": [] } ], "parameters": [ { "name": "certificate_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "[a-fA-F0-9]{40}", "description": "ID (отпечаток) сертификата", "title": "Certificate Id" }, "description": "ID (отпечаток) сертификата" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegalAddressSchema" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/sign_checker/v4/certificates": { "get": { "tags": [ "Получение списка сертификатов по списку id" ], "summary": "Получение данных сертификатов", "description": "Возрвщает данные сертификаты из указанного списка ID (отпечатков).", "operationId": "get_certificates_details_v4_certificates_get", "security": [ { "api-secret": [] }, { "user-id": [] }, { "client-name": [] } ], "parameters": [ { "name": "certificate_ids", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string" }, "maxItems": 10, "description": "Список ID (отпечатков) сертификатов", "title": "Certificate Ids" }, "description": "Список ID (отпечатков) сертификатов" } ], "responses": { "200": { "description": "Список сертификатов", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CertificateResponsePublicData" }, "title": "Response Get Certificates Details V4 Certificates Get" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/sign_checker/v4/firms/current-user/certificates": { "get": { "tags": [ "Получение списка сертификатов по списку id" ], "summary": "Получение сертификатов авторизованного пользователя", "description": "Возвращает все сертификаты авторизованного пользователя.", "operationId": "get_all_certificates_for_current_user_v4_firms_current_user_certificates_get", "responses": { "200": { "description": "Сертификаты авторизованного пользователя", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/CertificateResponsePublicData" }, "type": "array", "title": "Response Get All Certificates For Current User V4 Firms Current User Certificates Get" } } } } }, "security": [ { "api-secret": [] }, { "user-id": [] }, { "client-name": [] } ] } }, "/gw/tokugawa/v1/common_api/documents/search": { "post": { "tags": [ "common" ], "summary": "Поиск по документам", "description": "Поиск по всем документам для текущего пользователя. \n Для поиска в определенных разделах (Шаблоны, Архив, Корзина), а также для отображения определенного количества документов, необходимо указывать соответствующие фильтры в теле запроса.", "operationId": "search_documents_common_api_documents_search_post", "requestBody": { "content": { "application/json": { "schema": { "title": "Search Object", "allOf": [ { "$ref": "#/components/schemas/DocumentsListSearchParamsSchema" } ], "default": { "limit": 50, "filters": { "is_deleted": false, "is_archived": false, "is_template": false } } } } } }, "responses": { "200": { "description": "Информация по найденным документам пользователя", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentsListResponseSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/listoc/order_documents/v4.0/{order_id}/documents": { "get": { "tags": [ "common" ], "summary": "Получение метаинформации по документам, привязанным к заказу", "description": "Получить метаинформацию по документам, привязанным к заказу", "operationId": "get_documents_by_order_id_order_documents_v4_0__order_id__documents_get", "parameters": [ { "required": true, "schema": { "title": "Order Id", "type": "string" }, "name": "order_id", "in": "path" }, { "required": false, "schema": { "title": "Only Etrn", "type": "boolean", "description": "Учитывать только ЭТрН", "default": false }, "name": "only_etrn", "in": "query", "description": "Учитывать только ЭТрН" } ], "responses": { "200": { "description": "Метаинформации по документам, привязанным к заказу", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderDocumentsListResponseSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/tokugawa/v1/common_api/documents/{action}": { "post": { "tags": [ "common" ], "summary": "Перемещение документов", "description": "Универсальный метод для перемещения документов в корзину или архив,\nа также для восстановления их из корзины и архива\nПытается обеспечить консистентность данных в rohrpost.\nAction может принимать значения \"trash\", \"archive\", \"restore_from_trash\" или \"restore_from_archive\"\n\n:param action: действие, которое нужно выполнить для группы документов\n:param to_be_updated_message_ids: id Messages, которые нужно удалить или архивировать\n:param current_user: авторизованный пользователь\n:return: id Messages, которые не удалось удалить", "operationId": "update_documents_common_api_documents__action__post", "parameters": [ { "required": true, "schema": { "title": "Action", "type": "string" }, "name": "action", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "title": "To Be Updated Message Ids", "type": "array", "items": { "type": "string" } } } }, "required": true }, "responses": { "200": { "description": "Документы успешно перемещены", "content": { "application/json": { "schema": { "title": "Response Update Documents Common Api Documents Action Post", "type": "array", "items": { "type": "string" } } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/epd/etrn/v1/docflows": { "post": { "tags": [ "etrn" ], "summary": "Создание ЭТрН", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocflowIdResponseSchema" } } } } } } }, "/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_1": { "put": { "tags": [ "etrn" ], "summary": "Сохранение черновика первого титула", "parameters": [ { "required": true, "schema": { "title": "Docflow Id", "type": "string" }, "name": "docflow_id", "in": "path", "description": "Идентификатор документооборота" }, { "required": false, "schema": { "title": "Send To Driver", "type": "boolean", "default": true }, "name": "send_to_driver", "in": "query", "description": "Отправка документа водителю" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NullableTitle1DraftData-Input" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocflowIdResponseSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_1/xml": { "put": { "tags": [ "Публичное API" ], "summary": "Сохранение черновика первого титула из XML-файла", "description": "Переносит данные из XML-файла первого титула в его черновик,\nполностью заменяя ранее сохранённые данные.\n\nТребования:\n- Документооборот должен существовать и быть доступен авторизованному пользователю.\n- Авторизация от лица грузоотправителя (`cargo_sender`).\n- Документооборот должен быть в статусе `draft` или `template`.", "operationId": "upload_title_1_body_from_xml_etrn_v1_docflows__docflow_id__titles_title_1_xml_put", "parameters": [ { "required": true, "schema": { "title": "Docflow Id", "type": "string" }, "name": "docflow_id", "in": "path", "description": "Идентификатор документооборота" }, { "required": false, "schema": { "title": "Send To Driver", "type": "boolean", "default": true }, "name": "send_to_driver", "in": "query", "description": "Отправка документа водителю" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_title_1_body_from_xml_etrn_v1_docflows__docflow_id__titles_title_1_xml_put" } } }, "required": true }, "responses": { "200": { "description": "Идентификатор документооборота", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocflowIdResponseSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Публичное API" ], "summary": "Генерация первого титула (XML-файл)", "description": "Генерирует первый титул из данных в черновике для подписи", "operationId": "generate_title_1_xml_etrn_v1_docflows__docflow_id__titles_title_1_xml_post", "parameters": [ { "required": true, "schema": { "title": "Docflow Id", "type": "string" }, "name": "docflow_id", "in": "path" }, { "description": "Проставляет headers для автоматического скачивания.", "required": false, "schema": { "title": "Export", "type": "boolean", "description": "Проставляет headers для автоматического скачивания.", "default": false }, "name": "export", "in": "query" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignatoryCredentialsGenerateSchema" } } }, "required": true }, "responses": { "200": { "description": "Successful Response" }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/epd/etrn/v1/docflows/{docflow_id}/participants": { "put": { "tags": [ "etrn" ], "summary": "Сохранение участников ЭТрН", "parameters": [ { "required": true, "schema": { "title": "Docflow Id", "type": "string" }, "name": "docflow_id", "in": "path" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateParticipantSchema" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocflowIdResponseSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_1/send": { "post": { "tags": [ "Публичное API" ], "summary": "Отправка первого титула", "description": "Отправка первого титула документооборота", "operationId": "send_title_1_etrn_v1_docflows__docflow_id__titles_title_1_send_post", "parameters": [ { "required": true, "schema": { "title": "Docflow Id", "type": "string" }, "name": "docflow_id", "in": "path", "description": "Идентификатор документооборота" } ], "requestBody": { "description": "XML файл документа и подпись документа в формате base64", "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_send_title_1_etrn_v1_docflows__docflow_id__titles_title_1_send_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocflowIdResponseSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/epd/etrn/v1/docflows/{docflow_id}/expeditor-docflow-from-docflow": { "post": { "tags": [ "etrn" ], "summary": "Создание экспедиторского документооборота из черновика документа", "description": "Создает экспедиторский документооборот из черновика документа.\n\nТребования:\n- Авторизация от лица отправителя документа (sender).\n- Документооборот должен существовать и документ должен быть доступен авторизованному пользователю.", "operationId": "create_expeditor_docflow_from_docflow_etrn_docflows__docflow_id__expeditor_docflow_from_docflow_post", "parameters": [ { "required": true, "schema": { "title": "Docflow Id", "type": "string", "description": "ID документооборота" }, "name": "docflow_id", "in": "path", "description": "ID документооборота" } ], "responses": { "201": { "description": "Идентификатор черновика экспедиторского документооборота", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocflowIdResponseSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/epd/etrn/v1/docflows/create-from-order-document": { "post": { "tags": [ "etrn" ], "summary": "Создание документооборота ЭТрН из документа-Заказа", "description": "Создает документооборот ЭТрН из документа-Заказа", "operationId": "create_docflow_from_order_document_etrn_docflows_create_from_order_document_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEtrnFromOrderDocumentSchema" } } }, "required": true }, "responses": { "201": { "description": "Идентификатор документооборота ЭТрН", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocflowIdResponseSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/epd/etrn/v1/docflows/{docflow_id}/copy-for-expeditor": { "post": { "tags": [ "etrn" ], "summary": "Копирование документооборота со сменой отправителя на экспедитора", "description": "Создает копию документооборота, в которой получатель документа (экспедитор) станет отправителем.\n\nТребования:\n- Авторизация от лица отправителя документа (sender)\n- Документооборот должен существовать и быть доступен авторизованному пользователю\n- Документооборот должен быть в статусе черновика\n- В документообороте должен быть указан получатель (receiver)\n- Документооборот должен быть сформирован для экспедитора и не должен быть отправлен экспедитору", "operationId": "copy_docflow_with_changed_sender_etrn_docflows__docflow_id__copy_for_expeditor_post", "parameters": [ { "required": true, "schema": { "title": "Docflow Id", "type": "string", "description": "ID документооборота" }, "name": "docflow_id", "in": "path", "description": "ID документооборота" } ], "responses": { "201": { "description": "Идентификатор нового черновика документооборота", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocflowIdResponseSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_2": { "put": { "tags": [ "Публичное API" ], "summary": "Сохранение черновика второго титула", "description": "Редактирует второй титул документооборота", "operationId": "update_title_2_draft_etrn_v1_docflows__docflow_id__titles_title_2_put", "parameters": [ { "required": true, "schema": { "title": "Docflow Id", "type": "string" }, "name": "docflow_id", "in": "path", "description": "Идентификатор документооборота" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NullableTitle2DraftData" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocflowIdResponseSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_2/xml": { "put": { "tags": [ "Публичное API" ], "summary": "Сохранение черновика второго титула из XML-файла", "description": "Переносит данные из XML-файла второго титула в его черновик,\nполностью заменяя ранее сохранённые данные.\n\nТребования:\n- Документооборот должен существовать и быть доступен авторизованному пользователю.\n- Авторизация от лица перевозчика (`cargo_carrier`).\n- Документооборот должен быть в статусе `title_1_success`.", "operationId": "upload_title_2_body_from_xml_etrn_v1_docflows__docflow_id__titles_title_2_xml_put", "parameters": [ { "required": true, "schema": { "title": "Docflow Id", "type": "string" }, "name": "docflow_id", "in": "path", "description": "Идентификатор документооборота" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_title_2_body_from_xml_etrn_v1_docflows__docflow_id__titles_title_2_xml_put" } } }, "required": true }, "responses": { "200": { "description": "Идентификатор документооборота", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocflowIdResponseSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Публичное API" ], "summary": "Генерация второго титула (XML-файл)", "description": "Генерирует второй титул из данных в черновике для подписи", "operationId": "generate_title_2_xml_etrn_v1_docflows__docflow_id__titles_title_2_xml_post", "parameters": [ { "required": true, "schema": { "title": "Docflow Id", "type": "string" }, "name": "docflow_id", "in": "path" }, { "description": "Проставляет headers для автоматического скачивания.", "required": false, "schema": { "title": "Export", "type": "boolean", "description": "Проставляет headers для автоматического скачивания.", "default": false }, "name": "export", "in": "query" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignatoryCredentialsGenerateSchema" } } }, "required": true }, "responses": { "200": { "description": "Successful Response" }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_2/send": { "post": { "tags": [ "Публичное API" ], "summary": "Отправка второго титула", "description": "Отправка второго титула документооборота", "operationId": "send_title_2_etrn_v1_docflows__docflow_id__titles_title_2_send_post", "parameters": [ { "required": true, "schema": { "title": "Docflow Id", "type": "string" }, "name": "docflow_id", "in": "path", "description": "Идентификатор документооборота" } ], "requestBody": { "description": "XML файл документа и подпись документа в формате base64", "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_send_title_2_etrn_v1_docflows__docflow_id__titles_title_2_send_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocflowIdResponseSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_3": { "put": { "tags": [ "Публичное API" ], "summary": "Сохранение черновика третьего титула", "description": "Редактирует третий титул документооборота", "operationId": "update_title_3_draft_etrn_v1_docflows__docflow_id__titles_title_3_put", "parameters": [ { "required": true, "schema": { "title": "Docflow Id", "type": "string" }, "name": "docflow_id", "in": "path", "description": "Идентификатор документооборота" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NullableTitle3DraftData" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocflowIdResponseSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_3/xml": { "put": { "tags": [ "Публичное API" ], "summary": "Сохранение черновика третьего титула из XML-файла", "description": "Переносит данные из XML-файла третьего титула в его черновик,\nполностью заменяя ранее сохранённые данные.\n\nТребования:\n- Документооборот должен существовать и быть доступен авторизованному пользователю.\n- Авторизация от лица грузополучателя (`cargo_receiver`).\n- Документооборот должен быть в статусе `title_2_success`, `title_7_success` или `title_8_success`.", "operationId": "upload_title_3_body_from_xml_etrn_v1_docflows__docflow_id__titles_title_3_xml_put", "parameters": [ { "required": true, "schema": { "title": "Docflow Id", "type": "string" }, "name": "docflow_id", "in": "path", "description": "Идентификатор документооборота" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_title_3_body_from_xml_etrn_v1_docflows__docflow_id__titles_title_3_xml_put" } } }, "required": true }, "responses": { "200": { "description": "Идентификатор документооборота", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocflowIdResponseSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Публичное API" ], "summary": "Генерация третьего титула (XML-файл)", "description": "Генерирует третий титул из данных в черновике для подписи", "operationId": "generate_title_3_xml_etrn_v1_docflows__docflow_id__titles_title_3_xml_post", "parameters": [ { "required": true, "schema": { "title": "Docflow Id", "type": "string" }, "name": "docflow_id", "in": "path" }, { "description": "Проставляет headers для автоматического скачивания.", "required": false, "schema": { "title": "Export", "type": "boolean", "description": "Проставляет headers для автоматического скачивания.", "default": false }, "name": "export", "in": "query" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignatoryCredentialsGenerateSchema" } } }, "required": true }, "responses": { "200": { "description": "Successful Response" }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_3/send": { "post": { "tags": [ "Публичное API" ], "summary": "Отправка третьего титула", "description": "Отправка третьего титула документооборота", "operationId": "send_title_3_etrn_v1_docflows__docflow_id__titles_title_3_send_post", "parameters": [ { "required": true, "schema": { "title": "Docflow Id", "type": "string" }, "name": "docflow_id", "in": "path", "description": "Идентификатор документооборота" } ], "requestBody": { "description": "XML файл документа и подпись документа в формате base64", "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_send_title_3_etrn_v1_docflows__docflow_id__titles_title_3_send_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocflowIdResponseSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_4": { "put": { "tags": [ "Публичное API" ], "summary": "Сохранение черновика четвёртого титула", "description": "Редактирует четвёртый титул документооборота", "operationId": "update_title_4_draft_etrn_v1_docflows__docflow_id__titles_title_4_put", "parameters": [ { "required": true, "schema": { "title": "Docflow Id", "type": "string" }, "name": "docflow_id", "in": "path", "description": "Идентификатор документооборота" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NullableTitle4DraftData" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocflowIdResponseSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_4/xml": { "put": { "tags": [ "Публичное API" ], "summary": "Сохранение черновика четвёртого титула из XML-файла", "description": "Переносит данные из XML-файла четвёртого титула в его черновик,\nполностью заменяя ранее сохранённые данные.\n\nТребования:\n- Документооборот должен существовать и быть доступен авторизованному пользователю.\n- Авторизация от лица перевозчика (`cargo_carrier`).\n- Документооборот должен быть в статусе `title_3_success`.", "operationId": "upload_title_4_body_from_xml_etrn_v1_docflows__docflow_id__titles_title_4_xml_put", "parameters": [ { "required": true, "schema": { "title": "Docflow Id", "type": "string" }, "name": "docflow_id", "in": "path", "description": "Идентификатор документооборота" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_title_4_body_from_xml_etrn_v1_docflows__docflow_id__titles_title_4_xml_put" } } }, "required": true }, "responses": { "200": { "description": "Идентификатор документооборота", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocflowIdResponseSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "post": { "tags": [ "Публичное API" ], "summary": "Генерация четвёртого титула (XML-файл)", "description": "Генерирует четвёртый титул из данных в черновике для подписи", "operationId": "generate_title_4_xml_etrn_v1_docflows__docflow_id__titles_title_4_xml_post", "parameters": [ { "required": true, "schema": { "title": "Docflow Id", "type": "string" }, "name": "docflow_id", "in": "path" }, { "description": "Проставляет headers для автоматического скачивания.", "required": false, "schema": { "title": "Export", "type": "boolean", "description": "Проставляет headers для автоматического скачивания.", "default": false }, "name": "export", "in": "query" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SignatoryCredentialsGenerateSchema" } } }, "required": true }, "responses": { "200": { "description": "Successful Response" }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/epd/etrn/v1/docflows/{docflow_id}/titles/title_4/send": { "post": { "tags": [ "Публичное API" ], "summary": "Отправка четвёртого титула", "description": "Отправка четвёртого титула документооборота", "operationId": "send_title_4_etrn_v1_docflows__docflow_id__titles_title_4_send_post", "parameters": [ { "required": true, "schema": { "title": "Docflow Id", "type": "string" }, "name": "docflow_id", "in": "path", "description": "Идентификатор документооборота" } ], "requestBody": { "description": "XML файл документа и подпись документа в формате base64", "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_send_title_4_etrn_v1_docflows__docflow_id__titles_title_4_send_post" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocflowIdResponseSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/epd/etrn/v1/docflows/{docflow_id}/observers": { "post": { "tags": [ "etrn" ], "summary": "Добавление наблюдателя", "description": "Добавляет наблюдателя в документооборот.", "operationId": "add_observer_etrn_v1_docflows__docflow_id__observers_post", "parameters": [ { "required": true, "schema": { "title": "Docflow Id", "type": "string", "description": "ID документооборота" }, "name": "docflow_id", "in": "path", "description": "ID документооборота" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserData" } } }, "required": true }, "responses": { "200": { "description": "ID документооборота", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocflowIdResponseSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "delete": { "tags": [ "etrn" ], "summary": "Удаление наблюдателя", "operationId": "remove_observer_etrn_v1_docflows__docflow_id__observers_delete", "parameters": [ { "required": true, "schema": { "title": "Docflow Id", "type": "string", "description": "ID документооборота" }, "name": "docflow_id", "in": "path", "description": "ID документооборота" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserData" } } }, "required": true }, "responses": { "204": { "description": "Successful Response" }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/epd/users/v1/participants": { "get": { "tags": [ "etrn" ], "summary": "Поиск участников по ИНН", "parameters": [ { "required": true, "schema": { "title": "Inn", "type": "string" }, "name": "inn", "in": "query" }, { "required": false, "schema": { "allOf": [ { "$ref": "#/components/schemas/AstralStandsEnum" } ], "default": "real" }, "name": "astral_stand", "in": "query" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "title": "Response Search Users By Inn Etrn Participants Get", "type": "array", "items": { "$ref": "#/components/schemas/UserHitSchema" } } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/epd/etrn/v1/docflows/{docflow_id}": { "get": { "tags": [ "etrn" ], "summary": "Получение метаинформации по ЭТрН", "parameters": [ { "required": true, "schema": { "title": "Docflow Id", "type": "string" }, "name": "docflow_id", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocflowMetaSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/epd/etrn/v1/docflows/{docflow_id}/files/{doc_type}": { "post": { "tags": [ "etrn" ], "summary": "Получение ключа доступа для скачивания печатной формы и QR-кода", "parameters": [ { "required": true, "schema": { "$ref": "#/components/schemas/GenerateDocData" }, "name": "doc_type", "in": "path" }, { "required": true, "schema": { "title": "Docflow Id", "type": "string" }, "name": "docflow_id", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileIdResponseSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/epd/etrn/v1/docflows/{docflow_id}/files/{file_key}": { "get": { "tags": [ "etrn" ], "summary": "Скачивание файлов печатной формы и QR-кода", "parameters": [ { "required": true, "schema": { "title": "File Key", "type": "string" }, "name": "file_key", "in": "path" }, { "required": true, "schema": { "title": "Docflow Id", "type": "string" }, "name": "docflow_id", "in": "path" } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/formalized-invoices/v4/docflows": { "post": { "tags": [ "Документообороты ФС (public)" ], "summary": "Создание документооборота", "description": "Создает новый документооборот", "operationId": "create_docflow_v4_docflows_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocflowInputSchema" } } }, "required": true }, "responses": { "201": { "description": "ID документооборота", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocflowIDSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "baggage": [] } ] } }, "/gw/formalized-invoices/v4/docflows/{docflow_id}/meta": { "get": { "tags": [ "Документообороты ФС (public)" ], "summary": "Получение метаданных документооборота", "description": "Возвращает метаданные документооборота и выставляет признак прочтения документооборота.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Если документ в статусе черновика, то авторизация должна быть от лица отправителя документа (sender).
• Если документ в любом другом статусе, то вызов метода доступен как отправителю документа (sender), так и получателю (receiver).", "operationId": "get_docflow_meta_and_mark_as_read_v4_docflows__docflow_id__meta_get", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "responses": { "200": { "description": "Обогащенные метаданные документооборота", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrichedDocflowMetaSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Документообороты ФС (public)" ], "summary": "Обновление метаданных документооборота", "description": "Обновляет метаданные документооборота.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Авторизация от лица отправителя документа (sender).", "operationId": "update_docflow_meta_v4_docflows__docflow_id__meta_put", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocflowInputSchema" } } } }, "responses": { "204": { "description": "Успешное обновление метаданных документооборота формализованного счёта" }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/formalized-invoices/v4/docflows/{docflow_id}/draft": { "get": { "tags": [ "Документообороты ФС (public)" ], "summary": "Получение черновика документооборота", "description": "Возвращает черновик документооборота.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Авторизация от лица отправителя документа (sender).
• Документ должен иметь статус черновика.", "operationId": "get_docflow_draft_v4_docflows__docflow_id__draft_get", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "responses": { "200": { "description": "Черновик документооборота", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TitleV501NullableSchema-Output", "nullable": true, "title": "Response Get Docflow Draft V4 Docflows Docflow Id Draft Get" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Документообороты ФС (public)" ], "summary": "Обновление черновика документооборота", "description": "Обновляет черновик документооборота.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Авторизация от лица отправителя документа (sender).
• Документ должен иметь статус черновика.", "operationId": "update_docflow_draft_v4_docflows__docflow_id__draft_put", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TitleV501NullableSchema-Input" } } } }, "responses": { "204": { "description": "Успешное обновление черновика документоборота формализованного счёта" }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/formalized-invoices/v4/docflows/{docflow_id}/documents/title-1/xml": { "get": { "tags": [ "Документы ФС (public)" ], "summary": "Получение XML-файла титула продавца", "description": "Возвращает XML титула продавца.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.", "operationId": "get_title_1_body_as_xml_v4_docflows__docflow_id__documents_title_1_xml_get", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "responses": { "200": { "description": "XML-файл титула продавца", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/edo_orchestrator/v4/docflow-types/fs/docflows/{docflow_id}/documents/title-1/send": { "post": { "tags": [ "Отправка документов (public)" ], "summary": "Отправка титула продавца формализованного счёта", "description": "Отправляет титул продавца формализованного счета в рамках документооборота.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Авторизация от лица отправителя документа (sender).", "operationId": "send_fs_title_1_document_v4_docflow_types_fs_docflows__docflow_id__documents_title_1_send_post", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_send_fs_title_1_document_v4_docflow_types_fs_docflows__docflow_id__documents_title_1_send_post" } } } }, "responses": { "204": { "description": "Успешная отправка титула продавца формализованного счёта" }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/formalized-invoices/v4/docflows/{docflow_id}/documents/title-1-read-confirmation": { "post": { "tags": [ "Документы ФС (public)" ], "summary": "Создание извещения о получении документа", "description": "Создает извещение о получении (ИОП) документа.\nГенерация выполняется в системе служебных документов.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Авторизация от лица получателя документа (receiver).
• Документооборот должен находиться в статусе \"waiting_for_read_confirmation\".", "operationId": "create_title_1_read_confirmation_v4_docflows__docflow_id__documents_title_1_read_confirmation_post", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuxDocumentInputSchema" } } } }, "responses": { "200": { "description": "Файл Извещения о получении документа", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/edo_orchestrator/v4/docflow-types/fs/docflows/{docflow_id}/documents/title-1-read-confirmation/send": { "post": { "tags": [ "Отправка документов (public)" ], "summary": "Отправка извещения о получении титула продавца формализованного счёта", "description": "Отправляет извещение о получении титула продавца формализованного счета.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Авторизация от лица получателя документа (receiver).", "operationId": "send_fs_title_1_read_confirmation_document_v4_docflow_types_fs_docflows__docflow_id__documents_title_1_read_confirmation_send_post", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_send_fs_title_1_read_confirmation_document_v4_docflow_types_fs_docflows__docflow_id__documents_title_1_read_confirmation_send_post" } } } }, "responses": { "204": { "description": "Успешная отправка извещения о получении титула продавца формализованного счёта" }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/formalized-invoices/v4/docflows/{docflow_id}/documents/title-1-clarification-notification": { "post": { "tags": [ "Документы ФС (public)" ], "summary": "Создание Уведомления об уточнении документа", "description": "Создает Уведомление об уточнении (УОУ) документа.\nГенерация выполняется в системе служебных документов.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Авторизация от лица получателя документа (receiver).
• Документооборот должен находиться в статусе \"waiting_for_read_confirmation\" или \"done\".", "operationId": "create_title_1_clarification_notification_v4_docflows__docflow_id__documents_title_1_clarification_notification_post", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuxDocumentInputSchema" } } } }, "responses": { "200": { "description": "Файл Уведомления об уточнении документа", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/edo_orchestrator/v4/docflow-types/fs/docflows/{docflow_id}/documents/title-1-clarification-notification/send": { "post": { "tags": [ "Отправка документов (public)" ], "summary": "Отправка уведомления об уточнении титула продавца формализованного счёта", "description": "Отправляет уведомление об уточнении титула продавца формализованного счета.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Авторизация от лица получателя документа (receiver).", "operationId": "send_fs_title_1_clarification_notification_v4_docflow_types_fs_docflows__docflow_id__documents_title_1_clarification_notification_send_post", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_send_fs_title_1_clarification_notification_v4_docflow_types_fs_docflows__docflow_id__documents_title_1_clarification_notification_send_post" } } } }, "responses": { "204": { "description": "Успешная отправка уведомления об уточнении титула продавца формализованного счёта" }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/formalized-invoices/v4/docflows/{docflow_id}/history": { "get": { "tags": [ "Документообороты ФС (public)" ], "summary": "Получение истории документооборота", "description": "Возвращает историю изменений статусов документооборота.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.", "operationId": "get_docflow_history_v4_docflows__docflow_id__history_get", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "responses": { "200": { "description": "История изменений статусов документооборота", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/HistoryRecordData" }, { "$ref": "#/components/schemas/HadesHistoryRecordData" } ] }, "title": "Response Get Docflow History V4 Docflows Docflow Id History Get" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/formalized-invoices/v4/docflows/{docflow_id}/documents/title-1/body": { "get": { "tags": [ "Документы ФС (public)" ], "summary": "Получение тела титула продавца", "description": "Возвращает тело титула продавца.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.", "operationId": "get_title_1_body_v4_docflows__docflow_id__documents_title_1_body_get", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "responses": { "200": { "description": "Тело титула продавца", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TitleV501FullSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/formalized-invoices/v4/docflows/{docflow_id}/original": { "get": { "tags": [ "Документообороты ФС (public)" ], "summary": "Получение XML-оригинала документа", "description": "Возвращает XML-оригинал документа.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Документооборот не должен быть в статусе черновика.", "operationId": "download_docflow_original_v4_docflows__docflow_id__original_get", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "responses": { "200": { "description": "XML-оригинал документа", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/formalized-invoices/v4/docflows/{docflow_id}/pdf": { "get": { "tags": [ "Документообороты ФС (public)" ], "summary": "Скачивание PDF-файла документа", "description": "Возвращает PDF-файл документа.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Документооборот не должен быть в статусе черновика.", "operationId": "get_docflow_pdf_v4_docflows__docflow_id__pdf_get", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "responses": { "200": { "description": "PDF-файл документа", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1.0/atidocs/documents/": { "post": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentUpdateResult" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/DocumentUpdateResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DocumentUpdateResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentUpdateResult" } } }, "description": "Результат запроса" } }, "tags": [ "Document" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentData" } } } }, "summary": "Создание и/или сохранение документа" } }, "/gw/atidocs/api/2.0/documents/{doc_id}/attachments/": { "post": { "tags": [ "Document" ], "summary": "Сохранить вложение", "parameters": [ { "in": "path", "name": "doc_id", "required": true, "schema": { "type": "string" }, "description": "id документа" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file_upload": { "type": "string", "format": "binary" } } } } } }, "responses": { "200": { "description": "Данные получены", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "result": { "type": "string", "description": "id документа" } } } } } }, "404": { "description": "Документ не найден", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "not_found" }, "reason": { "type": "string", "example": "Объект не найден" } } } } } } } } }, "/gw/atidocs/api/2.0/documents/{doc_id}/send/": { "put": { "tags": [ "Document" ], "summary": "Отправить документ", "parameters": [ { "in": "path", "name": "doc_id", "required": true, "schema": { "type": "string" }, "description": "id документа" }, { "in": "query", "name": "receiver", "required": true, "schema": { "type": "string" }, "description": "Код пользователя в ATI.SU в формате <код фирмы>." } ], "responses": { "200": { "description": "Документ отправлен", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "result": { "type": "string", "description": "id документа" } } } } } }, "400": { "description": "Не найден аккаунт получателя", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "document_no_receiver" }, "reason": { "type": "string", "example": "Не найден аккаунт получателя" } } } } } }, "404": { "description": "Объект не найден", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "not_found" }, "reason": { "type": "string", "example": "Документ не найден" } } } } } } } } }, "/gw/atidocs/api/2.0/documents/{doc_id}/export/": { "post": { "tags": [ "Document" ], "summary": "Экспорт документа для подписи", "description": "Аттачмент документа преобразуется в base64 строку для того, чтобы подписать документ.", "parameters": [ { "in": "path", "name": "doc_id", "required": true, "schema": { "type": "string" }, "description": "id документа" } ], "responses": { "200": { "description": "Документ экспортирован", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "result": { "type": "string", "description": "id документа" } } } } } }, "404": { "description": "Документ не найден", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "example": true }, "reason": { "type": "string", "example": "Документ не найден" } } } } } } } } }, "/v1.0/atidocs/documents/{doc_id}/sign/": { "put": { "parameters": [ { "description": "Идентификатор документа", "in": "path", "name": "doc_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentUpdateResult" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/DocumentUpdateResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DocumentUpdateResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentUpdateResult" } } }, "description": "Результат запроса" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/doki__ErrorResponse" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/doki__ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/doki__ErrorResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/doki__ErrorResponse" } } }, "description": "Ошибка при подписании документа." } }, "tags": [ "Document" ], "description": "Для подписания документа следует использовать строку, которую вернул метод экспорта\nдокумента. При подписании сервер выполняет проверку подписи: сертификат клиента должен\nбыть выдан доверенным УЦ. \n\nЕсли документ требовал решения, то документ автоматически одобряется.\n", "requestBody": { "content": { "application/json": { "schema": { "properties": { "sign": { "description": "Подпись документа в виде base64-строки", "type": "string" } }, "type": "object" } }, "application/xml": { "schema": { "properties": { "sign": { "description": "Подпись документа в виде base64-строки", "type": "string", "format": "binary" } }, "type": "object" } }, "multipart/form-data": { "schema": { "properties": { "sign": { "description": "Подпись документа в виде base64-строки", "type": "string", "format": "binary" } }, "type": "object" } }, "text/plain": { "schema": { "properties": { "sign": { "description": "Подпись документа в виде base64-строки", "type": "string" } }, "type": "object" } } }, "description": "Объект с подписью документа в виде строки, кодированной в base64." }, "summary": "Подписание документа" } }, "/gw/atidocs/api/2.0/documents/{doc_id}/comments/": { "post": { "tags": [ "Document" ], "summary": "Оставить комментарий к документу", "parameters": [ { "in": "path", "name": "doc_id", "required": true, "schema": { "type": "string" }, "description": "id документа" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "comment-text": { "type": "string" } } } } } }, "responses": { "200": { "description": "Список комментариев", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Comment2" } } } }, "400": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "bad_request" }, "reason": { "type": "string", "example": "Нельзя отправить пустой комментарий" } } } } } }, "404": { "description": "Объект не найден", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "not_found" }, "reason": { "type": "string", "description": "Документ не найден" } } } } } } } } }, "/gw/atidocs/api/2.0/documents/{doc_id}/revoke/": { "put": { "tags": [ "Document" ], "summary": "Отозвать отправленный документ и сделать его черновиком", "parameters": [ { "in": "path", "name": "doc_id", "required": true, "schema": { "type": "string" }, "description": "id документа" } ], "responses": { "200": { "description": "Документ отозван", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "result": { "type": "string", "description": "id документа" } } } } } }, "400": { "description": "Не указана причина отзыва документа", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "example": true }, "reason": { "type": "string", "example": "Не указана причина отзыва документа" } } } } } }, "404": { "description": "Документ не найден", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "boolean", "example": true }, "reason": { "type": "string", "example": "Документ не найден" } } } } } } } } }, "/gw/atidocs/api/2.0/documents/{doc_id}/": { "get": { "parameters": [ { "description": "Идентификатор документа", "in": "path", "name": "doc_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "example": { "ok": true, "result": { "doctype": "Тип документа", "sender": { "ati_id": "0", "name": "Имя", "user": { "ati_id": "0", "name": "Имя пользователя", "department_id": "0" }, "status": "Статус документа", "inn": "" }, "receiver": { "ati_id": "0", "name": "Имя", "user": { "ati_id": "0", "name": "Имя пользователя", "department_id": "0" }, "status": "Статус документа" }, "file": { "mimetype": "application/vnd.ati-docs.xml", "name": "000.xml", "xml_template": "order", "timestamp": "2022-06-30T12:44:30Z", "size": 9659, "id": "00000" }, "id": "00000", "date": "2022-06-30", "number": "1", "updated": "2022-06-30T12:44:28Z", "fix_price": { "id": "00000", "link": "", "original_owner": "0", "contact_1": "0", "contact_2": "", "document_creator": "0" }, "flags": [ "is_sent", "is_waiting", "can_be_deleted", "can_be_archived", "can_be_signed", "can_be_declined", "can_be_revoked", "can_be_templated" ] } }, "properties": { "ok": { "$ref": "#/components/schemas/OkResult" }, "result": { "$ref": "#/components/schemas/Documents" } }, "type": "object" } } }, "description": "Сведения о документе" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFoundError" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/NotFoundError" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NotFoundError" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/NotFoundError" } } }, "description": "Документ не найден" } }, "tags": [ "Document" ], "description": "Данные о документе по его идентификатору\n", "operationId": "GetDocumentInfo2", "summary": "Получение документа" } }, "/gw/atidocs/api/2.0/documents/{doc_id}/approve/": { "put": { "tags": [ "Document" ], "summary": "Одобрить документ", "parameters": [ { "in": "path", "name": "doc_id", "required": true, "schema": { "type": "string" }, "description": "id документа" } ], "responses": { "200": { "description": "Документ одобрен", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "result": { "type": "string", "description": "id документа" } } } } } }, "400": { "description": "Документ не может быть одобрен", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "document_can_not_be_approved" }, "reason": { "type": "string", "example": "Документ не может быть одобрен" } } } } } }, "404": { "description": "Документ не найден", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "not_found" }, "reason": { "type": "string", "description": "Объект не найден" } } } } } } } } }, "/gw/atidocs/api/2.0/documents/{doc_id}/decline/": { "put": { "tags": [ "Document" ], "summary": "Отклонить документ", "parameters": [ { "in": "path", "name": "doc_id", "required": true, "schema": { "type": "string" }, "description": "id документа" } ], "requestBody": { "content": { "application/json": { "schema": { "properties": { "reason": { "description": "Текст комментария", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Документ отклонен", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "result": { "type": "string", "description": "id документа" } } } } } }, "400": { "description": "Документ не может быть одобрен", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "document_can_not_be_changed" }, "reason": { "type": "string", "example": "Документ невозможно изменить, так как вторая сторона приняла по нему решение. Обновите страницу, чтобы продолжить работу" } } } } } }, "404": { "description": "Документ не найден", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "description": "not_found" }, "reason": { "type": "string", "description": "Объект не найден" } } } } } } } } }, "/gw/atidocs/api/2.0/documents/{doc_id}/attachments/{attachment_id}/": { "get": { "tags": [ "Document" ], "summary": "Получить вложение по id документа", "parameters": [ { "in": "path", "name": "doc_id", "required": true, "schema": { "type": "string" }, "description": "id документа" }, { "in": "path", "name": "attachment_id", "required": true, "schema": { "type": "string" }, "description": "id вложения" } ], "responses": { "200": { "description": "Данные получены", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "404": { "description": "Объект не найден", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "not_found" }, "reason": { "type": "string", "example": "Документ не найден" } } } } } } } } }, "/v1.0/atidocs/documents/{doc_id}/zip_archive/": { "get": { "parameters": [ { "description": "Идентификатор документа", "in": "path", "name": "doc_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ZIP-архив" } }, "tags": [ "Document" ], "summary": "Скачать zip-архив документа с вложениями и подписями" } }, "/gw/atidocs/api/2.0/documents": { "post": { "tags": [ "Document" ], "summary": "Создание и/или сохранение документа", "parameters": [ { "in": "query", "name": "id", "required": false, "schema": { "type": "string" }, "description": "ID документа" }, { "in": "query", "name": "doc_sender_contact", "required": true, "schema": { "type": "string" }, "description": "ID контакта отправителя" }, { "in": "query", "name": "doc_recipient_contact", "required": true, "schema": { "type": "string" }, "description": "ID контакта получателя" }, { "in": "query", "name": "doc_recipient_id", "required": true, "schema": { "type": "string" }, "description": "ID фирмы получателя" }, { "in": "query", "name": "doc_request", "required": true, "schema": { "type": "boolean" }, "description": "Флаг, требуется ли запрос решения по документу" }, { "in": "query", "name": "doctype", "required": true, "schema": { "type": "string", "enum": [ "акт", "доверенность", "договор", "заказ", "заказ (табличный вид)", "заявка (к договору)", "заявка к договору (табличный вид)", "поручение экспедитору", "счет", "другой" ] }, "description": "Тип документа" }, { "in": "query", "name": "is_formal", "required": true, "schema": { "type": "boolean" }, "description": "Флаг, является ли документ формализованным" }, { "in": "query", "name": "version", "required": true, "schema": { "type": "string" }, "description": "Версия формата документа" }, { "in": "query", "name": "contract_number", "required": false, "schema": { "type": "string" }, "description": "Номер договора, к которому привязан документ" }, { "in": "query", "name": "contract_date", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Дата договора, к которому привязан документ в формате `YYYY-MM-DD`" }, { "in": "query", "name": "number", "required": false, "schema": { "type": "string" }, "description": "Номер документа" }, { "in": "query", "name": "date", "required": false, "schema": { "type": "string", "format": "date" }, "description": "Дата документа в формате `YYYY-MM-DD`" }, { "in": "query", "name": "description", "required": false, "schema": { "type": "string" }, "description": "Описание" }, { "in": "query", "name": "body", "required": false, "schema": { "type": "string" }, "description": "Формализованная часть документа" } ], "responses": { "200": { "description": "Документ отправлен", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "result": { "type": "string", "description": "id документа" } } } } } }, "400": { "description": "Некорректный запрос" }, "404": { "description": "Документ не найден" } } } }, "/gw/native_informal_documents/v4/documents/{document_id}/roaming-participants": { "put": { "tags": [ "Документы (public)" ], "summary": "Обновление роуминговых участников документооборота", "description": "Обновляет данные о роуминговых участниках документооборота.\n\nТребования:
• Документ должен существовать в системе.
• Авторизация от лица отправителя (sender) документа.", "operationId": "update_roaming_participants_v4_documents__document_id__roaming_participants_put", "security": [ { "api-secret": [] }, { "user-id": [] }, { "client-name": [] } ], "parameters": [ { "name": "document_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документа", "title": "Document Id" }, "description": "ID документа" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoamingParticipantsSchema" } } } }, "responses": { "200": { "description": "ID документа", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentIDSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Документы (public)" ], "summary": "Получение информации о роуминговых участниках документооборота", "description": "Возвращает данные об участниках документооборота, задействованных в роуминговом документообороте.\n\nТребования:
• Документ должен существовать в системе и быть доступен авторизованному пользователю.
• В зависимости от статуса документа к нему применяются следующие правила авторизации:\n - Если документ находится в статусе «Черновик», то вызов метода доступен только отправителю (sender)\n этого документа.\n - Если документ находится в любом другом статусе, то вызов метода доступен как отправителю (sender),\n так и получателю (receiver) документа.", "operationId": "get_roaming_participants_v4_documents__document_id__roaming_participants_get", "security": [ { "api-secret": [] }, { "user-id": [] }, { "client-name": [] } ], "parameters": [ { "name": "document_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документа", "title": "Document Id" }, "description": "ID документа" } ], "responses": { "200": { "description": "Информация о роуминговых участниках документооборота", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RoamingParticipantsSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/native_informal_documents/v4/documents/{document_id}/convert-to-roaming": { "post": { "tags": [ "Документы (public)" ], "summary": "Конвертация документа в формат роуминга", "description": "Конвертирует документ в формат роуминга и регистрирует его в системе роуминговых документов.\n\nТребования:
• Исходный документ должен существовать и находиться в статусе, доступном для конвертации.
• Документ должен быть доступен авторизованному пользователю.
• Авторизация от лица отправителя (sender) исходного документа.", "operationId": "convert_to_roaming_v4_documents__document_id__convert_to_roaming_post", "security": [ { "api-secret": [] }, { "user-id": [] }, { "client-name": [] } ], "parameters": [ { "name": "document_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документа", "title": "Document Id" }, "description": "ID документа" } ], "responses": { "200": { "description": "ID документооборота в системе роуминговых документов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentIDSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/roaming_informal_documents/v4/docflows/{docflow_id}/body": { "get": { "tags": [ "Документообороты РНФ (public)" ], "summary": "Получение файла РНФ документа", "description": "Возвращает файл РНФ документа.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.", "operationId": "get_docflow_body_v4_docflows__docflow_id__body_get", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "edo-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "responses": { "200": { "description": "Файл РНФ документа", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/edo_orchestrator/v4/docflow-types/nf/docflows/{docflow_id}/documents/title-1/send": { "post": { "tags": [ "Отправка документов (public)" ], "summary": "Отправка роумингового неформализованного документа", "description": "Отправляет роуминговый неформализованный документ в рамках документооборота.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Авторизация от лица отправителя документа (sender).", "operationId": "send_rnf_title_1_document_v4_docflow_types_nf_docflows__docflow_id__documents_title_1_send_post", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_send_rnf_title_1_document_v4_docflow_types_nf_docflows__docflow_id__documents_title_1_send_post" } } } }, "responses": { "204": { "description": "Успешная отправка роумингового неформализованного документа" }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/roaming_informal_documents/v4/docflows": { "post": { "tags": [ "Документообороты РНФ (public)" ], "summary": "Создание документооборота", "description": "Создает новый документооборот", "operationId": "create_docflow_v4_docflows_post", "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_create_docflow_v4_docflows_post" } } }, "required": true }, "responses": { "201": { "description": "ID документооборота", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocflowIDSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "edo-id": [] }, { "baggage": [] } ] } }, "/gw/roaming_informal_documents/v4/docflows/{docflow_id}/meta": { "get": { "tags": [ "Документообороты РНФ (public)" ], "summary": "Получение метаданных документооборота", "description": "Возвращает обогащенные метаданные документооборота.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Если документ в статусе черновика, то авторизация должна быть от лица отправителя документа (sender).
• Если документ в любом другом статусе, то вызов метода доступен как отправителю документа (sender), так и получателю (receiver).", "operationId": "get_docflow_meta_v4_docflows__docflow_id__meta_get", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "edo-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "responses": { "200": { "description": "Обогащенные метаданные документооборота", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrichedDocflowMetaSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/roaming_informal_documents/v4/docflows/{docflow_id}/title-1-read-confirmation": { "post": { "tags": [ "Документообороты РНФ (public)" ], "summary": "Создание извещения о получении документа", "description": "Создает извещение о получении (ИОП) документа.\nГенерация выполняется в системе служебных документов.\n\nТребования:
• Документооборот должен существовать и документ должен быть подписан отправителем.
• Авторизация от лица получателя документа (receiver).", "operationId": "create_first_title_read_confirmation_v4_docflows__docflow_id__title_1_read_confirmation_post", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "edo-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuxDocumentInputSchema" } } } }, "responses": { "200": { "description": "Файл Извещения о получении документа", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/edo_orchestrator/v4/docflow-types/nf/docflows/{docflow_id}/documents/title-1-read-confirmation/send": { "post": { "tags": [ "Отправка документов (public)" ], "summary": "Отправка извещения о получении роумингового неформализованного документа", "description": "Отправляет извещение о получении роумингового неформализованного документа.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Авторизация от лица получателя документа (receiver).", "operationId": "send_rnf_title_1_read_confirmation_document_v4_docflow_types_nf_docflows__docflow_id__documents_title_1_read_confirmation_send_post", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_send_rnf_title_1_read_confirmation_document_v4_docflow_types_nf_docflows__docflow_id__documents_title_1_read_confirmation_send_post" } } } }, "responses": { "204": { "description": "Успешная отправка извещения о получении роумингового неформализованного документа" }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/edo_orchestrator/v4/docflow-types/nf/docflows/{docflow_id}/documents/title-2/send": { "post": { "tags": [ "Отправка документов (public)" ], "summary": "Подписание роумингового неформализованного документа получателем с использованием открепленной подписи", "description": "Подписывает роуминговый неформализованный документ от лица получателя с использованием открепленной подписи в рамках документооборота.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Авторизация от лица получателя документа (receiver).", "operationId": "send_rnf_title_2_document_v4_docflow_types_nf_docflows__docflow_id__documents_title_2_send_post", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_send_rnf_title_2_document_v4_docflow_types_nf_docflows__docflow_id__documents_title_2_send_post" } } } }, "responses": { "204": { "description": "Успешное подписание роумингового неформализованного документа от лица получателя с использованием открепленной подписи" }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/roaming_informal_documents/v4/docflows/{docflow_id}/clarification-notification": { "post": { "tags": [ "Документообороты РНФ (public)" ], "summary": "Создание Уведомления об уточнении документа", "description": "Создает Уведомление об уточнении (УОУ) документа.\nГенерация выполняется в системе служебных документов.\n\nТребования:
• Документооборот должен существовать и документ должен быть подписан отправителем.
• Авторизация от лица получателя документа (receiver).", "operationId": "create_clarification_notification_v4_docflows__docflow_id__clarification_notification_post", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "edo-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuxDocumentInputSchema" } } } }, "responses": { "200": { "description": "Файл Уведомления об уточнении документа", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/edo_orchestrator/v4/docflow-types/nf/docflows/{docflow_id}/documents/title-1-clarification-notification/send": { "post": { "tags": [ "Отправка документов (public)" ], "summary": "Отправка уведомления об уточнении роумингового неформализованного документа", "description": "Отправляет уведомление об уточнении роумингового неформализованного документа.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Авторизация от лица получателя документа (receiver).", "operationId": "send_rnf_title_1_clarification_notification_document_v4_docflow_types_nf_docflows__docflow_id__documents_title_1_clarification_notification_send_post", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_send_rnf_title_1_clarification_notification_document_v4_docflow_types_nf_docflows__docflow_id__documents_title_1_clarification_notification_send_post" } } } }, "responses": { "204": { "description": "Успешная отправка уведомления об уточнении роумингового неформализованного документа" }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/roaming_informal_documents/v4/docflows/{docflow_id}/history": { "get": { "tags": [ "Документообороты РНФ (public)" ], "summary": "Получение истории документооборота", "description": "Возвращает историю изменения статусов документооборота.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.", "operationId": "get_docflow_history_v4_docflows__docflow_id__history_get", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "edo-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "responses": { "200": { "description": "История изменений статусов документооборота", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/HistoryRecordData" }, { "$ref": "#/components/schemas/HadesHistoryRecordData" } ] }, "title": "Response Get Docflow History V4 Docflows Docflow Id History Get" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/roaming_informal_documents/v4/docflows/{docflow_id}/preview": { "get": { "tags": [ "Документообороты РНФ (public)" ], "summary": "Получение списка ID превью", "description": "Возвращает список ID превью.\n\nТребования:
• Расширение файла должно быть поддерживаемым для превью", "operationId": "get_docflow_preview_v4_docflows__docflow_id__preview_get", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "edo-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "responses": { "200": { "description": "Список ID превью", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PreviewResponseSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/upd/v4/docflows": { "post": { "tags": [ "Документообороты УПД (public)" ], "summary": "Создание документооборота", "description": "Создает новый документооборот", "operationId": "create_docflow_v4_docflows_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocflowInputSchema" } } }, "required": true }, "responses": { "201": { "description": "ID документооборота", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocflowIDSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } }, "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "edo-id": [] }, { "baggage": [] } ] } }, "/gw/upd/v4/docflows/{docflow_id}/meta": { "get": { "tags": [ "Документообороты УПД (public)" ], "summary": "Получение метаданных документооборота", "description": "Возвращает обогащенные метаданные документооборота и отмечает, что документооборот прочтен.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Если документ в статусе черновика, то авторизация должна быть от лица отправителя документа (sender).
• Если документ в любом другом статусе, то вызов метода доступен как отправителю документа (sender), так и получателю (receiver).", "operationId": "get_docflow_meta_and_mark_as_read_v4_docflows__docflow_id__meta_get", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "edo-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "responses": { "200": { "description": "Обогащенные метаданные документооборота", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnrichedDocflowMetaSchema" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Документообороты УПД (public)" ], "summary": "Обновление метаданных документооборота", "description": "Обновляет метаданные документооборота.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Авторизация от лица отправителя документа (sender).", "operationId": "update_docflow_meta_v4_docflows__docflow_id__meta_put", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "edo-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocflowUpdateSchema" } } } }, "responses": { "204": { "description": "Успешное обновление метаданных документооборота УПД" }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/upd/v4/docflows/{docflow_id}/draft": { "get": { "tags": [ "Документообороты УПД (public)" ], "summary": "Получение черновика документооборота", "description": "Возвращает черновик документооборота.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Авторизация от лица отправителя документа (sender).", "operationId": "get_docflow_draft_v4_docflows__docflow_id__draft_get", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "edo-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "responses": { "200": { "description": "Черновик документооборота", "content": { "application/json": { "schema": { "anyOf": [ { "oneOf": [ { "$ref": "#/components/schemas/UPDSellerTitleV501NullableSchema" }, { "$ref": "#/components/schemas/UPDSellerTitleV503NullableSchema" } ], "discriminator": { "propertyName": "верс_форм", "mapping": { "5.01": "#/components/schemas/UPDSellerTitleV501NullableSchema", "5.03": "#/components/schemas/UPDSellerTitleV503NullableSchema" } } }, { "type": "null" } ], "title": "Response Get Docflow Draft V4 Docflows Docflow Id Draft Get" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "put": { "tags": [ "Документообороты УПД (public)" ], "summary": "Обновление черновика документооборота", "description": "Обновляет черновик документооборота.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Авторизация от лица отправителя документа (sender).", "operationId": "update_docflow_draft_v4_docflows__docflow_id__draft_put", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "edo-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UPDSellerTitleV501NullableSchema" }, { "$ref": "#/components/schemas/UPDSellerTitleV503NullableSchema" } ], "discriminator": { "propertyName": "верс_форм", "mapping": { "5.01": "#/components/schemas/UPDSellerTitleV501NullableSchema", "5.03": "#/components/schemas/UPDSellerTitleV503NullableSchema" } }, "title": "Data" } } } }, "responses": { "204": { "description": "Успешное обновление черновика документооборота УПД" }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/upd/v4/docflows/{docflow_id}/documents/title-1/xml": { "put": { "tags": [ "Документы УПД (public)" ], "summary": "Обновление тела титула продавца из XML", "description": "Обновляет тело титула продавца из XML.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Авторизация от лица отправителя документа (sender).", "operationId": "upload_title_1_body_from_xml_for_accounting_v4_docflows__docflow_id__documents_title_1_xml_put", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "edo-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_upload_title_1_body_from_xml_for_accounting_v4_docflows__docflow_id__documents_title_1_xml_put" } } } }, "responses": { "204": { "description": "Успешное обновление из XML титула продавца УПД" }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } }, "get": { "tags": [ "Документы УПД (public)" ], "summary": "Получение XML титула продавца", "description": "Возвращает XML титула продавца.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.", "operationId": "get_title_1_body_as_xml_v4_docflows__docflow_id__documents_title_1_xml_get", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "edo-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "responses": { "200": { "description": "XML титула продавца", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/edo_orchestrator/v4/docflow-types/upd/docflows/{docflow_id}/documents/title-1/send": { "post": { "tags": [ "Отправка документов (public)" ], "summary": "Отправка титула продавца УПД", "description": "Отправляет титул продавца УПД в рамках документооборота.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Авторизация от лица отправителя документа (sender).", "operationId": "send_upd_title_1_document_v4_docflow_types_upd_docflows__docflow_id__documents_title_1_send_post", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_send_upd_title_1_document_v4_docflow_types_upd_docflows__docflow_id__documents_title_1_send_post" } } } }, "responses": { "204": { "description": "Успешная отправка титула продавца УПД" }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/upd/v4/docflows/{docflow_id}/documents/title-1-read-confirmation/xml": { "post": { "tags": [ "Документообороты УПД (public)" ], "summary": "Создание извещения о получении документа", "description": "Создает извещение о получении (ИОП) документа.\nГенерация выполняется в системе служебных документов.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Авторизация от лица получателя документа (receiver).", "operationId": "create_title_1_read_confirmation_v4_docflows__docflow_id__documents_title_1_read_confirmation_xml_post", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "edo-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuxDocumentInputSchema" } } } }, "responses": { "200": { "description": "Файл Извещения о получении документа", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/edo_orchestrator/v4/docflow-types/upd/docflows/{docflow_id}/documents/title-1-read-confirmation/send": { "post": { "tags": [ "Отправка документов (public)" ], "summary": "Отправка извещения о получении титула продавца УПД", "description": "Отправляет извещение о получении титула продавца УПД.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Авторизация от лица получателя документа (receiver).", "operationId": "send_upd_title_1_read_confirmation_v4_docflow_types_upd_docflows__docflow_id__documents_title_1_read_confirmation_send_post", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_send_upd_title_1_read_confirmation_v4_docflow_types_upd_docflows__docflow_id__documents_title_1_read_confirmation_send_post" } } } }, "responses": { "204": { "description": "Успешная отправка извещения о получении титула продавца УПД" }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/upd/v4/docflows/{docflow_id}/documents/title-2": { "put": { "tags": [ "Документы УПД (public)" ], "summary": "Создание титула покупателя", "description": "Создает титул покупателя.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Авторизация от лица получателя документа (receiver).", "operationId": "generate_title_2_v4_docflows__docflow_id__documents_title_2_put", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "edo-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UPDBuyerTitleV501NullableSchema" }, { "$ref": "#/components/schemas/UPDBuyerTitleV503NullableSchema" } ], "discriminator": { "propertyName": "верс_форм", "mapping": { "5.01": "#/components/schemas/UPDBuyerTitleV501NullableSchema", "5.03": "#/components/schemas/UPDBuyerTitleV503NullableSchema" } }, "title": "Data" } } } }, "responses": { "204": { "description": "Успешное создание титула покупателя УПД" }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/upd/v4/docflows/{docflow_id}/documents/title-2/xml": { "get": { "tags": [ "Документы УПД (public)" ], "summary": "Получение XML титула покупателя", "description": "Возвращает XML титула покупателя.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.", "operationId": "get_title_2_body_as_xml_v4_docflows__docflow_id__documents_title_2_xml_get", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "edo-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "responses": { "200": { "description": "XML титула покупателя", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/edo_orchestrator/v4/docflow-types/upd/docflows/{docflow_id}/documents/title-2/send": { "post": { "tags": [ "Отправка документов (public)" ], "summary": "Отправка титула покупателя УПД", "description": "Отправляет титул покупателя УПД в рамках документооборота.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Авторизация от лица получателя документа (receiver).", "operationId": "send_upd_title_2_document_v4_docflow_types_upd_docflows__docflow_id__documents_title_2_send_post", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_send_upd_title_2_document_v4_docflow_types_upd_docflows__docflow_id__documents_title_2_send_post" } } } }, "responses": { "204": { "description": "Успешная отправка титула покупателя УПД" }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/upd/v4/docflows/{docflow_id}/documents/title-1-clarification-notification/xml": { "post": { "tags": [ "Документы УПД (public)" ], "summary": "Создание Уведомления об уточнении документа", "description": "Создает Уведомление об уточнении (УОУ) документа.\nГенерация выполняется в системе служебных документов.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Авторизация от лица получателя документа (receiver).", "operationId": "create_title_1_clarification_notification_v4_docflows__docflow_id__documents_title_1_clarification_notification_xml_post", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "edo-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuxDocumentInputSchema" } } } }, "responses": { "200": { "description": "Файл Уведомления об уточнении документа", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/edo_orchestrator/v4/docflow-types/upd/docflows/{docflow_id}/documents/title-1-clarification-notification/send": { "post": { "tags": [ "Отправка документов (public)" ], "summary": "Отправка уведомления об уточнении титула продавца УПД", "description": "Отправляет уведомление об уточнении титула продавца УПД.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Авторизация от лица получателя документа (receiver).", "operationId": "send_upd_title_1_clarification_notification_v4_docflow_types_upd_docflows__docflow_id__documents_title_1_clarification_notification_send_post", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body_send_upd_title_1_clarification_notification_v4_docflow_types_upd_docflows__docflow_id__documents_title_1_clarification_notification_send_post" } } } }, "responses": { "204": { "description": "Успешная отправка уведомления об уточнении титула продавца УПД" }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/upd/v4/docflows/{docflow_id}/history": { "get": { "tags": [ "Документообороты УПД (public)" ], "summary": "Получение истории документооборота", "description": "Возвращает историю изменений статусов документооборота.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Если документ в статусе черновика, то авторизация должна быть от лица отправителя документа (sender).
• Если документ в любом другом статусе, то вызов метода доступен как отправителю документа (sender), так и получателю (receiver).", "operationId": "get_docflow_history_v4_docflows__docflow_id__history_get", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "edo-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "responses": { "200": { "description": "История изменений статусов документооборота", "content": { "application/json": { "schema": { "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/HistoryRecordData" }, { "$ref": "#/components/schemas/HadesHistoryRecordData" } ] }, "title": "Response Get Docflow History V4 Docflows Docflow Id History Get" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/upd/v4/docflows/{docflow_id}/documents/title-1/body": { "get": { "tags": [ "Документы УПД (public)" ], "summary": "Получение тела титула продавца", "description": "Возвращает тело титула продавца.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.", "operationId": "get_title_1_body_v4_docflows__docflow_id__documents_title_1_body_get", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "edo-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "responses": { "200": { "description": "Тело титула продавца", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UPDSellerTitleV501FullSchema" }, { "$ref": "#/components/schemas/UPDSellerTitleV503FullSchema" } ], "discriminator": { "propertyName": "верс_форм", "mapping": { "5.01": "#/components/schemas/UPDSellerTitleV501FullSchema", "5.03": "#/components/schemas/UPDSellerTitleV503FullSchema" } }, "title": "Response Get Title 1 Body V4 Docflows Docflow Id Documents Title 1 Body Get" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/upd/v4/docflows/{docflow_id}/documents/title-2/body": { "get": { "tags": [ "Документы УПД (public)" ], "summary": "Получение тела титула покупателя", "description": "Возвращает тело титула покупателя.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.", "operationId": "get_title_2_body_v4_docflows__docflow_id__documents_title_2_body_get", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "edo-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "responses": { "200": { "description": "Тело титула покупателя", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UPDBuyerTitleV501FullSchema" }, { "$ref": "#/components/schemas/UPDBuyerTitleV503FullSchema" } ], "discriminator": { "propertyName": "верс_форм", "mapping": { "5.01": "#/components/schemas/UPDBuyerTitleV501FullSchema", "5.03": "#/components/schemas/UPDBuyerTitleV503FullSchema" } }, "title": "Response Get Title 2 Body V4 Docflows Docflow Id Documents Title 2 Body Get" } } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/upd/v4/docflows/{docflow_id}/original": { "get": { "tags": [ "Документообороты УПД (public)" ], "summary": "Получение XML-оригинала документа", "description": "Возвращает XML-оригинал документа.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Документооборот не должен быть в статусе черновика.", "operationId": "download_docflow_original_v4_docflows__docflow_id__original_get", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "edo-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "responses": { "200": { "description": "XML-оригинал документа", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/upd/v4/docflows/{docflow_id}/pdf": { "get": { "tags": [ "Документообороты УПД (public)" ], "summary": "Скачивание PDF-файла документа", "description": "Возвращает PDF-файл документа.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Если документ в статусе черновика, то авторизация должна быть от лица отправителя документа (sender).
• Если документ в любом другом статусе, то вызов метода доступен как отправителю документа (sender), так и получателю (receiver).", "operationId": "get_docflow_pdf_v4_docflows__docflow_id__pdf_get", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "edo-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "responses": { "200": { "description": "PDF-файл документа", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/upd/v4/docflows/{docflow_id}/protocol/pdf": { "post": { "tags": [ "Документообороты УПД (public)" ], "summary": "Скачивание PDF-файла протокола документооборота", "description": "Возвращает PDF-файл протокола документооборота.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.
• Документооборот не должен быть в статусе черновика.", "operationId": "get_docflow_protocol_pdf_v4_docflows__docflow_id__protocol_pdf_post", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] }, { "edo-id": [] }, { "baggage": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentData" }, "title": "Related Documents Data" } } } }, "responses": { "200": { "description": "PDF-файл протокола документооборота", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/gw/edo_orchestrator/v4/docflow-types/upd/docflows/{docflow_id}/documents/zip": { "get": { "tags": [ "Отправка документов (public)" ], "summary": "Получение ZIP-архива УПД по документообороту", "description": "Возвращает ZIP-архив УПД по указанному документообороту.\n\nТребования:
• Документооборот должен существовать и быть доступен авторизованному пользователю.", "operationId": "get_upd_document_zip_v4_docflow_types_upd_docflows__docflow_id__documents_zip_get", "security": [ { "api-secret": [] }, { "client-name": [] }, { "user-id": [] } ], "parameters": [ { "name": "docflow_id", "in": "path", "required": true, "schema": { "type": "string", "description": "ID документооборота", "title": "Docflow Id" }, "description": "ID документооборота" } ], "responses": { "200": { "description": "ZIP-архив УПД по документообороту", "content": { "application/json": { "schema": {} } } }, "422": { "description": "Ошибка валидации", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } } } } } }, "/v1/filer/": { "post": { "tags": [ "Files" ], "summary": "Загружает файл в хранилище.", "operationId": "post_v1", "requestBody": { "description": "Форма multipart/form-data с файлом и полями метаданных.", "content": { "multipart/form-data": { "schema": { "required": [ "access_type", "business_type", "file" ], "type": "object", "properties": { "file": { "type": "string", "description": "Файл для загрузки.", "format": "binary" }, "access_type": { "enum": [ "Public", "Firm", "Contact", "Authorized" ], "type": "string", "description": "Тип доступа к файлу.\n- Public - Доступ всем без ограничений\n- Firm - Доступ в рамках фирмы\n- Contact - Доступ в рамках контакта\n- Authorized - Доступ для авторизованных пользователей", "default": "Public", "example": "Public" }, "business_type": { "enum": [ "FirmDocument", "Avatar", "Logo", "Load", "Orders", "CatalogsTrucks", "CatalogsDrivers", "InsurerPrivateDocument", "InsurerPublicDocument" ], "type": "string", "description": "Бизнес-тип файла (аватар, лого и т.д.), влияет на access_type и ограничения.\n- FirmDocument\n- Avatar\n- Logo\n- Load\n- Orders\n- CatalogsTrucks\n- CatalogsDrivers\n- InsurerPrivateDocument\n- InsurerPublicDocument" }, "delete_on": { "type": "string", "description": "Дата автоматического удаления.", "format": "date-time", "example": "2026-12-31T00:00:00Z" }, "with_watermark": { "type": "boolean", "description": "Добавить водяной знак.", "example": true }, "contact_id": { "type": "integer", "description": "Идентификатор контакта.", "format": "int32", "example": 42 }, "access_list": { "type": "array", "items": { "description": "Участник доступа к файлу: фирма и/или контакт.", "$ref": "#/components/schemas/UserAccess" }, "description": "Список доступа для типа AccessList." }, "file_key_2": { "type": "string", "description": "Внешний ключ файла.", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "binding_tag": { "type": "string", "description": "Тег привязки.", "example": "order-999" } }, "example": { "access_type": "Public", "business_type": "Common", "delete_on": "2026-12-31T00:00:00Z", "with_watermark": true, "contact_id": 42, "access_list": [ { "firm_id": 100500, "contact_id": 42 } ], "file_key_2": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "binding_tag": "order-999" } }, "example": { "access_type": "Public", "business_type": "Common", "delete_on": "2026-12-31T00:00:00Z", "with_watermark": true, "contact_id": 42, "access_list": [ { "firm_id": 100500, "contact_id": 42 } ], "file_key_2": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "binding_tag": "order-999" }, "encoding": { "file": { "style": "form" }, "access_type": { "style": "form" }, "business_type": { "style": "form" }, "delete_on": { "style": "form" }, "with_watermark": { "style": "form" }, "contact_id": { "style": "form" }, "access_list": { "style": "form" }, "file_key_2": { "style": "form" }, "binding_tag": { "style": "form" } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Документ файла.", "$ref": "#/components/schemas/FileInfoPublic" }, "example": { "file_key": "firm_100500_logo", "file_key2": "contact_42_avatar_copy", "file_name": "logo.png", "content_type": "image/png", "access_type": "Public", "file_business_type": "Logo", "add_date": "2026-03-31T09:00:00Z", "delete_on": "2026-12-31T00:00:00Z", "firm_id": 100500, "contact_id": 42, "with_watermark": true, "binding_tag": "order-999" } } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "402": { "description": "Метод доступен только платным пользователям.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "payment_required", "reason": "Метод доступен только платным пользователям." } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "504": { "description": "Сервер не ответил во время.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "timeout", "reason": "Сервер не ответил во время." } } } } } } }, "/v1/filer/{fileKey}": { "get": { "tags": [ "Files" ], "summary": "Получает файл по ключу.", "operationId": "get_v1__fileKey_", "parameters": [ { "name": "fileKey", "in": "path", "description": "Ключ файла.", "required": true, "schema": { "type": "string" }, "example": "firm_100500_logo" }, { "name": "height", "in": "query", "description": "Высота для ресайза.", "schema": { "type": "integer", "format": "int32" }, "example": 201 }, { "name": "width", "in": "query", "description": "Ширина для ресайза.", "schema": { "type": "integer", "format": "int32" }, "example": 302 }, { "name": "biggest-side", "in": "query", "description": "Максимальная сторона для ресайза.", "schema": { "type": "integer", "format": "int32" }, "example": 501 } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "format": "byte" } } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "402": { "description": "Метод доступен только платным пользователям.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "payment_required", "reason": "Метод доступен только платным пользователям." } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "504": { "description": "Сервер не ответил во время.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "timeout", "reason": "Сервер не ответил во время." } } } } } }, "delete": { "tags": [ "Files" ], "summary": "Удаляет файл или привязку по ключу файла.", "operationId": "delete_v1__fileKey_", "parameters": [ { "name": "fileKey", "in": "path", "description": "Ключ файла.", "required": true, "schema": { "type": "string" }, "example": "firm_100500_logo" }, { "name": "binding-tag", "in": "query", "description": "Тег привязки (обязателен при наличии привязок).", "schema": { "type": "string" }, "example": "order-999" } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "402": { "description": "Метод доступен только платным пользователям.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "payment_required", "reason": "Метод доступен только платным пользователям." } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "504": { "description": "Сервер не ответил во время.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "timeout", "reason": "Сервер не ответил во время." } } } } } } }, "/v1/filer/info": { "post": { "tags": [ "Files" ], "summary": "Получает список метаданных файлов по критериям.", "operationId": "post_v1_info", "requestBody": { "description": "Критерии поиска (FirmId, ContactId, Keys, AtiId и т.д.).", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileInfoRequestPublic" } ], "example": { "ati_id": "100500", "contact_id": 42, "business_type": "Avatar", "keys": [ "firm_100500_logo", "contact_42_avatar" ], "keys2": [ "firm_100500_logo_thumb" ] } }, "example": { "ati_id": "100500", "contact_id": 42, "business_type": "Avatar", "keys": [ "firm_100500_logo", "contact_42_avatar" ], "keys2": [ "firm_100500_logo_thumb" ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileInfoRequestPublic" } ], "example": { "ati_id": "100500", "contact_id": 42, "business_type": "Avatar", "keys": [ "firm_100500_logo", "contact_42_avatar" ], "keys2": [ "firm_100500_logo_thumb" ] } }, "example": { "ati_id": "100500", "contact_id": 42, "business_type": "Avatar", "keys": [ "firm_100500_logo", "contact_42_avatar" ], "keys2": [ "firm_100500_logo_thumb" ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileInfoRequestPublic" } ], "example": { "ati_id": "100500", "contact_id": 42, "business_type": "Avatar", "keys": [ "firm_100500_logo", "contact_42_avatar" ], "keys2": [ "firm_100500_logo_thumb" ] } }, "example": { "ati_id": "100500", "contact_id": 42, "business_type": "Avatar", "keys": [ "firm_100500_logo", "contact_42_avatar" ], "keys2": [ "firm_100500_logo_thumb" ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FileInfoRequestPublic" } ], "example": { "ati_id": "100500", "contact_id": 42, "business_type": "Avatar", "keys": [ "firm_100500_logo", "contact_42_avatar" ], "keys2": [ "firm_100500_logo_thumb" ] } }, "example": { "ati_id": "100500", "contact_id": 42, "business_type": "Avatar", "keys": [ "firm_100500_logo", "contact_42_avatar" ], "keys2": [ "firm_100500_logo_thumb" ] } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "description": "Документ файла.", "$ref": "#/components/schemas/FileInfoPublic" }, "example": [ { "file_key": "firm_100500_logo", "file_key2": "contact_42_avatar_copy", "file_name": "logo.png", "content_type": "image/png", "access_type": "Public", "file_business_type": "Logo", "add_date": "2026-03-31T09:00:00Z", "delete_on": "2026-12-31T00:00:00Z", "firm_id": 100500, "contact_id": 42, "with_watermark": true, "binding_tag": "order-999" } ] }, "example": [ { "file_key": "firm_100500_logo", "file_key2": "contact_42_avatar_copy", "file_name": "logo.png", "content_type": "image/png", "access_type": "Public", "file_business_type": "Logo", "add_date": "2026-03-31T09:00:00Z", "delete_on": "2026-12-31T00:00:00Z", "firm_id": 100500, "contact_id": 42, "with_watermark": true, "binding_tag": "order-999" } ] } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "402": { "description": "Метод доступен только платным пользователям.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "payment_required", "reason": "Метод доступен только платным пользователям." } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "504": { "description": "Сервер не ответил во время.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "timeout", "reason": "Сервер не ответил во время." } } } } } } }, "/v1/filer/{businessType}/{atiId}/{contactId}": { "get": { "tags": [ "Files" ], "summary": "Получает аватар или логотип по идентификатору atiId и опционально contactId.", "operationId": "get_v1__businessType__atiId__contactId_", "parameters": [ { "name": "atiId", "in": "path", "description": "Идентификатор фирмы.", "required": true, "schema": { "type": "string" }, "example": "100500" }, { "name": "businessType", "in": "path", "description": "Бизнес-тип (Avatar или Logo).", "required": true, "schema": { "enum": [ "Avatar", "Logo" ], "type": "string", "description": "Бизнес-тип файла (аватар, лого и т.д.), влияет на access_type и ограничения.\n- Avatar\n- Logo" }, "example": "Logo" }, { "name": "contactId", "in": "path", "description": "Идентификатор контакта (для аватара контакта).", "required": true, "schema": { "type": "integer", "format": "int32" }, "example": 42 }, { "name": "height", "in": "query", "description": "Высота для ресайза.", "schema": { "type": "integer", "format": "int32" }, "example": 201 }, { "name": "width", "in": "query", "description": "Ширина для ресайза.", "schema": { "type": "integer", "format": "int32" }, "example": 302 }, { "name": "biggest-side", "in": "query", "description": "Максимальная сторона для ресайза.", "schema": { "type": "integer", "format": "int32" }, "example": 501 }, { "name": "not-found-type", "in": "query", "description": "Поведение при отсутствии файла.\n- Default — вернуть дефолтное изображение (лого или аватар по контексту запроса).\n- Status — ответ с кодом 404.", "schema": { "enum": [ "Status", "Default" ], "allOf": [ { "$ref": "#/components/schemas/NotFoundType" } ], "description": "Поведение при отсутствии файла при запросе аватара или логотипа.", "default": "Default" }, "example": "Default" }, { "name": "fallback-img", "in": "query", "description": "Резервный тип, если запрошенного файла нет; имеет смысл при not-found-type = Default).\n- Avatar / Logo — сначала попытаться отдать файл этого типа.\n- Параметр не передан (null по умолчанию) — используется тот же тип, что в маршруте (`businessType`).", "schema": { "enum": [ "Avatar", "Logo" ], "type": "string", "description": "Резервный тип, если запрошенного файла нет; имеет смысл при not-found-type = Default).\n- Avatar\n- Logo" }, "example": "Avatar" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "format": "byte" } } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "402": { "description": "Метод доступен только платным пользователям.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "payment_required", "reason": "Метод доступен только платным пользователям." } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "504": { "description": "Сервер не ответил во время.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "timeout", "reason": "Сервер не ответил во время." } } } } } } }, "/v1/filer/{businessType}/default": { "get": { "tags": [ "Files" ], "summary": "Получает файл по умолчанию для аватара или логотипа.", "operationId": "get_v1__businessType__default", "parameters": [ { "name": "businessType", "in": "path", "description": "Бизнес-тип (Avatar или Logo).", "required": true, "schema": { "enum": [ "Avatar", "Logo" ], "type": "string", "description": "Бизнес-тип файла (аватар, лого и т.д.), влияет на access_type и ограничения.\n- Avatar\n- Logo" }, "example": "Avatar" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "string", "format": "byte" } } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "402": { "description": "Метод доступен только платным пользователям.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "payment_required", "reason": "Метод доступен только платным пользователям." } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "504": { "description": "Сервер не ответил во время.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "timeout", "reason": "Сервер не ответил во время." } } } } } } }, "/v1/filer/type/{businessType}": { "delete": { "tags": [ "Files" ], "summary": "Удаляет аватар или логотип по бизнес-типу.", "operationId": "delete_v1_type__businessType_", "parameters": [ { "name": "businessType", "in": "path", "description": "Бизнес-тип (Avatar или Logo).", "required": true, "schema": { "enum": [ "Avatar", "Logo" ], "type": "string", "description": "Бизнес-тип файла (аватар, лого и т.д.), влияет на access_type и ограничения.\n- Avatar\n- Logo" }, "example": "Avatar" }, { "name": "contact-id", "in": "query", "description": "Идентификатор контакта (для аватара контакта).", "schema": { "type": "integer", "format": "int32" }, "example": 42 } ], "responses": { "200": { "description": "OK" }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "402": { "description": "Метод доступен только платным пользователям.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "payment_required", "reason": "Метод доступен только платным пользователям." } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "504": { "description": "Сервер не ответил во время.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "timeout", "reason": "Сервер не ответил во время." } } } } } } }, "/avatars/": { "post": { "summary": "Загружает логотип фирмы или аватарку контакта", "parameters": [ { "name": "account", "in": "query", "schema": { "type": "string" }, "description": "Если этот параметр есть в строке запроса, то загружается\nлоготип фирмы\n" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "img": { "type": "string", "format": "binary", "description": "Тело файла" } }, "required": [ "img" ] } } } }, "responses": { "200": { "$ref": "#/components/responses/AvatarUploadInfo" }, "401": { "description": "Ошибка авторизации" } }, "tags": [ "avatars" ] }, "delete": { "summary": "Удаляет логотип фирмы или аватарку контакта", "parameters": [ { "name": "account", "in": "query", "schema": { "type": "string" }, "description": "Если этот параметр есть в строке запроса, то удаляется\nлоготип фирмы\n" } ], "responses": { "200": { "description": "Логотип/аватарка удалена" }, "401": { "description": "Ошибка авторизации" } }, "tags": [ "avatars" ] } }, "/avatars/logo": { "post": { "summary": "Загружает логотип фирмы", "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "img": { "type": "string", "format": "binary", "description": "Тело файла" } }, "required": [ "img" ] } } } }, "responses": { "200": { "$ref": "#/components/responses/AvatarUploadInfo" }, "401": { "description": "Ошибка авторизации" } }, "tags": [ "avatars" ] } }, "/v1.0/filestorage/files/": { "post": { "summary": "Загрузить файл в хранилище", "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "firms": { "type": "string", "description": "Список фирм, имеющих доступ к этому документу" }, "rawBody": { "type": "string", "format": "binary", "description": "Тело файла" } } } } } }, "responses": { "200": { "description": "Информация о файле - id", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "description": "Идентификатор успешности запроса" }, "result": { "type": "object", "properties": { "id": { "type": "string", "description": "Идентификатор файла" }, "fileName": { "type": "string", "description": "Имя файла" }, "size": { "type": "integer", "description": "Размер файла в байтах" }, "mimetype": { "type": "string", "description": "Тип файла" }, "link": { "type": "string", "description": "Ссылка на файл для скачивания" } } } } } } } }, "400": { "description": "Отсутствует файл в поле rawBody, или Отправлен пустой файл" }, "401": { "description": "Ошибка авторизации" } }, "tags": [ "files" ] } }, "/v1.0/filestorage/files/multiple": { "post": { "summary": "Загрузить несколько файлов в хранилище", "requestBody": { "description": "Загружаемые файлы", "content": { "multipart/form-data": { "schema": { "properties": { "firms": { "type": "string", "description": "Список фирм, имеющих доступ к этому документу" }, "rawBody": { "type": "array", "items": { "type": "string", "format": "binary", "description": "Список из тел файла" } } } } } } }, "responses": { "200": { "description": "Список с информацией о созданных файлах и ошибках", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/file_success" } } } } }, "400": { "description": "Отсутствует или пустое поле rawBody" }, "401": { "description": "Ошибка авторизации" } }, "tags": [ "files" ] }, "delete": { "summary": "Удалить несколько файлов из хранилища", "requestBody": { "description": "Идентификаторы удаляемых файлов", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "description": "Идентификатор файла" } } } } }, "responses": { "200": { "description": "Список с информацией о созданных файлах и ошибках", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "ok": { "type": "boolean" }, "id": { "type": "string", "title": "Идентификатор файла" } } } } } } }, "400": { "description": "Отсутствует или пустое поле rawBody" }, "401": { "description": "Ошибка авторизации" } }, "tags": [ "files" ] } }, "/v1.0/filestorage/files/{file_id}/": { "delete": { "summary": "Удалить файл", "parameters": [ { "$ref": "#/components/parameters/FileId" } ], "responses": { "200": { "description": "Подверждение об удалении файла" }, "400": { "description": "Файл не найден" } }, "tags": [ "files" ] }, "get": { "summary": "Получить файл по его ID", "parameters": [ { "$ref": "#/components/parameters/FileId" } ], "responses": { "200": { "description": "Содержимое файла" }, "400": { "description": "Файл не найден" } }, "tags": [ "files" ] } }, "/v1.2/account": { "get": { "tags": [ "Account" ], "summary": "Получение информации о своей фирме", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountPublic" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "504": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } } } } }, "/v1.0/account": { "get": { "tags": [ "Account" ], "summary": "Получение информации о своей фирме", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountPascalCase" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "504": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } } } } }, "/v1.0/firms/contact": { "get": { "tags": [ "Contacts" ], "summary": "Метод получения текущего контакта фирмы", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactPublic" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "504": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } } } } }, "/v1.0/firms/contacts": { "get": { "tags": [ "Contacts" ], "summary": "Метод получения всех контактов фирмы", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPublic" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "504": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } } } }, "put": { "tags": [ "Contacts" ], "summary": "Метод редактирования контакта фирмы", "requestBody": { "description": "Контакт для изменения", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirmContact" } ], "description": "Контакт для изменения", "nullable": true } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirmContact" } ], "description": "Контакт для изменения", "nullable": true } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirmContact" } ], "description": "Контакт для изменения", "nullable": true } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirmContact" } ], "description": "Контакт для изменения", "nullable": true } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactPublic" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "504": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } } } } }, "/v1.0/firms/{atiId}/contacts/{contactId}/summary": { "get": { "tags": [ "ContactSummary" ], "summary": "Получение краткой информации о контакте фирмы", "parameters": [ { "name": "atiId", "in": "path", "description": "Идентификатор фирмы", "required": true, "schema": { "type": "string", "description": "Идентификатор фирмы", "nullable": true } }, { "name": "contactId", "in": "path", "description": "Идентификатор контакта фирмы", "required": true, "schema": { "type": "integer", "description": "Идентификатор контакта фирмы", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactSummaryPublic" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "504": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } } } } }, "/v1.0/firms/{atiId}/contacts/summary": { "get": { "tags": [ "ContactSummary" ], "summary": "Получение краткой информации о всех контактах фирмы", "parameters": [ { "name": "atiId", "in": "path", "description": "Идентификатор фирмы", "required": true, "schema": { "type": "string", "description": "Идентификатор фирмы", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactSummaryPublic" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "504": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } } } } }, "/v1.0/firms/contact/{atiId}/{contactId}/email": { "get": { "tags": [ "Contacts" ], "summary": "Получить email контакта", "parameters": [ { "name": "atiId", "in": "path", "description": "Идентификатор фирмы", "required": true, "schema": { "type": "string", "description": "Идентификатор фирмы", "nullable": true } }, { "name": "contactId", "in": "path", "description": "Идентификатор контакта", "required": true, "schema": { "type": "integer", "description": "Идентификатор контакта", "format": "int32" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmailInfo" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "504": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } } } } }, "/v1.0/firms/requisites/{requisiteId}": { "get": { "tags": [ "Requisites" ], "summary": "Возвращает реквизит фирмы по его идентификатору.", "operationId": "get_v1.0_firms_requisites__requisiteId_", "parameters": [ { "name": "requisiteId", "in": "path", "description": "Идентификатор реквизита.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "5e7d4f3a-1234-5678-9abc-def012345678" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/billing-requisites__FirmRequisitePublic" }, "example": { "requisite_id": "5e7d4f3a-1234-5678-9abc-def012345678", "ati_id": "12345", "requisite_type_id": 1, "requisite_name": "Основной реквизит", "legal_name": "ООО \"Ромашка\"", "own_ship_id": 1, "fio": "Иванов Иван Иванович", "inn": "1234567890", "ogrn": "1234567890123", "phone": "+7 (495) 123-45-67", "fax": "+7 (495) 123-45-68", "email": "info@example.com", "kpp": "123456789", "rs": "40702810400000001234", "ks": "30101810400000000225", "bik": "044525225", "bank": "ПАО Сбербанк", "codes": "OKVED:49.41", "is_read_only": false, "okpo": "12345678", "is_vat_payer": true, "last_use_date": "2024-01-15T10:30:00Z", "is_active": true, "is_visible": true, "legal_address": { "address_id": "5e7d4f3a-1234-5678-9abc-def012345678", "ati_id": "12345", "country_id": 1, "region_id": 77, "city_id": 1, "city_name": "Москва", "post_index": "101000", "street_type_id": 1, "street_name": "Тверская", "house_no": "10", "part_no": "корп.1", "litera": "лит.А", "office_no": "501", "post_contact": "Иванов И.И.", "add_date": "2024-01-15T10:30:00Z", "attributes": 12, "formatted_text": "101000, г. Москва, ул. Тверская, д.10, корп.1, лит.А, оф.501" }, "post_address": { "address_id": "5e7d4f3a-1234-5678-9abc-def012345678", "ati_id": "12345", "country_id": 1, "region_id": 77, "city_id": 1, "city_name": "Москва", "post_index": "101000", "street_type_id": 1, "street_name": "Тверская", "house_no": "10", "part_no": "корп.1", "litera": "лит.А", "office_no": "501", "post_contact": "Иванов И.И.", "add_date": "2024-01-15T10:30:00Z", "attributes": 12, "formatted_text": "101000, г. Москва, ул. Тверская, д.10, корп.1, лит.А, оф.501" }, "legal_address_id": "5e7d4f3a-1234-5678-9abc-def012345678", "post_address_id": "6f8e5g4b-2345-6789-0bcd-ef0123456789", "person_passport": { "series": "4500", "number": "123456", "date_of_issue": "2010-05-15T00:00:00Z", "department_code": "770-001", "issued_by": "ОВД района Замоскворечье г. Москвы", "registration": "101000, г. Москва, ул. Тверская, д.10", "scan_files": [ { "link": "https://files.example.com/passport/123.pdf", "id": "file-abc-123", "size": 102400, "name": "passport_scan.pdf" } ] }, "available_in_ati_docs": true, "exclusive_for_invoice_pay_type": 1, "is_short_requisite": false, "signees": [ { "signee_id": "5e7d4f3a-1234-5678-9abc-def012345678", "requisite_id": "6f8e5g4b-2345-6789-0bcd-ef0123456789", "full_name": "Иванова Ивана Ивановича", "position": "генерального директора", "act_upon": "Устава", "is_default": true, "deletion_date": "2024-12-31T00:00:00Z", "full_name_and_position": "Генеральный директор Иванов И.И." } ] } } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "402": { "description": "Метод доступен только платным пользователям.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "payment_required", "reason": "Метод доступен только платным пользователям." } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "504": { "description": "Сервер не ответил во время.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "timeout", "reason": "Сервер не ответил во время." } } } } } } }, "/v1.0/firms/requisites": { "get": { "tags": [ "Requisites" ], "summary": "Возвращает список реквизитов фирмы. Если задан atiId, выбираются реквизиты той фирмы;\nиначе — реквизиты текущей авторизованной фирмы.", "operationId": "get_v1.0_firms_requisites", "parameters": [ { "name": "withShortRequisite", "in": "query", "description": "Включать в выдачу короткие/неполные реквизиты.", "schema": { "type": "boolean", "default": false }, "example": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/billing-requisites__FirmRequisitePublic" }, "example": [ { "requisite_id": "5e7d4f3a-1234-5678-9abc-def012345678", "ati_id": "12345", "requisite_type_id": 1, "requisite_name": "Основной реквизит", "legal_name": "ООО \"Ромашка\"", "own_ship_id": 1, "fio": "Иванов Иван Иванович", "inn": "1234567890", "ogrn": "1234567890123", "phone": "+7 (495) 123-45-67", "fax": "+7 (495) 123-45-68", "email": "info@example.com", "kpp": "123456789", "rs": "40702810400000001234", "ks": "30101810400000000225", "bik": "044525225", "bank": "ПАО Сбербанк", "codes": "OKVED:49.41", "is_read_only": false, "okpo": "12345678", "is_vat_payer": true, "last_use_date": "2024-01-15T10:30:00Z", "is_active": true, "is_visible": true, "legal_address": { "address_id": "5e7d4f3a-1234-5678-9abc-def012345678", "ati_id": "12345", "country_id": 1, "region_id": 77, "city_id": 1, "city_name": "Москва", "post_index": "101000", "street_type_id": 1, "street_name": "Тверская", "house_no": "10", "part_no": "корп.1", "litera": "лит.А", "office_no": "501", "post_contact": "Иванов И.И.", "add_date": "2024-01-15T10:30:00Z", "attributes": 12, "formatted_text": "101000, г. Москва, ул. Тверская, д.10, корп.1, лит.А, оф.501" }, "post_address": { "address_id": "5e7d4f3a-1234-5678-9abc-def012345678", "ati_id": "12345", "country_id": 1, "region_id": 77, "city_id": 1, "city_name": "Москва", "post_index": "101000", "street_type_id": 1, "street_name": "Тверская", "house_no": "10", "part_no": "корп.1", "litera": "лит.А", "office_no": "501", "post_contact": "Иванов И.И.", "add_date": "2024-01-15T10:30:00Z", "attributes": 12, "formatted_text": "101000, г. Москва, ул. Тверская, д.10, корп.1, лит.А, оф.501" }, "legal_address_id": "5e7d4f3a-1234-5678-9abc-def012345678", "post_address_id": "6f8e5g4b-2345-6789-0bcd-ef0123456789", "person_passport": { "series": "4500", "number": "123456", "date_of_issue": "2010-05-15T00:00:00Z", "department_code": "770-001", "issued_by": "ОВД района Замоскворечье г. Москвы", "registration": "101000, г. Москва, ул. Тверская, д.10", "scan_files": [ { "link": "https://files.example.com/passport/123.pdf", "id": "file-abc-123", "size": 102400, "name": "passport_scan.pdf" } ] }, "available_in_ati_docs": true, "exclusive_for_invoice_pay_type": 1, "is_short_requisite": false, "signees": [ { "signee_id": "5e7d4f3a-1234-5678-9abc-def012345678", "requisite_id": "6f8e5g4b-2345-6789-0bcd-ef0123456789", "full_name": "Иванова Ивана Ивановича", "position": "генерального директора", "act_upon": "Устава", "is_default": true, "deletion_date": "2024-12-31T00:00:00Z", "full_name_and_position": "Генеральный директор Иванов И.И." } ] } ] }, "example": [ { "requisite_id": "5e7d4f3a-1234-5678-9abc-def012345678", "ati_id": "12345", "requisite_type_id": 1, "requisite_name": "Основной реквизит", "legal_name": "ООО \"Ромашка\"", "own_ship_id": 1, "fio": "Иванов Иван Иванович", "inn": "1234567890", "ogrn": "1234567890123", "phone": "+7 (495) 123-45-67", "fax": "+7 (495) 123-45-68", "email": "info@example.com", "kpp": "123456789", "rs": "40702810400000001234", "ks": "30101810400000000225", "bik": "044525225", "bank": "ПАО Сбербанк", "codes": "OKVED:49.41", "is_read_only": false, "okpo": "12345678", "is_vat_payer": true, "last_use_date": "2024-01-15T10:30:00Z", "is_active": true, "is_visible": true, "legal_address": { "address_id": "5e7d4f3a-1234-5678-9abc-def012345678", "ati_id": "12345", "country_id": 1, "region_id": 77, "city_id": 1, "city_name": "Москва", "post_index": "101000", "street_type_id": 1, "street_name": "Тверская", "house_no": "10", "part_no": "корп.1", "litera": "лит.А", "office_no": "501", "post_contact": "Иванов И.И.", "add_date": "2024-01-15T10:30:00Z", "attributes": 12, "formatted_text": "101000, г. Москва, ул. Тверская, д.10, корп.1, лит.А, оф.501" }, "post_address": { "address_id": "5e7d4f3a-1234-5678-9abc-def012345678", "ati_id": "12345", "country_id": 1, "region_id": 77, "city_id": 1, "city_name": "Москва", "post_index": "101000", "street_type_id": 1, "street_name": "Тверская", "house_no": "10", "part_no": "корп.1", "litera": "лит.А", "office_no": "501", "post_contact": "Иванов И.И.", "add_date": "2024-01-15T10:30:00Z", "attributes": 12, "formatted_text": "101000, г. Москва, ул. Тверская, д.10, корп.1, лит.А, оф.501" }, "legal_address_id": "5e7d4f3a-1234-5678-9abc-def012345678", "post_address_id": "6f8e5g4b-2345-6789-0bcd-ef0123456789", "person_passport": { "series": "4500", "number": "123456", "date_of_issue": "2010-05-15T00:00:00Z", "department_code": "770-001", "issued_by": "ОВД района Замоскворечье г. Москвы", "registration": "101000, г. Москва, ул. Тверская, д.10", "scan_files": [ { "link": "https://files.example.com/passport/123.pdf", "id": "file-abc-123", "size": 102400, "name": "passport_scan.pdf" } ] }, "available_in_ati_docs": true, "exclusive_for_invoice_pay_type": 1, "is_short_requisite": false, "signees": [ { "signee_id": "5e7d4f3a-1234-5678-9abc-def012345678", "requisite_id": "6f8e5g4b-2345-6789-0bcd-ef0123456789", "full_name": "Иванова Ивана Ивановича", "position": "генерального директора", "act_upon": "Устава", "is_default": true, "deletion_date": "2024-12-31T00:00:00Z", "full_name_and_position": "Генеральный директор Иванов И.И." } ] } ] } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "402": { "description": "Метод доступен только платным пользователям.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "payment_required", "reason": "Метод доступен только платным пользователям." } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "504": { "description": "Сервер не ответил во время.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "timeout", "reason": "Сервер не ответил во время." } } } } } } }, "/v1.0/firms/{atiId}/requisites": { "get": { "tags": [ "Requisites" ], "summary": "Возвращает список реквизитов фирмы. Если задан atiId, выбираются реквизиты той фирмы;\nиначе — реквизиты текущей авторизованной фирмы.", "operationId": "get_v1.0_firms__atiId__requisites", "parameters": [ { "name": "atiId", "in": "path", "description": "Код фирмы в АТИ (опционально).", "required": true, "schema": { "type": "string" }, "example": "12345" }, { "name": "withShortRequisite", "in": "query", "description": "Включать в выдачу короткие/неполные реквизиты.", "schema": { "type": "boolean", "default": false }, "example": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/billing-requisites__FirmRequisitePublic" }, "example": [ { "requisite_id": "5e7d4f3a-1234-5678-9abc-def012345678", "ati_id": "12345", "requisite_type_id": 1, "requisite_name": "Основной реквизит", "legal_name": "ООО \"Ромашка\"", "own_ship_id": 1, "fio": "Иванов Иван Иванович", "inn": "1234567890", "ogrn": "1234567890123", "phone": "+7 (495) 123-45-67", "fax": "+7 (495) 123-45-68", "email": "info@example.com", "kpp": "123456789", "rs": "40702810400000001234", "ks": "30101810400000000225", "bik": "044525225", "bank": "ПАО Сбербанк", "codes": "OKVED:49.41", "is_read_only": false, "okpo": "12345678", "is_vat_payer": true, "last_use_date": "2024-01-15T10:30:00Z", "is_active": true, "is_visible": true, "legal_address": { "address_id": "5e7d4f3a-1234-5678-9abc-def012345678", "ati_id": "12345", "country_id": 1, "region_id": 77, "city_id": 1, "city_name": "Москва", "post_index": "101000", "street_type_id": 1, "street_name": "Тверская", "house_no": "10", "part_no": "корп.1", "litera": "лит.А", "office_no": "501", "post_contact": "Иванов И.И.", "add_date": "2024-01-15T10:30:00Z", "attributes": 12, "formatted_text": "101000, г. Москва, ул. Тверская, д.10, корп.1, лит.А, оф.501" }, "post_address": { "address_id": "5e7d4f3a-1234-5678-9abc-def012345678", "ati_id": "12345", "country_id": 1, "region_id": 77, "city_id": 1, "city_name": "Москва", "post_index": "101000", "street_type_id": 1, "street_name": "Тверская", "house_no": "10", "part_no": "корп.1", "litera": "лит.А", "office_no": "501", "post_contact": "Иванов И.И.", "add_date": "2024-01-15T10:30:00Z", "attributes": 12, "formatted_text": "101000, г. Москва, ул. Тверская, д.10, корп.1, лит.А, оф.501" }, "legal_address_id": "5e7d4f3a-1234-5678-9abc-def012345678", "post_address_id": "6f8e5g4b-2345-6789-0bcd-ef0123456789", "person_passport": { "series": "4500", "number": "123456", "date_of_issue": "2010-05-15T00:00:00Z", "department_code": "770-001", "issued_by": "ОВД района Замоскворечье г. Москвы", "registration": "101000, г. Москва, ул. Тверская, д.10", "scan_files": [ { "link": "https://files.example.com/passport/123.pdf", "id": "file-abc-123", "size": 102400, "name": "passport_scan.pdf" } ] }, "available_in_ati_docs": true, "exclusive_for_invoice_pay_type": 1, "is_short_requisite": false, "signees": [ { "signee_id": "5e7d4f3a-1234-5678-9abc-def012345678", "requisite_id": "6f8e5g4b-2345-6789-0bcd-ef0123456789", "full_name": "Иванова Ивана Ивановича", "position": "генерального директора", "act_upon": "Устава", "is_default": true, "deletion_date": "2024-12-31T00:00:00Z", "full_name_and_position": "Генеральный директор Иванов И.И." } ] } ] }, "example": [ { "requisite_id": "5e7d4f3a-1234-5678-9abc-def012345678", "ati_id": "12345", "requisite_type_id": 1, "requisite_name": "Основной реквизит", "legal_name": "ООО \"Ромашка\"", "own_ship_id": 1, "fio": "Иванов Иван Иванович", "inn": "1234567890", "ogrn": "1234567890123", "phone": "+7 (495) 123-45-67", "fax": "+7 (495) 123-45-68", "email": "info@example.com", "kpp": "123456789", "rs": "40702810400000001234", "ks": "30101810400000000225", "bik": "044525225", "bank": "ПАО Сбербанк", "codes": "OKVED:49.41", "is_read_only": false, "okpo": "12345678", "is_vat_payer": true, "last_use_date": "2024-01-15T10:30:00Z", "is_active": true, "is_visible": true, "legal_address": { "address_id": "5e7d4f3a-1234-5678-9abc-def012345678", "ati_id": "12345", "country_id": 1, "region_id": 77, "city_id": 1, "city_name": "Москва", "post_index": "101000", "street_type_id": 1, "street_name": "Тверская", "house_no": "10", "part_no": "корп.1", "litera": "лит.А", "office_no": "501", "post_contact": "Иванов И.И.", "add_date": "2024-01-15T10:30:00Z", "attributes": 12, "formatted_text": "101000, г. Москва, ул. Тверская, д.10, корп.1, лит.А, оф.501" }, "post_address": { "address_id": "5e7d4f3a-1234-5678-9abc-def012345678", "ati_id": "12345", "country_id": 1, "region_id": 77, "city_id": 1, "city_name": "Москва", "post_index": "101000", "street_type_id": 1, "street_name": "Тверская", "house_no": "10", "part_no": "корп.1", "litera": "лит.А", "office_no": "501", "post_contact": "Иванов И.И.", "add_date": "2024-01-15T10:30:00Z", "attributes": 12, "formatted_text": "101000, г. Москва, ул. Тверская, д.10, корп.1, лит.А, оф.501" }, "legal_address_id": "5e7d4f3a-1234-5678-9abc-def012345678", "post_address_id": "6f8e5g4b-2345-6789-0bcd-ef0123456789", "person_passport": { "series": "4500", "number": "123456", "date_of_issue": "2010-05-15T00:00:00Z", "department_code": "770-001", "issued_by": "ОВД района Замоскворечье г. Москвы", "registration": "101000, г. Москва, ул. Тверская, д.10", "scan_files": [ { "link": "https://files.example.com/passport/123.pdf", "id": "file-abc-123", "size": 102400, "name": "passport_scan.pdf" } ] }, "available_in_ati_docs": true, "exclusive_for_invoice_pay_type": 1, "is_short_requisite": false, "signees": [ { "signee_id": "5e7d4f3a-1234-5678-9abc-def012345678", "requisite_id": "6f8e5g4b-2345-6789-0bcd-ef0123456789", "full_name": "Иванова Ивана Ивановича", "position": "генерального директора", "act_upon": "Устава", "is_default": true, "deletion_date": "2024-12-31T00:00:00Z", "full_name_and_position": "Генеральный директор Иванов И.И." } ] } ] } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "402": { "description": "Метод доступен только платным пользователям.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "payment_required", "reason": "Метод доступен только платным пользователям." } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "504": { "description": "Сервер не ответил во время.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "timeout", "reason": "Сервер не ответил во время." } } } } } } }, "/v1.0/firms/summary": { "get": { "tags": [ "AccountSummary" ], "summary": "Получение краткой информации о своей фирме", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountSummaryPublic" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "504": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } } } } }, "/v1.0/firms/summary/{atiId}": { "get": { "tags": [ "AccountSummary" ], "summary": "Получение краткой информации по фирме (по идентификатору)", "parameters": [ { "name": "atiId", "in": "path", "description": "Идентификатор фирмы", "required": true, "schema": { "type": "string", "description": "Идентификатор фирмы", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountSummaryPublic" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "504": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } } } } }, "/v1.0/firms/summaries": { "post": { "tags": [ "AccountSummary" ], "summary": "Получение краткой информации по фирмам (по идентификаторам)", "requestBody": { "description": "Список идентификаторов фирм", "content": { "application/json-patch+json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Список идентификаторов фирм", "nullable": true } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Список идентификаторов фирм", "nullable": true } }, "text/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Список идентификаторов фирм", "nullable": true } }, "application/*+json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Список идентификаторов фирм", "nullable": true } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountSummaryPublic" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "504": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } } } } }, "/v1.0/firms/comments": { "get": { "tags": [ "FirmComment" ], "summary": "Получение всех своих комментариев о других фирмах", "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FirmCommentPublic" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "504": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } } } }, "post": { "tags": [ "FirmComment" ], "summary": "Добавление комментария о фирме", "requestBody": { "description": "Комментарий для добавления", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirmCommentPublicPost" } ], "description": "Комментарий для добавления", "nullable": true } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirmCommentPublicPost" } ], "description": "Комментарий для добавления", "nullable": true } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirmCommentPublicPost" } ], "description": "Комментарий для добавления", "nullable": true } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirmCommentPublicPost" } ], "description": "Комментарий для добавления", "nullable": true } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmCommentPublic" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "504": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } } } }, "put": { "tags": [ "FirmComment" ], "summary": "Изменение комментария о фирме", "requestBody": { "description": "Комментарий для изменения", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirmCommentPublic" } ], "description": "Комментарий для изменения", "nullable": true } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirmCommentPublic" } ], "description": "Комментарий для изменения", "nullable": true } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirmCommentPublic" } ], "description": "Комментарий для изменения", "nullable": true } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/FirmCommentPublic" } ], "description": "Комментарий для изменения", "nullable": true } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmCommentPublic" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "504": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } } } } }, "/v1.0/firms/comments/{atiId}": { "get": { "tags": [ "FirmComment" ], "summary": "Получение своего комментария о фирме, указанной в atiId", "parameters": [ { "name": "atiId", "in": "path", "description": "Идентификатор фирмы", "required": true, "schema": { "type": "string", "description": "Идентификатор фирмы", "nullable": true } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmCommentPublic" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "504": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } } } } }, "/v1.0/firms/comments/byfirms": { "post": { "tags": [ "FirmComment" ], "summary": "Получение своих комментариев о фирмах, указанных в atiIds", "requestBody": { "description": "Идентификаторы фирм", "content": { "application/json-patch+json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Идентификаторы фирм" } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Идентификаторы фирм" } }, "text/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Идентификаторы фирм" } }, "application/*+json": { "schema": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Идентификаторы фирм" } } }, "required": true }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FirmCommentPublic" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "504": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } } } } }, "/v1.0/firms/comments/{commentId}": { "get": { "tags": [ "FirmComment" ], "summary": "Получение своего комментария о фирме по идентификатору комментария commentId", "parameters": [ { "name": "commentId", "in": "path", "description": "Идентификатор комментария", "required": true, "schema": { "type": "string", "description": "Идентификатор комментария", "format": "uuid" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmCommentPublic" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "504": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } } } }, "delete": { "tags": [ "FirmComment" ], "summary": "Удаление комментария о фирме по идентификатору комментария commentId", "parameters": [ { "name": "commentId", "in": "path", "description": "Идентификатор комментария", "required": true, "schema": { "type": "string", "description": "Идентификатор комментария", "format": "uuid" } } ], "responses": { "200": { "description": "Success" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "402": { "description": "Client Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "500": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } }, "504": { "description": "Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/firms__ErrorResponse" } } } } } } }, "/gw/goslog/v1/expeditors/lookup": { "get": { "tags": [ "GoslogIntegration" ], "summary": "Возвращает записи экспедиторов из реестра ГосЛог для указанного ИНН.", "operationId": "get_v1_expeditors_lookup", "parameters": [ { "name": "inn", "in": "query", "description": "ИНН юрлица (10 цифр) или ИП (12 цифр). Пример: 5256167583", "required": true, "schema": { "type": "string" }, "example": "5256167583" } ], "responses": { "200": { "description": "Записи реестра экспедиторов", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GoslogExpeditorLookupBatchResponse" }, "example": { "expeditors": [ { "registry_number": "string", "included_at": "string", "ogrn": "string", "inn": "string" } ] } } } }, "400": { "description": "ИНН должен содержать 10 или 12 цифр", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goslog-service__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "ИНН должен содержать 10 или 12 цифр" } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/goslog-service__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } } } } }, "/index/license/v1/current_index": { "post": { "tags": [ "Платное АПИ" ], "summary": "Текущее состояние общего индекса", "description": "Текущее состояние общего индекса", "operationId": "current_index_license_license_v1_current_index_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenseCurrentIndexRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenseCurrentIndexResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorFormatResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorFormatResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/index_ati__HTTPValidationError" } } } } } } }, "/index/license/v1/general_index_dynamic": { "post": { "tags": [ "Платное АПИ" ], "summary": "Динамика общего индекса", "description": "Динамика общего индекса", "operationId": "general_index_dynamic_license_v1_general_index_dynamic_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenseGeneralIndexRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenseGeneralIndexResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorFormatResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorFormatResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/index_ati__HTTPValidationError" } } } } } } }, "/gw/insurance/v1/insurances/attach-policy": { "post": { "tags": [ "ResponsibilityInsurance" ], "summary": "Подтверждает оплату пользователя и прикрепляет подписанный страховой полис к заявке по страхованию ответственности.", "description": "Операция доступна только для страховок страховой компании, указанной в заявке.\nПосле успешной загрузки статус заявки обновится, пользователю будет начислен кешбэк.", "operationId": "post_v1_insurances_attach-policy", "requestBody": { "description": "Тело запроса с номером полиса, файлом полиса и контактом страховой компании.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachPolicyRequest" } ], "description": "Модель запроса на прикрепление полиса к заявке страхования ответственности.", "example": { "policy_number": "Полис12345", "file": { "file_base64": "JVBERi0xLjQKJ...", "content_type": "application/pdf", "file_name": "Полис_12345.pdf" }, "contact_id": 12345 } }, "example": { "policy_number": "Полис12345", "file": { "file_base64": "JVBERi0xLjQKJ...", "content_type": "application/pdf", "file_name": "Полис_12345.pdf" }, "contact_id": 12345 } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachPolicyRequest" } ], "description": "Модель запроса на прикрепление полиса к заявке страхования ответственности.", "example": { "policy_number": "Полис12345", "file": { "file_base64": "JVBERi0xLjQKJ...", "content_type": "application/pdf", "file_name": "Полис_12345.pdf" }, "contact_id": 12345 } }, "example": { "policy_number": "Полис12345", "file": { "file_base64": "JVBERi0xLjQKJ...", "content_type": "application/pdf", "file_name": "Полис_12345.pdf" }, "contact_id": 12345 } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachPolicyRequest" } ], "description": "Модель запроса на прикрепление полиса к заявке страхования ответственности.", "example": { "policy_number": "Полис12345", "file": { "file_base64": "JVBERi0xLjQKJ...", "content_type": "application/pdf", "file_name": "Полис_12345.pdf" }, "contact_id": 12345 } }, "example": { "policy_number": "Полис12345", "file": { "file_base64": "JVBERi0xLjQKJ...", "content_type": "application/pdf", "file_name": "Полис_12345.pdf" }, "contact_id": 12345 } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/AttachPolicyRequest" } ], "description": "Модель запроса на прикрепление полиса к заявке страхования ответственности.", "example": { "policy_number": "Полис12345", "file": { "file_base64": "JVBERi0xLjQKJ...", "content_type": "application/pdf", "file_name": "Полис_12345.pdf" }, "contact_id": 12345 } }, "example": { "policy_number": "Полис12345", "file": { "file_base64": "JVBERi0xLjQKJ...", "content_type": "application/pdf", "file_name": "Полис_12345.pdf" }, "contact_id": 12345 } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "402": { "description": "Метод доступен только платным пользователям.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "payment_required", "reason": "Метод доступен только платным пользователям." } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "504": { "description": "Сервер не ответил во время.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "timeout", "reason": "Сервер не ответил во время." } } } } } } }, "/gw/insurance/integration/v1/cargo-insurances/{insuranceId}": { "get": { "tags": [ "CargoInsurance" ], "summary": "Возвращает заявку на страхование груза для интеграционного API.", "description": "Выполнить действие может только страховая компания, относящаяся к заявке.", "operationId": "get_integration_v1_cargo-insurances__insuranceId_", "parameters": [ { "name": "insuranceId", "in": "path", "description": "Идентификатор заявки на страхование.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "f6f9b9f4-ec4a-4fd6-9d2f-6d3a6db0a4d7" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CargoInsuranceIntegrationDto" }, "example": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ati_id": "123456", "firm_name": "ООО Ромашка", "account_inn": "7701234567", "firm_requisites": { "requisite_id": "123", "legal_address": { "address_id": "123456", "formatted_text": "Россия, г. Москва, ул. Ленина, д. 1" }, "post_address": { "address_id": "123456", "formatted_text": "Россия, г. Москва, ул. Ленина, д. 1" }, "full_name": "ООО Ромашка", "inn": "7701234567", "ogrn": "1027700123456", "kpp": "770101001", "rs": "40702810900000000001", "ks": "30101810400000000225", "bik": "044525225", "bank": "ПАО Сбербанк", "okpo": "12345678", "signees": [ { "signee_id": 123, "requisite_id": 1234, "full_name": "Иванов Иван Иванович", "position": "Директор", "act_upon": "Устав" } ] }, "change_date": "2026-05-28T10:00:00", "status": "Insured", "status_change_date": "2026-05-28T11:00:00", "start_date": "2026-06-01", "end_date": "2026-12-31", "sum": 150000, "tariff_sum": 3500, "tariff": 2.33, "franchise_sum": 10000, "franchise": 5, "currency": "RUB", "policy_number": "POL-123456", "policy_file_name": "policy.pdf", "policy_file_url": "https://example.com/policy.pdf", "policy_template_file_url": "https://example.com/policy-template.pdf", "price_in_policy": true, "cargo": { "cargo_type_name": "Бытовая техника", "cargo_name": "Холодильники", "cargo_package_count": 10, "cargo_package_type_name": "Паллеты", "cargo_weight": 12000.5, "cargo_attributes_description": "С хрупкими элементами", "sealing_number": "PL-778899", "is_groupage": false, "cargo_volume": 0, "is_used": false, "is_perishable": false, "is_secured": false, "is_fragile": false, "adr": false, "inc_load_unload": false, "is_fraud_risk": false }, "route_vehicle": { "from_city": "Москва", "to_city": "Санкт-Петербург", "distance": 700000, "vehicle_number": "А123АА77", "document_number_type": "CMR", "document_number": "CMR-123456", "truck_type": "Тягач", "extra_points": [ { "point_type": 1, "address": "Россия, г. Казань, ул. Кремлевская, д. 5", "city_name": "Казань", "city_id": 0 } ], "vehicle_passport_files": [ { "name": "policy.pdf", "url": "https://example.com/policy.pdf" } ], "driver_passport_files": [ { "name": "policy.pdf", "url": "https://example.com/policy.pdf" } ], "driver_license_files": [ { "name": "policy.pdf", "url": "https://example.com/policy.pdf" } ] }, "carrier": { "carrier_inn": "7812345678", "carrier_name": "ООО Перевозчик", "carrier_address": "Россия, г. Санкт-Петербург, Невский пр., д. 1" }, "beneficiary": { "beneficiary_inn": "7701234567", "beneficiary_name": "ООО Выгодоприобретатель", "beneficiary_address": "Россия, г. Москва, ул. Пушкина, д. 10" }, "contact": { "id": 12345, "name": "Иван Иванов", "phone": "+7 900 123-45-67", "email": "ivan@example.com" } } } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "402": { "description": "Метод доступен только платным пользователям.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "payment_required", "reason": "Метод доступен только платным пользователям." } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "504": { "description": "Сервер не ответил во время.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "timeout", "reason": "Сервер не ответил во время." } } } } } } }, "/gw/insurance/integration/v1/cargo-insurances": { "post": { "tags": [ "CargoInsurance" ], "summary": "Поиск заявок на страхование грузов для страховой компании.", "description": "В выборку попадают только заявки страховой компании, от имени которой выполняется запрос.\nЕсли не передать значения `skip` и `take`, используются значения по умолчанию 0 и 10 соответственно.", "operationId": "post_integration_v1_cargo-insurances", "requestBody": { "description": "Параметры поиска заявок для страховой компании.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SearchCargoInsurancesIntegrationRequestDto" } ], "description": "Тело поиска заявок на страхование грузов (интеграционный метод для страховых)", "example": { "skip": 0, "take": 10, "firms": [ 12325 ], "status": "Insured", "from_add_date": "2026-05-28T10:00:00+00:00", "to_add_date": "2026-05-29T10:00:00+00:00" } }, "example": { "skip": 0, "take": 10, "firms": [ 12325 ], "status": "Insured", "from_add_date": "2026-05-28T10:00:00+00:00", "to_add_date": "2026-05-29T10:00:00+00:00" } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SearchCargoInsurancesIntegrationRequestDto" } ], "description": "Тело поиска заявок на страхование грузов (интеграционный метод для страховых)", "example": { "skip": 0, "take": 10, "firms": [ 12325 ], "status": "Insured", "from_add_date": "2026-05-28T10:00:00+00:00", "to_add_date": "2026-05-29T10:00:00+00:00" } }, "example": { "skip": 0, "take": 10, "firms": [ 12325 ], "status": "Insured", "from_add_date": "2026-05-28T10:00:00+00:00", "to_add_date": "2026-05-29T10:00:00+00:00" } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SearchCargoInsurancesIntegrationRequestDto" } ], "description": "Тело поиска заявок на страхование грузов (интеграционный метод для страховых)", "example": { "skip": 0, "take": 10, "firms": [ 12325 ], "status": "Insured", "from_add_date": "2026-05-28T10:00:00+00:00", "to_add_date": "2026-05-29T10:00:00+00:00" } }, "example": { "skip": 0, "take": 10, "firms": [ 12325 ], "status": "Insured", "from_add_date": "2026-05-28T10:00:00+00:00", "to_add_date": "2026-05-29T10:00:00+00:00" } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SearchCargoInsurancesIntegrationRequestDto" } ], "description": "Тело поиска заявок на страхование грузов (интеграционный метод для страховых)", "example": { "skip": 0, "take": 10, "firms": [ 12325 ], "status": "Insured", "from_add_date": "2026-05-28T10:00:00+00:00", "to_add_date": "2026-05-29T10:00:00+00:00" } }, "example": { "skip": 0, "take": 10, "firms": [ 12325 ], "status": "Insured", "from_add_date": "2026-05-28T10:00:00+00:00", "to_add_date": "2026-05-29T10:00:00+00:00" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CargoInsuranceIntegrationListDto" }, "example": { "total": 5, "insurances": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ati_id": "123456", "firm_name": "ООО Ромашка", "account_inn": "7701234567", "firm_requisites": { "requisite_id": "123", "legal_address": { "address_id": "123456", "formatted_text": "Россия, г. Москва, ул. Ленина, д. 1" }, "post_address": { "address_id": "123456", "formatted_text": "Россия, г. Москва, ул. Ленина, д. 1" }, "full_name": "ООО Ромашка", "inn": "7701234567", "ogrn": "1027700123456", "kpp": "770101001", "rs": "40702810900000000001", "ks": "30101810400000000225", "bik": "044525225", "bank": "ПАО Сбербанк", "okpo": "12345678", "signees": [ { "signee_id": 123, "requisite_id": 1234, "full_name": "Иванов Иван Иванович", "position": "Директор", "act_upon": "Устав" } ] }, "change_date": "2026-05-28T10:00:00", "status": "Insured", "status_change_date": "2026-05-28T11:00:00", "start_date": "2026-06-01", "end_date": "2026-12-31", "sum": 150000, "tariff_sum": 3500, "tariff": 2.33, "franchise_sum": 10000, "franchise": 5, "currency": "RUB", "policy_number": "POL-123456", "policy_file_name": "policy.pdf", "policy_file_url": "https://example.com/policy.pdf", "policy_template_file_url": "https://example.com/policy-template.pdf", "invoice_url": "https://example.com/invoice.pdf", "payment_url": "https://example.com/payment", "price_in_policy": true, "client_payment_date": "2026-05-29T14:30:00", "insurer_payment_date": "2026-06-02T09:15:00", "deflected_notice_comment": "Недостаточно документов для оформления полиса", "cargo": { "cargo_type_name": "Бытовая техника", "cargo_name": "Холодильники", "cargo_package_count": 10, "cargo_package_type_name": "Паллеты", "cargo_weight": 12000.5, "cargo_attributes_description": "С хрупкими элементами", "sealing_number": "PL-778899", "is_groupage": false, "cargo_volume": 0, "is_used": false, "is_perishable": false, "is_secured": false, "is_fragile": false, "adr": false, "inc_load_unload": false, "is_fraud_risk": false }, "route_vehicle": { "from_city": "Москва", "to_city": "Санкт-Петербург", "distance": 700000, "vehicle_number": "А123АА77", "document_number_type": "CMR", "document_number": "CMR-123456", "truck_type": "Тягач", "extra_points": [ { "point_type": 1, "address": "Россия, г. Казань, ул. Кремлевская, д. 5", "city_name": "Казань", "city_id": 0 } ], "vehicle_passport_files": [ { "name": "policy.pdf", "url": "https://example.com/policy.pdf" } ], "driver_passport_files": [ { "name": "policy.pdf", "url": "https://example.com/policy.pdf" } ], "driver_license_files": [ { "name": "policy.pdf", "url": "https://example.com/policy.pdf" } ] }, "carrier": { "carrier_inn": "7812345678", "carrier_name": "ООО Перевозчик", "carrier_address": "Россия, г. Санкт-Петербург, Невский пр., д. 1" }, "beneficiary": { "beneficiary_inn": "7701234567", "beneficiary_name": "ООО Выгодоприобретатель", "beneficiary_address": "Россия, г. Москва, ул. Пушкина, д. 10" }, "contact": { "id": 12345, "name": "Иван Иванов", "phone": "+7 900 123-45-67", "email": "ivan@example.com" }, "claim_id": "00000000-0000-0000-0000-000000000000" } ] } } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "402": { "description": "Метод доступен только платным пользователям.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "payment_required", "reason": "Метод доступен только платным пользователям." } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "504": { "description": "Сервер не ответил во время.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "timeout", "reason": "Сервер не ответил во время." } } } } } } }, "/gw/insurance/integration/v1/cargo-insurances/{insuranceId}/process": { "post": { "tags": [ "CargoInsurance" ], "summary": "Переводит заявку страхователя из статуса «Новая» или \"Одобрена\" в «Обрабатывается» по интеграционному API.", "description": "Допустимы статусы: новая, одобрена.\nВыполнить действие может только страховая компания, относящаяся к заявке.", "operationId": "post_integration_v1_cargo-insurances__insuranceId__process", "parameters": [ { "name": "insuranceId", "in": "path", "description": "Идентификатор заявки на страхование.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "f6f9b9f4-ec4a-4fd6-9d2f-6d3a6db0a4d7" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsuranceMutationIntegrationResultDto" }, "example": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "status": "Insured", "status_change_date": "2026-05-28T10:00:00+00:00", "deflected_notice_comment": "Недостаточно документов" } } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "402": { "description": "Метод доступен только платным пользователям.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "payment_required", "reason": "Метод доступен только платным пользователям." } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "504": { "description": "Сервер не ответил во время.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "timeout", "reason": "Сервер не ответил во время." } } } } } } }, "/gw/insurance/integration/v1/cargo-insurances/{insuranceId}/policy": { "post": { "tags": [ "CargoInsurance" ], "summary": "Прикрепляет файл полиса к заявке страхования груза в интеграционном API и подтверждает оплату клиента.", "description": "После прикрепления полиса рассчитывает кешбэк и подтверждает оплату клиента.\nВыполнить действие может только страховая компания, относящаяся к заявке.\nПолис можно прикрепить из статусов \"новая\", \"обрабатывается\" и \"одобрена\" + застрахована (без оплаты),\nа также из статуса \"застрахована\" при отсутствии платежа клиента.\nТело запроса передаётся в формате `multipart/form-data`.", "operationId": "post_integration_v1_cargo-insurances__insuranceId__policy", "parameters": [ { "name": "insuranceId", "in": "path", "description": "Идентификатор заявки на страхование.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "f6f9b9f4-ec4a-4fd6-9d2f-6d3a6db0a4d7" } ], "requestBody": { "description": "Данные формы прикрепления полиса (поля file, policy_number, cargo_cost, policy_tariff, contact_id, additional_contact_id).", "content": { "multipart/form-data": { "schema": { "required": [ "cargo_cost", "contact_id", "file", "policy_number", "policy_tariff" ], "type": "object", "properties": { "file": { "type": "string", "description": "Файл полиса.", "format": "binary", "example": "policy.pdf" }, "policy_number": { "type": "string", "description": "Номер полиса.", "example": "Полис_12345" }, "cargo_cost": { "type": "number", "description": "Стоимость груза.", "format": "double", "example": 1 }, "policy_tariff": { "type": "number", "description": "Тариф полиса в процентах.", "format": "double", "example": 1 }, "contact_id": { "type": "integer", "description": "Идентификатор основного контакта страховой компании.", "format": "int32", "example": 0 }, "additional_contact_id": { "type": "integer", "description": "Идентификатор дополнительного контакта страховой компании.", "format": "int32", "example": 0 } }, "example": { "file": "policy.pdf", "policy_number": "Полис_12345", "cargo_cost": 1, "policy_tariff": 1, "contact_id": 0, "additional_contact_id": 0 } }, "example": { "file": "policy.pdf", "policy_number": "Полис_12345", "cargo_cost": 1, "policy_tariff": 1, "contact_id": 0, "additional_contact_id": 0 }, "encoding": { "file": { "style": "form" }, "policy_number": { "style": "form" }, "cargo_cost": { "style": "form" }, "policy_tariff": { "style": "form" }, "contact_id": { "style": "form" }, "additional_contact_id": { "style": "form" } } } } }, "responses": { "200": { "description": "OK" }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "402": { "description": "Метод доступен только платным пользователям.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "payment_required", "reason": "Метод доступен только платным пользователям." } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "504": { "description": "Сервер не ответил во время.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "timeout", "reason": "Сервер не ответил во время." } } } } } } }, "/gw/insurance/integration/v1/cargo-insurances/{insuranceId}/deflect": { "post": { "tags": [ "CargoInsurance" ], "summary": "Отклоняет заявку на страхование груза назначенной страховой компанией.", "description": "Допустимы статусы: одобрена, новая, обрабатывается.\nВыполнить действие может только страховая компания, относящаяся к заявке.", "operationId": "post_integration_v1_cargo-insurances__insuranceId__deflect", "parameters": [ { "name": "insuranceId", "in": "path", "description": "Идентификатор заявки на страхование.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "f6f9b9f4-ec4a-4fd6-9d2f-6d3a6db0a4d7" } ], "requestBody": { "description": "Текст причины отклонения для страхователя (поле `deflected_notice_comment` в JSON).", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DeflectInsuranceRequestDto" } ], "description": "Запрос на отклонение заявки на страхование.", "example": { "deflected_notice_comment": "Недостаточно документов для оформления" } }, "example": { "deflected_notice_comment": "Недостаточно документов для оформления" } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DeflectInsuranceRequestDto" } ], "description": "Запрос на отклонение заявки на страхование.", "example": { "deflected_notice_comment": "Недостаточно документов для оформления" } }, "example": { "deflected_notice_comment": "Недостаточно документов для оформления" } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DeflectInsuranceRequestDto" } ], "description": "Запрос на отклонение заявки на страхование.", "example": { "deflected_notice_comment": "Недостаточно документов для оформления" } }, "example": { "deflected_notice_comment": "Недостаточно документов для оформления" } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/DeflectInsuranceRequestDto" } ], "description": "Запрос на отклонение заявки на страхование.", "example": { "deflected_notice_comment": "Недостаточно документов для оформления" } }, "example": { "deflected_notice_comment": "Недостаточно документов для оформления" } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsuranceMutationIntegrationResultDto" }, "example": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "status": "Insured", "status_change_date": "2026-05-28T10:00:00+00:00", "deflected_notice_comment": "Недостаточно документов" } } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "402": { "description": "Метод доступен только платным пользователям.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "payment_required", "reason": "Метод доступен только платным пользователям." } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "504": { "description": "Сервер не ответил во время.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "timeout", "reason": "Сервер не ответил во время." } } } } } } }, "/gw/insurance/integration/v1/cargo-insurances/confirm-payments": { "post": { "tags": [ "CargoInsurance" ], "summary": "Подтверждает оплату клиентом по списку заявок на страхование грузов от страховой компании для интеграционного АПИ.", "description": "Допустимы статусы: застрахована, новая, обрабатывается, одобрена.", "operationId": "post_integration_v1_cargo-insurances_confirm-payments", "requestBody": { "description": "Идентификаторы заявок.", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "example": [ "f6f9b9f4-ec4a-4fd6-9d2f-6d3a6db0a4d7" ] }, "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "example": [ "f6f9b9f4-ec4a-4fd6-9d2f-6d3a6db0a4d7" ] }, "text/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "example": [ "f6f9b9f4-ec4a-4fd6-9d2f-6d3a6db0a4d7" ] }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "example": [ "f6f9b9f4-ec4a-4fd6-9d2f-6d3a6db0a4d7" ] } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConfirmPaymentResultDto" }, "example": [ { "id": "f6f9b9f4-ec4a-4fd6-9d2f-6d3a6db0a4d7", "status": "Insured", "status_change_date": "2026-05-28T10:00:00+00:00", "success": true, "error_message": "Заявка не найдена", "client_payment_date": "2026-05-29T14:30:00+00:00", "cash_back_sum": 150, "cash_back_percent": 5 } ] }, "example": [ { "id": "f6f9b9f4-ec4a-4fd6-9d2f-6d3a6db0a4d7", "status": "Insured", "status_change_date": "2026-05-28T10:00:00+00:00", "success": true, "error_message": "Заявка не найдена", "client_payment_date": "2026-05-29T14:30:00+00:00", "cash_back_sum": 150, "cash_back_percent": 5 } ] } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "402": { "description": "Метод доступен только платным пользователям.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "payment_required", "reason": "Метод доступен только платным пользователям." } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "504": { "description": "Сервер не ответил во время.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "timeout", "reason": "Сервер не ответил во время." } } } } } } }, "/gw/insurance/integration/v1/cargo-insurances/{insuranceId}/files": { "get": { "tags": [ "CargoInsurance" ], "summary": "Возвращает список файлов заявки на страхование груза для интеграционного API.", "description": "Доступно только страховой компании, которой принадлежит заявка.", "operationId": "get_integration_v1_cargo-insurances__insuranceId__files", "parameters": [ { "name": "insuranceId", "in": "path", "description": "Идентификатор заявки на страхование.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "f6f9b9f4-ec4a-4fd6-9d2f-6d3a6db0a4d7" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FileLinkDto" }, "example": [ { "name": "policy.pdf", "url": "https://example.com/policy.pdf" } ] }, "example": [ { "name": "policy.pdf", "url": "https://example.com/policy.pdf" } ] } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "402": { "description": "Метод доступен только платным пользователям.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "payment_required", "reason": "Метод доступен только платным пользователям." } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "504": { "description": "Сервер не ответил во время.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/insurance-service__ErrorResponse" }, "example": { "error": "timeout", "reason": "Сервер не ответил во время." } } } } } } }, "/v2/cargos/{cargoApplicationId}/restore": { "post": { "tags": [ "Грузы" ], "summary": "Восстановить заявку на груз из архива.", "description": "API для интеграции. Публикует заявку из архива от имени текущего пользователя.", "parameters": [ { "name": "cargoApplicationId", "in": "path", "description": "Идентификатор восстанавливаемой заявки на груз.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody": { "description": "Данные заявки на груз.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestoreCargoApplicationPublicRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RestoreCargoApplicationPublicRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RestoreCargoApplicationPublicRequest" } } }, "required": true }, "responses": { "200": { "description": "Заявка на груз успешно восстановлена и опубликована.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateCargoApplicationPublicResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateCargoApplicationPublicResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCargoApplicationPublicResponse" } } } }, "400": { "description": "Невалидные данные запроса.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } }, "402": { "description": "Недостаточно средств на счёте для размещения.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } }, "403": { "description": "Нет прав на восстановление или кошелёк заблокирован.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } }, "404": { "description": "Заявка на груз не найдена в архиве.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } }, "409": { "description": "Обнаружен дубликат заявки.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } }, "417": { "description": "Истекло бесплатное редактирование.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } } }, "security": [ { "ApiSecret": [] }, { "Bearer": [] }, { "AuthenticatedUserId": [] } ] } }, "/v1.0/unpublished-loads/{loadId}/restore": { "put": { "tags": [ "Архивные грузы" ], "summary": "Восстановление одного груза из архива.", "description": "API для интеграции. В отличие от группового восстановления, тело задаёт итоговое состояние груза: его можно поправить прямо при возврате из архива.\nГруз сохраняет идентификатор, но получает новый номер; груз с завершёнными торгами не восстанавливается.", "operationId": "UnpublishedLoads_RestorePUT2", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "Идентификатор архивного груза.", "schema": { "type": "string", "format": "guid" }, "x-position": 2, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody": { "x-name": "load", "description": "Груз.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertLoadDto" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Восстановленный груз.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadView" } } } }, "400": { "description": "Тело запроса не разобрано или поля не прошли проверку.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValidationErrorView" } } } }, "402": { "description": "Не хватает средств на платное размещение на выбранных площадках.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfPaidPlacementLowBalanceException" } } } }, "403": { "description": "Нет доступа к грузу или у груза завершённые торги.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadAccessDeniedErrorView" } } } }, "404": { "description": "Архивный груз не найден.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfLoadNotFoundException" } } } }, "409": { "description": "Среди опубликованных грузов фирмы уже есть такой же.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadConflictErrorView" } } } } }, "security": [ { "Bearer": [] } ] } }, "/v1.0/unpublished-loads/restore": { "put": { "tags": [ "Архивные грузы" ], "summary": "Восстановление нескольких грузов из архива.", "description": "API для интеграции. Груз сохраняет идентификатор, но получает новый номер; устаревшие даты загрузки сдвигаются на сегодня,\nпросроченная отложенная публикация на площадках выполняется сразу. Груз с завершёнными торгами не восстанавливается.\nПовторы в списке схлопываются, грузы обрабатываются по отдельности: отказ по одному не отменяет восстановление остальных.", "operationId": "UnpublishedLoads_RestorePUT", "parameters": [ { "name": "ids", "in": "query", "style": "form", "explode": true, "description": "Идентификаторы архивных грузов.", "schema": { "type": "array", "items": { "type": "string", "format": "guid" } }, "x-position": 1, "example": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] } ], "responses": { "200": { "description": "Статусы операций по грузам. Ключ — идентификатор груза; при отказе статус несёт ключ и причину ошибки.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/GroupOperationStatusView" } }, "example": { "3fa85f64-5717-4562-b3fc-2c963f66afa6": { "Status": 0, "Message": "Успех" } } } } }, "400": { "description": "Список идентификаторов пуст или содержит неверный guid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfRequestValidationException" } } } } }, "security": [ { "Bearer": [] } ] } }, "/v1.0/unpublished-loads/{loadId}": { "get": { "tags": [ "Архивные грузы" ], "summary": "Получение одного архивного груза.", "description": "API для интеграции. Отдаются только грузы вашей фирмы: чужой архив недоступен.", "operationId": "UnpublishedLoads_Get", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "Идентификатор архивного груза.", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { "description": "Архивный груз.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadView" } } } }, "404": { "description": "Архивный груз не найден.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfLoadNotFoundException" } } } } }, "security": [ { "Bearer": [] } ] }, "delete": { "tags": [ "Архивные грузы" ], "summary": "Удаление одного архивного груза.", "description": "API для интеграции. Груз удаляется из архива насовсем: восстановить его после этого нельзя.", "operationId": "UnpublishedLoads_DeleteDELETE2", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "Идентификатор архивного груза.", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { "description": "Статус операции по грузу. Ключ — идентификатор груза.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/OperationStatus" } }, "example": { "3fa85f64-5717-4562-b3fc-2c963f66afa6": { "Status": 0, "Message": "Успешная операция" } } } } }, "400": { "description": "Идентификатор груза пуст.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfRequestValidationException" } } } }, "403": { "description": "Нет доступа к грузу.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadAccessDeniedErrorView" } } } }, "404": { "description": "Архивный груз не найден.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfLoadNotFoundException" } } } } }, "security": [ { "Bearer": [] } ] } }, "/v1.0/unpublished-loads": { "get": { "tags": [ "Архивные грузы" ], "summary": "Получение всех архивных грузов фирмы.", "description": "API для интеграции. В архив груз попадает, когда его снимает владелец или система: истёк срок актуальности, жалобы, модерация; причина видна в самом грузе.\nВернуть груз в выдачу можно методами restore. Без contactId возвращаются архивные грузы всех контактов фирмы.", "operationId": "UnpublishedLoads_GetAll", "parameters": [ { "name": "contactId", "in": "query", "description": "Идентификатор контакта.", "schema": { "type": "integer", "format": "int32", "nullable": true }, "x-position": 1, "example": 0 } ], "responses": { "200": { "description": "Архивные грузы фирмы.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LoadView" } } } } }, "404": { "description": "Контакт не найден в фирме.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfContactNotFoundException" } } } } }, "security": [ { "Bearer": [] } ] }, "delete": { "tags": [ "Архивные грузы" ], "summary": "Удаление нескольких архивных грузов.", "description": "API для интеграции. Грузы удаляются из архива насовсем и обрабатываются по отдельности: отказ по одному не отменяет удаление остальных.", "operationId": "UnpublishedLoads_DeleteDELETE", "parameters": [ { "name": "ids", "in": "query", "style": "form", "explode": true, "description": "Идентификаторы архивных грузов.", "schema": { "type": "array", "items": { "type": "string", "format": "guid" } }, "x-position": 1, "example": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] } ], "responses": { "200": { "description": "Статусы операций по грузам. Ключ — идентификатор груза; при отказе статус несёт ключ и причину ошибки.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/GroupOperationStatusView" } }, "example": { "3fa85f64-5717-4562-b3fc-2c963f66afa6": { "Status": 0, "Message": "Успех" } } } } }, "400": { "description": "Список идентификаторов пуст или содержит неверный guid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfRequestValidationException" } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/cargos_create_v2/integration/v2/cargos": { "delete": { "tags": [ "Грузы" ], "summary": "Удалить несколько архивных заявок на груз.", "description": "API для интеграции. Безвозвратно удаляет архивные заявки на груз от имени текущего пользователя. Максимум — 100 идентификаторов за один запрос.", "requestBody": { "description": "Идентификаторы заявок на груз для удаления.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteCargoApplicationsIntegrationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeleteCargoApplicationsIntegrationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DeleteCargoApplicationsIntegrationRequest" } } }, "required": true }, "responses": { "200": { "description": "Результат удаления по каждой заявке.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/cargos_v2__DeleteCargoApplicationsIntegrationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/cargos_v2__DeleteCargoApplicationsIntegrationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/cargos_v2__DeleteCargoApplicationsIntegrationResponse" } } } }, "400": { "description": "Пустой массив id или превышен лимит количества грузов в запросе.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } }, "403": { "description": "Нет прав на удаление одной или нескольких заявок.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } }, "404": { "description": "Одна или несколько заявок не найдены.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } } }, "security": [ { "ApiSecret": [] }, { "Bearer": [] }, { "AuthenticatedUserId": [] } ] } }, "/v1.0/unpublished-loads/comments": { "get": { "tags": [ "Архивные грузы" ], "summary": "Получение всех комментариев фирмы ко всем архивным грузам.", "description": "API для интеграции. Возвращаются комментарии вашей фирмы ко всем её архивным грузам.", "operationId": "UnpublishedLoads_GetCommentsForAllUnpublishedLoads", "responses": { "200": { "description": "Комментарии фирмы по архивным грузам. Ключ — идентификатор груза.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Comment" } } }, "example": { "3fa85f64-5717-4562-b3fc-2c963f66afa6": [] } } } } }, "security": [ { "Bearer": [] } ] } }, "/v1.0/unpublished-loads/{loadId}/comments": { "get": { "tags": [ "Архивные грузы" ], "summary": "Получение комментариев фирмы к архивному грузу.", "description": "API для интеграции. Комментарий виден только фирме, которая его оставила: чужие комментарии к тому же грузу не возвращаются.", "operationId": "UnpublishedLoads_GetUnpublishedLoadComments", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "Идентификатор груза.", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { "description": "Комментарии фирмы к архивному грузу.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Comment" } } } } }, "404": { "description": "Архивный груз не найден.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfLoadNotFoundException" } } } } }, "security": [ { "Bearer": [] } ] }, "put": { "tags": [ "Архивные грузы" ], "summary": "Добавление либо редактирование комментария к архивному грузу.", "description": "API для интеграции. Повторный вызов заменяет комментарий фирмы к этому грузу, а не добавляет ещё один.", "operationId": "UnpublishedLoads_UpsertUnpublishedLoadCommentPUT", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "Идентификатор груза.", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody": { "x-name": "comment", "description": "Комментарий.", "content": { "application/json": { "schema": { "type": "string" }, "example": "Договорились на понедельник" } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "Сохранённый комментарий.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Comment" } } } }, "400": { "description": "Комментарий пустой или длиннее 128 символов.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfRequestValidationException" } } } }, "404": { "description": "Архивный груз не найден.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfLoadNotFoundException" } } } } }, "security": [ { "Bearer": [] } ] }, "delete": { "tags": [ "Архивные грузы" ], "summary": "Удаление комментария у архивного груза.", "description": "API для интеграции. Удаляется комментарий вашей фирмы; на сам груз и на чужие комментарии вызов не влияет.", "operationId": "UnpublishedLoads_DeleteUnpublishedLoadCommentDELETE", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "Идентификатор груза.", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { "description": "Комментарий удалён.", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Архивный груз или комментарий фирмы к нему не найден.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfLoadNotFoundException" } } } } }, "security": [ { "Bearer": [] } ] } }, "/v1.0/unpublished-loads/new/responses": { "get": { "tags": [ "Отзывы на архивные грузы (новая структура)" ], "summary": "Получение всех отзывов по всем архивным грузам фирмы.", "description": "API для интеграции. Отзывы остаются доступными после ухода груза в архив. Возвращаются отзывы всех типов: встречные предложения, жалобы, озвученные ставки и «груза нет».", "operationId": "UnpublishedLoadResponses_GetResponsesForAllUnpublishedLoads", "parameters": [ { "name": "dateFrom", "in": "query", "description": "Возвращать отзывы начиная с этой даты. Без параметра возвращаются все отзывы. Дату указывайте в UTC: значение без часового пояса читается как московское время (UTC+3).", "schema": { "type": "string", "format": "date-time", "nullable": true }, "x-position": 1, "example": "2026-09-01T00:00:00.000Z" } ], "responses": { "200": { "description": "Отзывы на архивные грузы фирмы.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NewLoadResponseViewStandart" } } } } }, "403": { "description": "Фирме закрыт доступ к отзывам.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfAccessDeniedException" } } } } }, "security": [ { "Bearer": [] } ] } }, "/v1.0/unpublished-loads/new/{loadId}/responses": { "get": { "tags": [ "Отзывы на архивные грузы (новая структура)" ], "summary": "Получение отзывов на конкретный архивный груз фирмы.", "description": "API для интеграции. По грузу вашей фирмы возвращаются все отзывы целиком. Возвращаются отзывы всех типов: встречные предложения, жалобы, озвученные ставки и «груза нет».\nПо чужому грузу видны только актуальные отзывы, и только если владелец их не скрыл; контакты и примечания чужих отзывов скрыты, ваш отзыв — целиком.", "operationId": "UnpublishedLoadResponses_GetResponsesForUnpublishedLoad", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "Идентификатор груза.", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "name": "dateFrom", "in": "query", "description": "Возвращать отзывы начиная с этой даты. Без параметра возвращаются все отзывы. Дату указывайте в UTC: значение без часового пояса читается как московское время (UTC+3).", "schema": { "type": "string", "format": "date-time", "nullable": true }, "x-position": 2, "example": "2026-09-01T00:00:00.000Z" } ], "responses": { "200": { "description": "Отзывы на архивный груз.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NewLoadResponseViewStandart" } } } } }, "403": { "description": "Фирме закрыт доступ к отзывам или чужой груз ей не виден.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfAccessDeniedException" } } } }, "404": { "description": "Архивный груз не найден.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfLoadNotFoundException" } } } } }, "security": [ { "Bearer": [] } ] }, "delete": { "tags": [ "Отзывы на архивные грузы (новая структура)" ], "summary": "Удаление встречных предложений на своём архивном грузе.", "description": "API для интеграции. Удаляются встречные предложения на вашем архивном грузе; чужие грузы метод не затрагивает.", "operationId": "UnpublishedLoadResponses_DeleteCounterOfferFromOwnUnpublishedLoadDELETE", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "Идентификатор груза.", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "name": "ids", "in": "query", "style": "form", "explode": true, "description": "Идентификаторы встречных предложений на вашем архивном грузе.", "schema": { "type": "array", "items": { "type": "string", "format": "guid" } }, "x-position": 2, "example": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] } ], "responses": { "200": { "description": "Статусы операций по отзывам. Ключ — идентификатор отзыва.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DeleteNewResponseOperationStatusView" } }, "example": { "3fa85f64-5717-4562-b3fc-2c963f66afa6": { "Status": 0, "Message": "Успех" } } } } }, "403": { "description": "Фирме закрыт доступ к отзывам или груз не ваш.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfAccessDeniedException" } } } }, "404": { "description": "Архивный груз или отзыв не найден.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfResponseNotFoundException" } } } } }, "security": [ { "Bearer": [] } ] } }, "/v1.0/unpublished-loads/new/responses/by-ids": { "get": { "tags": [ "Отзывы на архивные грузы (новая структура)" ], "summary": "Получение отзывов на заданные архивные грузы фирмы в виде словаря.", "description": "API для интеграции. Повторы в списке грузов схлопываются. У груза с доступом к отзывам статус 0 и список отзывов всех типов;\nу чужих отзывов контакт и примечание скрыты. Без доступа или для несуществующего груза вместо списка приходит статус ошибки.", "operationId": "UnpublishedLoadResponses_GetResponsesForUnpublishedLoadsByIds", "parameters": [ { "name": "dateFrom", "in": "query", "description": "Возвращать отзывы начиная с этой даты. Без параметра возвращаются все отзывы. Дату указывайте в UTC: значение без часового пояса читается как московское время (UTC+3).", "schema": { "type": "string", "format": "date-time", "nullable": true }, "x-position": 1, "example": "2026-09-01T00:00:00.000Z" }, { "name": "loadIds", "in": "query", "style": "form", "explode": true, "description": "Идентификаторы грузов, по которым нужны отзывы.", "schema": { "type": "array", "items": { "type": "string", "format": "guid" } }, "x-position": 2, "example": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] } ], "responses": { "200": { "description": "Отзывы по запрошенным архивным грузам. Ключ — идентификатор груза.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/NewResponseOperationStatusView" } }, "example": { "3fa85f64-5717-4562-b3fc-2c963f66afa6": { "Status": 0, "Message": "Ок", "Result": [] } } } } }, "400": { "description": "Список идентификаторов пуст или содержит неверный guid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfRequestValidationException" } } } }, "403": { "description": "Фирме закрыт доступ к отзывам.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfAccessDeniedException" } } } } }, "security": [ { "Bearer": [] } ] } }, "/v1.0/unpublished-loads/by_meta/{loadMetaId}": { "get": { "tags": [ "Архивные грузы" ], "summary": "Получение архивных грузов по метаданным.", "description": "API для интеграции. Возвращаются все архивные грузы фирмы с этим идентификатором метаданных.", "operationId": "UnpublishedLoads_GetLoadsByMetaId", "parameters": [ { "name": "loadMetaId", "in": "path", "required": true, "description": "Идентификатор метаданных публикации.", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { "description": "Архивные грузы одной публикации.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LoadView" } } } } } }, "security": [ { "Bearer": [] } ] } }, "/v2/cargos": { "post": { "tags": [ "Грузы" ], "summary": "Создать заявку на груз.", "description": "API для интеграции. Публикует новую заявку на груз от имени текущего пользователя.", "requestBody": { "description": "Данные заявки на груз.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCargoApplicationPublicRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCargoApplicationPublicRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateCargoApplicationPublicRequest" } } }, "required": true }, "responses": { "200": { "description": "Заявка на груз успешно создана и опубликована.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/CreateCargoApplicationPublicResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/CreateCargoApplicationPublicResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCargoApplicationPublicResponse" } } } }, "400": { "description": "Невалидные данные запроса.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } }, "402": { "description": "Недостаточно средств на счёте для размещения.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } }, "403": { "description": "Нет прав на размещение или кошелёк заблокирован.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } }, "404": { "description": "Связанный ресурс не найден.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } }, "409": { "description": "Обнаружен дубликат заявки.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } }, "417": { "description": "Изменилась цена размещения.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } }, "429": { "description": "Достигнут ежедневный лимит публикации грузов.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } } }, "security": [ { "ApiSecret": [] }, { "Bearer": [] }, { "AuthenticatedUserId": [] } ] } }, "/v1.0/loads": { "post": { "tags": [ "Грузы" ], "summary": "Добавление груза.", "description": "API для интеграции. Груз публикуется от имени фирмы и контакта, для которых выпущен токен.\nОтвет содержит сохранённый груз с проставленными идентификаторами и датами.", "operationId": "Loads_Post", "requestBody": { "x-name": "load", "description": "Груз.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InsertLoadDto" } } }, "required": true, "x-position": 1 }, "responses": { "200": { "description": "Сохранённый груз.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadView" } } } }, "400": { "description": "Тело запроса не разобрано или поля не прошли проверку.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValidationErrorView" } } } }, "402": { "description": "Не хватает средств на платное размещение на выбранных площадках.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfPaidPlacementLowBalanceException" } } } }, "403": { "description": "Фирме или контакту запрещено публиковать грузы; причина — кодом в ответе.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadAccessDeniedErrorView" } } } }, "409": { "description": "Среди опубликованных грузов фирмы уже есть такой же.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadConflictErrorView" } } } }, "429": { "description": "Исчерпан дневной лимит публикаций фирмы.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfDailyLoadsCreationLimitReachedException" } } } } }, "security": [ { "Bearer": [] } ] }, "get": { "tags": [ "Грузы" ], "summary": "Получение всех грузов фирмы.", "description": "API для интеграции. Отдаются только опубликованные грузы фирмы, от имени которой выпущен токен; архивные лежат в unpublished-loads.\nБез contactId возвращаются грузы всех контактов фирмы.", "operationId": "Loads_GetAll", "parameters": [ { "name": "contactId", "in": "query", "description": "Идентификатор контакта.", "schema": { "type": "integer", "format": "int32", "nullable": true }, "x-position": 1, "example": 0 } ], "responses": { "200": { "description": "Грузы фирмы.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LoadView" } } } } }, "404": { "description": "Контакт не найден в фирме.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfContactNotFoundException" } } } } }, "security": [ { "Bearer": [] } ] }, "delete": { "tags": [ "Грузы" ], "summary": "Снятие нескольких грузов с публикации.", "description": "API для интеграции. Грузы обрабатываются по отдельности: отказ по одному не отменяет удаление остальных.", "operationId": "Loads_DeleteDELETE", "parameters": [ { "name": "ids", "in": "query", "style": "form", "explode": true, "description": "Идентификаторы грузов.", "schema": { "type": "array", "items": { "type": "string", "format": "guid" } }, "x-position": 1, "example": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] } ], "responses": { "200": { "description": "Статусы операций по грузам. Ключ — идентификатор груза; при отказе статус несёт ключ и причину ошибки.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/GroupOperationStatusView" } }, "example": { "3fa85f64-5717-4562-b3fc-2c963f66afa6": { "Status": 0, "Message": "Успех" } } } } }, "400": { "description": "Список идентификаторов пуст.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfRequestValidationException" } } } } }, "security": [ { "Bearer": [] } ] } }, "/v2/cargos/{cargoApplicationId}": { "put": { "tags": [ "Грузы" ], "summary": "Редактировать опубликованную заявку на груз.", "description": "API для интеграции. Редактирует опубликованную заявку от имени текущего пользователя.", "parameters": [ { "name": "cargoApplicationId", "in": "path", "description": "Идентификатор редактируемой заявки на груз.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody": { "description": "Новые данные заявки на груз.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCargoApplicationPublicRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCargoApplicationPublicRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateCargoApplicationPublicRequest" } } }, "required": true }, "responses": { "200": { "description": "Заявка на груз успешно обновлена.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UpdateCargoApplicationPublicResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCargoApplicationPublicResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCargoApplicationPublicResponse" } } } }, "400": { "description": "Невалидные данные запроса или груз в лоте.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } }, "402": { "description": "Недостаточно средств на счёте для размещения.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } }, "403": { "description": "Кошелёк заблокирован.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } }, "404": { "description": "Заявка на груз не найдена.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } }, "409": { "description": "Обнаружен дубликат заявки.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } }, "417": { "description": "Изменилась цена размещения.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } }, "423": { "description": "Слишком рано для повторного редактирования.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } } }, "security": [ { "ApiSecret": [] }, { "Bearer": [] }, { "AuthenticatedUserId": [] } ] }, "get": { "tags": [ "Грузы" ], "summary": "Получить опубликованную заявку на груз.", "description": "API для интеграции. Возвращает опубликованную заявку на груз текущего пользователя.", "parameters": [ { "name": "cargoApplicationId", "in": "path", "description": "Идентификатор заявки на груз.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { "description": "Заявка на груз найдена и возвращена.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PublicCargoApplicationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PublicCargoApplicationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PublicCargoApplicationResponse" } } } }, "404": { "description": "Заявка на груз не найдена.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } } }, "security": [ { "ApiSecret": [] }, { "Bearer": [] }, { "AuthenticatedUserId": [] } ] } }, "/v1.0/loads/{loadId}": { "put": { "tags": [ "Грузы" ], "summary": "Редактирование груза.", "description": "API для интеграции. Тело задаёт итоговое состояние груза целиком, а не только изменённые поля.", "operationId": "Loads_PutPUT", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "Идентификатор груза.", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody": { "x-name": "load", "description": "Груз.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditLoadDto" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "Отредактированный груз.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadView" } } } }, "400": { "description": "Тело запроса не разобрано или поля не прошли проверку.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValidationErrorView" } } } }, "402": { "description": "Не хватает средств на платное размещение на выбранных площадках.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfPaidPlacementLowBalanceException" } } } }, "403": { "description": "Нет доступа к грузу; при повторном редактировании раньше разрешённого интервала — ключ `load_update_delay_not_elapsed` без кода причины.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadAccessDeniedErrorView" } } } }, "404": { "description": "Груз не найден среди опубликованных грузов фирмы.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfLoadNotFoundException" } } } }, "409": { "description": "Среди опубликованных грузов фирмы уже есть такой же.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadConflictErrorView" } } } } }, "security": [ { "Bearer": [] } ] }, "get": { "tags": [ "Грузы" ], "summary": "Получение груза по идентификатору.", "description": "API для интеграции. Отдаётся только опубликованный груз вашей фирмы; чужой или архивный груз отвечает 404.", "operationId": "Loads_Get", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "Идентификатор груза.", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { "description": "Груз.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadView" } } } }, "404": { "description": "Груз не найден среди опубликованных грузов фирмы.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfLoadNotFoundException" } } } } }, "security": [ { "Bearer": [] } ] }, "delete": { "tags": [ "Грузы" ], "summary": "Снятие груза с публикации.", "description": "API для интеграции. Груз снимается с публикации и переносится в архив, откуда его можно восстановить методами unpublished-loads.", "operationId": "Loads_DeleteDELETE2", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "Идентификатор груза.", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { "description": "Статус операции по грузу. Ключ — идентификатор груза.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/OperationStatus" } }, "example": { "3fa85f64-5717-4562-b3fc-2c963f66afa6": { "Status": 0, "Message": "Успешная операция" } } } } }, "400": { "description": "Идентификатор груза пуст.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfRequestValidationException" } } } }, "403": { "description": "Нет доступа к грузу.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadAccessDeniedErrorView" } } } }, "404": { "description": "Груз не найден среди опубликованных грузов фирмы.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfLoadNotFoundException" } } } } }, "security": [ { "Bearer": [] } ] } }, "/v2/cargos/{requestedCargoApplicationId}/refresh": { "put": { "tags": [ "Грузы" ], "summary": "Обновить заявку на груз.", "description": "API для интеграции. Поднимает в поисковой выдаче одну опубликованную заявку.", "parameters": [ { "name": "requestedCargoApplicationId", "in": "path", "description": "Идентификатор обновляемой заявки на груз.", "required": true, "schema": { "type": "string", "format": "uuid" }, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { "description": "Заявка на груз успешно обновлена.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RefreshCargoApplicationPublicResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RefreshCargoApplicationPublicResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RefreshCargoApplicationPublicResponse" } } } }, "403": { "description": "Нет прав на обновление заявки.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } }, "404": { "description": "Заявка на груз не найдена.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } }, "423": { "description": "Слишком рано для повторного обновления.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } } }, "security": [ { "ApiSecret": [] }, { "Bearer": [] }, { "AuthenticatedUserId": [] } ] } }, "/v1.0/loads/{loadId}/renew": { "put": { "tags": [ "Грузы" ], "summary": "Обновление груза, чтобы он поднялся в выдаче.", "description": "API для интеграции. Повторное обновление раньше разрешённого интервала отклоняется статусом операции по грузу, а не ошибкой запроса.", "operationId": "Loads_RenewPUT", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "Идентификатор груза.", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { "description": "Статус операции по грузу. Ключ — идентификатор груза.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/OperationStatus" } }, "example": { "3fa85f64-5717-4562-b3fc-2c963f66afa6": { "Status": 0, "Message": "Успешная операция" } } } } }, "400": { "description": "Идентификатор груза пуст.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfRequestValidationException" } } } } }, "security": [ { "Bearer": [] } ] } }, "/v2/cargos/refresh": { "put": { "tags": [ "Грузы" ], "summary": "Обновить несколько заявок на груз.", "description": "API для интеграции. Поднимает в поисковой выдаче указанные опубликованные заявки. Максимум — 100 идентификаторов за один запрос.", "requestBody": { "description": "Идентификаторы заявок на груз для обновления.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "example": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] }, "text/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "example": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] }, "application/*+json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "example": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] } }, "required": true }, "responses": { "200": { "description": "Результат обновления по каждой заявке.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RefreshCargoApplicationPublicResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RefreshCargoApplicationPublicResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RefreshCargoApplicationPublicResponse" } } } }, "400": { "description": "Превышен лимит количества грузов в запросе.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } }, "403": { "description": "Нет прав на обновление одной или нескольких заявок.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } }, "404": { "description": "Одна или несколько заявок не найдены.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } }, "423": { "description": "Слишком рано для повторного обновления.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } } }, "security": [ { "ApiSecret": [] }, { "Bearer": [] }, { "AuthenticatedUserId": [] } ] } }, "/v1.0/loads/renew": { "put": { "tags": [ "Грузы" ], "summary": "Обновление нескольких грузов, чтобы они поднялись в выдаче.", "description": "API для интеграции. Грузы обрабатываются по отдельности: отказ по одному не отменяет обновление остальных.", "operationId": "Loads_RenewPUT2", "parameters": [ { "name": "ids", "in": "query", "style": "form", "explode": true, "description": "Идентификаторы грузов.", "schema": { "type": "array", "items": { "type": "string", "format": "guid" } }, "x-position": 1, "example": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] } ], "responses": { "200": { "description": "Статусы операций по грузам. Ключ — идентификатор груза.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/OperationStatus" } }, "example": { "3fa85f64-5717-4562-b3fc-2c963f66afa6": { "Status": 0, "Message": "Успех" } } } } }, "400": { "description": "Список идентификаторов пуст или содержит неверный guid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfRequestValidationException" } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/cargos_create_v2/integration/v2/cargos/archive": { "put": { "tags": [ "Грузы" ], "summary": "Отправить несколько заявок на груз в архив.", "description": "API для интеграции. Снимает опубликованные заявки с площадок и переводит их в архив. Максимум — 100 идентификаторов за один запрос.", "requestBody": { "description": "Идентификаторы заявок на груз для архивации.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArchiveCargoApplicationsIntegrationRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ArchiveCargoApplicationsIntegrationRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ArchiveCargoApplicationsIntegrationRequest" } } }, "required": true }, "responses": { "200": { "description": "Результат архивации по каждой заявке.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/cargos_v2__ArchiveCargoApplicationsIntegrationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/cargos_v2__ArchiveCargoApplicationsIntegrationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/cargos_v2__ArchiveCargoApplicationsIntegrationResponse" } } } }, "400": { "description": "Пустой массив id или превышен лимит количества грузов в запросе.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } }, "403": { "description": "Нет прав на архивацию одной или нескольких заявок.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } }, "404": { "description": "Одна или несколько заявок не найдены.", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseDetails" } } } } }, "security": [ { "ApiSecret": [] }, { "Bearer": [] }, { "AuthenticatedUserId": [] } ] } }, "/v1.0/loads/{loadId}/priority": { "put": { "tags": [ "Грузы" ], "summary": "Изменение параметров приоритетного показа у груза.", "description": "API для интеграции. Приоритетный показ платный: списания идут с виртуального баланса фирмы.\nПустое тело или нулевая ставка ничего не меняют: отключает приоритетный показ только DELETE.", "operationId": "Loads_SavePriorityPUT", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "Идентификатор груза.", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody": { "x-name": "priority", "description": "Параметры приоритетного показа.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadPriorityView" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "Груз после изменения приоритетного показа.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadView" } } } }, "400": { "description": "Параметры не прошли проверку.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValidationErrorView" } } } }, "403": { "description": "Нет доступа к грузу.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadAccessDeniedErrorView" } } } }, "404": { "description": "Груз не найден среди опубликованных грузов фирмы.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfLoadNotFoundException" } } } } }, "security": [ { "Bearer": [] } ] }, "delete": { "tags": [ "Грузы" ], "summary": "Обнуление параметров приоритетного показа у груза.", "description": "API для интеграции. Отключает приоритетный показ; сам груз остаётся опубликованным.", "operationId": "Loads_DeletePriorityDELETE", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "Идентификатор груза.", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { "description": "Груз после отключения приоритетного показа.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadView" } } } }, "403": { "description": "Нет доступа к грузу.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadAccessDeniedErrorView" } } } }, "404": { "description": "Груз не найден среди опубликованных грузов фирмы.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfLoadNotFoundException" } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/cargos-priority-view-api/v2/cargos/{cargoApplicationId}/priority-view": { "put": { "tags": [ "cargos-priority-view-api", "public", "UpsertCargosPriorityPublic" ], "description": "Сохранение или обновление настроек приоритетного показа на груз", "operationId": "POST-v2/cargos/{cargoApplicationId}/priority-view", "parameters": [ { "name": "cargoApplicationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/UpsertPriorityViewPublicRequest" } ] } } }, "required": true }, "responses": { "200": { "description": "Success" } } }, "delete": { "tags": [ "cargos-priority-view-api", "public", "DeleteCargosPriorityPublic" ], "description": "Удаление настроек приоритетного показа с груза", "operationId": "DELETE-v2/cargos/{cargoApplicationId}/priority-view", "parameters": [ { "name": "cargoApplicationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Success" } } } }, "/v1.0/loads/comments": { "get": { "tags": [ "Грузы" ], "summary": "Получение всех комментариев фирмы ко всем грузам.", "description": "API для интеграции. Возвращаются комментарии вашей фирмы ко всем её опубликованным грузам.", "operationId": "Loads_GetCommentsForAllLoads", "responses": { "200": { "description": "Комментарии фирмы по грузам. Ключ — идентификатор груза.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/Comment" } } }, "example": { "3fa85f64-5717-4562-b3fc-2c963f66afa6": [] } } } } }, "security": [ { "Bearer": [] } ] } }, "/v1.0/loads/{loadId}/comments": { "get": { "tags": [ "Грузы" ], "summary": "Получение комментариев фирмы к грузу.", "description": "API для интеграции. Комментарий виден только фирме, которая его оставила: чужие комментарии к тому же грузу не возвращаются.", "operationId": "Loads_GetLoadComments", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "Идентификатор груза.", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { "description": "Комментарии фирмы к грузу.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Comment" } } } } }, "404": { "description": "Груз не найден среди опубликованных грузов фирмы.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfLoadNotFoundException" } } } } }, "security": [ { "Bearer": [] } ] }, "put": { "tags": [ "Грузы" ], "summary": "Добавление либо редактирование комментария к грузу.", "description": "API для интеграции. Повторный вызов заменяет комментарий фирмы к этому грузу, а не добавляет ещё один.", "operationId": "Loads_UpsertLoadCommentPUT", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "Идентификатор груза.", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody": { "x-name": "comment", "description": "Комментарий.", "content": { "application/json": { "schema": { "type": "string" }, "example": "Договорились на понедельник" } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "Сохранённый комментарий.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Comment" } } } }, "400": { "description": "Комментарий пустой или длиннее 128 символов.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfRequestValidationException" } } } }, "404": { "description": "Груз не найден среди опубликованных грузов фирмы.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfLoadNotFoundException" } } } } }, "security": [ { "Bearer": [] } ] }, "delete": { "tags": [ "Грузы" ], "summary": "Удаление комментария у груза.", "description": "API для интеграции. Удаляется комментарий вашей фирмы; на сам груз и на чужие комментарии вызов не влияет.", "operationId": "Loads_DeleteLoadCommentDELETE", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "Идентификатор груза.", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { "description": "Комментарий удалён.", "content": { "application/json": { "schema": { "type": "string" } } } }, "404": { "description": "Груз или комментарий фирмы к нему не найден.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfLoadNotFoundException" } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers": { "post": { "tags": [ "Встречные предложения" ], "summary": "Создание встречного предложения", "operationId": "CounterOffer_Create", "parameters": [ { "name": "cargoId", "in": "path", "required": true, "description": "ID груза", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody": { "x-name": "cargoCounterOfferDto", "description": "Данные встречного предложения", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CargoCounterOfferIntegratorDto" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CargoCounterOfferIntegratorView" } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Код ошибки", "example": "string" }, "reason": { "type": "string", "description": "Причина ошибки", "nullable": true, "example": "string" }, "details": { "type": "array", "description": "Детали ошибки", "nullable": true, "items": { "$ref": "#/components/schemas/ExceptionDetailView" } } } } } } } }, "security": [ { "Bearer": [] } ] }, "delete": { "tags": [ "Встречные предложения" ], "summary": "Удаление чужих встречных предложений для своего груза", "operationId": "CounterOffer_DeleteCounterOffersFromOwnCargo", "parameters": [ { "name": "cargoId", "in": "path", "required": true, "description": "ID груза", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody": { "x-name": "counterOfferIds", "description": "ID встречных предложений", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "guid" } } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/OperationStatusIntegratorViewOfCargoCounterOfferIntegratorView" } } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Код ошибки", "example": "string" }, "reason": { "type": "string", "description": "Причина ошибки", "nullable": true, "example": "string" }, "details": { "type": "array", "description": "Детали ошибки", "nullable": true, "items": { "$ref": "#/components/schemas/ExceptionDetailView" } } } } } } } }, "security": [ { "Bearer": [] } ] }, "get": { "tags": [ "Встречные предложения" ], "summary": "Получение встречных предложений для опубликованного груза", "operationId": "CounterOffer_GetCounterOffersForPublishedCargo", "parameters": [ { "name": "cargoId", "in": "path", "required": true, "description": "ID груза", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "name": "fromDate", "in": "query", "description": "Дата с которой вернуть встречные предложения", "schema": { "type": "string", "format": "date-time", "nullable": true }, "x-position": 2, "example": "2024-01-01T00:00:00+00:00" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CargoCounterOfferIntegratorView" } } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Код ошибки", "example": "string" }, "reason": { "type": "string", "description": "Причина ошибки", "nullable": true, "example": "string" }, "details": { "type": "array", "description": "Детали ошибки", "nullable": true, "items": { "$ref": "#/components/schemas/ExceptionDetailView" } } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers/{id}": { "put": { "tags": [ "Встречные предложения" ], "summary": "Обновление встречного предложения", "operationId": "CounterOffer_Update", "parameters": [ { "name": "cargoId", "in": "path", "required": true, "description": "ID груза", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "name": "id", "in": "path", "required": true, "description": "ID встречного предложения", "schema": { "type": "string", "format": "guid" }, "x-position": 2, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody": { "x-name": "cargoCounterOfferDto", "description": "Данные встречного предложения", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CargoCounterOfferIntegratorDto" } } }, "required": true, "x-position": 3 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CargoCounterOfferIntegratorView" } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Код ошибки", "example": "string" }, "reason": { "type": "string", "description": "Причина ошибки", "nullable": true, "example": "string" }, "details": { "type": "array", "description": "Детали ошибки", "nullable": true, "items": { "$ref": "#/components/schemas/ExceptionDetailView" } } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/cargo-counter-offers-api/integrator/v1/cargos/{cargoId}/counter-offers/my": { "delete": { "tags": [ "Встречные предложения" ], "summary": "Удаление своих встречных предложений для чужого опубликованного груза", "operationId": "CounterOffer_DeleteOwnCounterOffersFromCargo", "parameters": [ { "name": "cargoId", "in": "path", "required": true, "description": "ID груза", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "204": { "description": "" }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Код ошибки", "example": "string" }, "reason": { "type": "string", "description": "Причина ошибки", "nullable": true, "example": "string" }, "details": { "type": "array", "description": "Детали ошибки", "nullable": true, "items": { "$ref": "#/components/schemas/ExceptionDetailView" } } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/cargo-counter-offers-api/integrator/v1/cargos/counter-offers": { "get": { "tags": [ "Встречные предложения" ], "summary": "Получение встречных предложений для всех опубликованных грузов", "operationId": "CounterOffer_GetCounterOffersForAllPublishedCargos", "parameters": [ { "name": "fromDate", "in": "query", "description": "Дата с которой вернуть встречные предложения", "schema": { "type": "string", "format": "date-time", "nullable": true }, "x-position": 1, "example": "2024-01-01T00:00:00+00:00" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CargoCounterOfferIntegratorView" } } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Код ошибки", "example": "string" }, "reason": { "type": "string", "description": "Причина ошибки", "nullable": true, "example": "string" }, "details": { "type": "array", "description": "Детали ошибки", "nullable": true, "items": { "$ref": "#/components/schemas/ExceptionDetailView" } } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/cargo-counter-offers-api/integrator/v1/cargos/counter-offers/by-cargo-ids": { "get": { "tags": [ "Встречные предложения" ], "summary": "Получение встречных предложений для опубликованных грузов по их ID", "operationId": "CounterOffer_GetCounterOffersForPublishedCargosByIds", "parameters": [ { "name": "dateFrom", "in": "query", "description": "Дата с которой вернуть встречные предложения", "schema": { "type": "string", "format": "date-time", "nullable": true }, "x-position": 1, "example": "2024-01-01T00:00:00+00:00" }, { "name": "onlyActual", "in": "query", "description": "Только актуальные встречные предложения", "schema": { "type": "boolean" }, "x-position": 2, "example": false }, { "name": "cargoIds", "in": "query", "style": "form", "explode": true, "description": "ID грузов", "schema": { "type": "array", "items": { "type": "string", "format": "guid" } }, "x-position": 3, "example": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/OperationStatusIntegratorViewOfListOfCargoCounterOfferIntegratorView" } } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Код ошибки", "example": "string" }, "reason": { "type": "string", "description": "Причина ошибки", "nullable": true, "example": "string" }, "details": { "type": "array", "description": "Детали ошибки", "nullable": true, "items": { "$ref": "#/components/schemas/ExceptionDetailView" } } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/cargo-counter-offers-api/integrator/v1/cargos/counter-offers/statuses": { "get": { "tags": [ "Встречные предложения" ], "summary": "Получение статусов своих встречных предложений на чужие грузы", "operationId": "CounterOffer_GetCargoCounterOffersStatuses", "parameters": [ { "name": "dateFrom", "in": "query", "description": "Дата с которой вернуть статусы", "schema": { "type": "string", "format": "date-time", "nullable": true }, "x-position": 1, "example": "2024-01-01T00:00:00+00:00" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CargoCounterOfferStatusIntegratorView" } } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Код ошибки", "example": "string" }, "reason": { "type": "string", "description": "Причина ошибки", "nullable": true, "example": "string" }, "details": { "type": "array", "description": "Детали ошибки", "nullable": true, "items": { "$ref": "#/components/schemas/ExceptionDetailView" } } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/cargo-counter-offers-api/integrator/v1/cargos/counter-offers/{id}": { "get": { "tags": [ "Встречные предложения" ], "summary": "Получение встречного предложения по его ID", "operationId": "CounterOffer_GetCounterOfferById", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "ID встречного предложения", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CargoCounterOfferIntegratorView" } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Код ошибки", "example": "string" }, "reason": { "type": "string", "description": "Причина ошибки", "nullable": true, "example": "string" }, "details": { "type": "array", "description": "Детали ошибки", "nullable": true, "items": { "$ref": "#/components/schemas/ExceptionDetailView" } } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/cargo-counter-offers-api/integrator/v1/cargos/unpublished/counter-offers": { "get": { "tags": [ "Встречные предложения" ], "summary": "Получение встречных предложений для неопубликованных грузов", "operationId": "CounterOffer_GetCounterOffersByLoadIdsAll", "parameters": [ { "name": "fromDate", "in": "query", "description": "Дата с которой вернуть встречные предложения", "schema": { "type": "string", "format": "date-time", "nullable": true }, "x-position": 1, "example": "2024-01-01T00:00:00+00:00" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CargoCounterOfferIntegratorView" } } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Код ошибки", "example": "string" }, "reason": { "type": "string", "description": "Причина ошибки", "nullable": true, "example": "string" }, "details": { "type": "array", "description": "Детали ошибки", "nullable": true, "items": { "$ref": "#/components/schemas/ExceptionDetailView" } } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/cargo-counter-offers-api/integrator/v1/cargos/unpublished/{cargoId}/counter-offers": { "get": { "tags": [ "Встречные предложения" ], "summary": "Получение встречных предложений для неопубликованного груза по его ID", "operationId": "CounterOffer_GetCounterOffersByCargoId", "parameters": [ { "name": "cargoId", "in": "path", "required": true, "description": "ID груза", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "name": "fromDate", "in": "query", "description": "Дата с которой вернуть встречные предложения", "schema": { "type": "string", "format": "date-time", "nullable": true }, "x-position": 2, "example": "2024-01-01T00:00:00+00:00" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CargoCounterOfferIntegratorView" } } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Код ошибки", "example": "string" }, "reason": { "type": "string", "description": "Причина ошибки", "nullable": true, "example": "string" }, "details": { "type": "array", "description": "Детали ошибки", "nullable": true, "items": { "$ref": "#/components/schemas/ExceptionDetailView" } } } } } } } }, "security": [ { "Bearer": [] } ] }, "delete": { "tags": [ "Встречные предложения" ], "summary": "Удаление встречных предложений для неопубликованного груза", "operationId": "CounterOffer_DeleteCounterOffersFromUnpublishedCargo", "parameters": [ { "name": "cargoId", "in": "path", "required": true, "description": "ID груза", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "name": "counterOfferIds", "in": "query", "style": "form", "explode": true, "description": "ID встречных предложений", "schema": { "type": "array", "items": { "type": "string", "format": "guid" } }, "x-position": 2, "example": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/OperationStatusIntegratorViewOfCargoCounterOfferIntegratorView" } } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Код ошибки", "example": "string" }, "reason": { "type": "string", "description": "Причина ошибки", "nullable": true, "example": "string" }, "details": { "type": "array", "description": "Детали ошибки", "nullable": true, "items": { "$ref": "#/components/schemas/ExceptionDetailView" } } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/cargo-counter-offers-api/integrator/v1/cargos/unpublished/counter-offers/by-cargo-ids": { "get": { "tags": [ "Встречные предложения" ], "summary": "Получение встречных предложений для неопубликованных грузов по их ID", "operationId": "CounterOffer_GetCounterOffersByLoadIds", "parameters": [ { "name": "cargoIds", "in": "query", "style": "form", "explode": true, "description": "ID грузов", "schema": { "type": "array", "items": { "type": "string", "format": "guid" } }, "x-position": 1, "example": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] }, { "name": "fromDate", "in": "query", "description": "Дата с которой вернуть встречные предложения", "schema": { "type": "string", "format": "date-time", "nullable": true }, "x-position": 2, "example": "2024-01-01T00:00:00+00:00" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/OperationStatusIntegratorViewOfListOfCargoCounterOfferIntegratorView" } } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Код ошибки", "example": "string" }, "reason": { "type": "string", "description": "Причина ошибки", "nullable": true, "example": "string" }, "details": { "type": "array", "description": "Детали ошибки", "nullable": true, "items": { "$ref": "#/components/schemas/ExceptionDetailView" } } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/v1.0/loads/new/responses": { "get": { "tags": [ "Отзывы на грузы (новая структура)" ], "summary": "Получение всех отзывов по всем грузам фирмы.", "description": "API для интеграции. Отдаются отзывы на опубликованные грузы фирмы, для которой выпущен токен. Возвращаются отзывы всех типов: встречные предложения, жалобы, озвученные ставки и «груза нет».", "operationId": "NewLoadResponses_GetResponsesForAllLoads", "parameters": [ { "name": "dateFrom", "in": "query", "description": "Возвращать отзывы начиная с этой даты. Без параметра возвращаются все отзывы. Дату указывайте в UTC: значение без часового пояса читается как московское время (UTC+3).", "schema": { "type": "string", "format": "date-time", "nullable": true }, "x-position": 1, "example": "2026-09-01T00:00:00.000Z" } ], "responses": { "200": { "description": "Отзывы на грузы фирмы.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NewLoadResponseViewStandart" } } } } }, "403": { "description": "Фирме закрыт доступ к отзывам.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfAccessDeniedException" } } } } }, "security": [ { "Bearer": [] } ] } }, "/v1.0/loads/new/{loadId}/responses": { "get": { "tags": [ "Отзывы на грузы (новая структура)" ], "summary": "Получение отзывов на конкретный груз фирмы.", "description": "API для интеграции. По грузу вашей фирмы возвращаются все отзывы целиком. Возвращаются отзывы всех типов: встречные предложения, жалобы, озвученные ставки и «груза нет».\nПо чужому грузу видны только актуальные отзывы, и только если владелец их не скрыл; контакты и примечания чужих отзывов скрыты, ваш отзыв — целиком.", "operationId": "NewLoadResponses_GetResponsesForLoad", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "Идентификатор груза.", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "name": "dateFrom", "in": "query", "description": "Возвращать отзывы начиная с этой даты. Без параметра возвращаются все отзывы. Дату указывайте в UTC: значение без часового пояса читается как московское время (UTC+3).", "schema": { "type": "string", "format": "date-time", "nullable": true }, "x-position": 2, "example": "2026-09-01T00:00:00.000Z" } ], "responses": { "200": { "description": "Отзывы на груз.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NewLoadResponseViewStandart" } } } } }, "403": { "description": "Фирме закрыт доступ к отзывам или чужой груз ей не виден.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfAccessDeniedException" } } } }, "404": { "description": "Груз не найден.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfLoadNotFoundException" } } } } }, "security": [ { "Bearer": [] } ] }, "put": { "tags": [ "Отзывы на грузы (новая структура)" ], "summary": "Добавление либо редактирование отзыва на чужой груз.", "description": "API для интеграции. У фирмы один отзыв на груз: повторный вызов заменяет предыдущий.\nФирма берётся из токена, груз — из адреса; одноимённые поля запроса игнорируются. Контакт передаётся в теле.", "operationId": "NewLoadResponses_UpsertResponsePUT", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "Идентификатор груза.", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody": { "x-name": "response", "description": "Отзыв на груз.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CounterOfferUpsertDto" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "Сохранённый отзыв.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewLoadResponseViewStandart" } } } }, "400": { "description": "Тело запроса не разобрано или поля не прошли проверку: например, ставка не совпадает с фиксированной ставкой груза.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValidationErrorView" } } } }, "403": { "description": "Фирме закрыт доступ к отзывам, груз ей не виден или это её собственный груз.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfAccessDeniedException" } } } }, "404": { "description": "Груз не найден.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfLoadNotFoundException" } } } } }, "security": [ { "Bearer": [] } ] }, "delete": { "tags": [ "Отзывы на грузы (новая структура)" ], "summary": "Удаление встречных предложений на своём грузе или своего отзыва на чужом.", "description": "API для интеграции. Без списка идентификаторов удаляется отзыв вашей фирмы на чужой груз; со списком — перечисленные встречные предложения на вашем грузе.", "operationId": "NewLoadResponses_DeleteResponseDELETE", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "Идентификатор груза.", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "name": "ids", "in": "query", "style": "form", "explode": true, "description": "Идентификаторы встречных предложений на вашем грузе. Без них удаляется ваш отзыв на чужом грузе.", "schema": { "type": "array", "items": { "type": "string", "format": "guid" } }, "x-position": 2, "example": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] } ], "responses": { "200": { "description": "Статусы операций по отзывам. Ключ — идентификатор отзыва. Без списка идентификаторов тело — только сообщение об удалении вашего отзыва.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/DeleteNewResponseOperationStatusView" } }, "example": { "3fa85f64-5717-4562-b3fc-2c963f66afa6": { "Status": 0, "Message": "Успех" } } } } }, "403": { "description": "Фирме закрыт доступ к отзывам или груз не ваш.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfAccessDeniedException" } } } }, "404": { "description": "Груз или отзыв не найден.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfResponseNotFoundException" } } } } }, "security": [ { "Bearer": [] } ] } }, "/v1.0/loads/new/responses/by-ids": { "get": { "tags": [ "Отзывы на грузы (новая структура)" ], "summary": "Получение отзывов на заданные грузы фирмы в виде словаря.", "description": "API для интеграции. Повторы в списке грузов схлопываются. У груза с доступом к отзывам статус 0 и список отзывов всех типов;\nу чужих отзывов контакт и примечание скрыты. Без доступа или для несуществующего груза вместо списка приходит статус ошибки.", "operationId": "NewLoadResponses_GetResponsesForLoadsByIds", "parameters": [ { "name": "dateFrom", "in": "query", "description": "Возвращать отзывы начиная с этой даты. Без параметра возвращаются все отзывы. Дату указывайте в UTC: значение без часового пояса читается как московское время (UTC+3).", "schema": { "type": "string", "format": "date-time", "nullable": true }, "x-position": 1, "example": "2026-09-01T00:00:00.000Z" }, { "name": "onlyActual", "in": "query", "description": "Возвращать только актуальные отзывы.", "schema": { "type": "boolean" }, "x-position": 2, "example": true }, { "name": "loadIds", "in": "query", "style": "form", "explode": true, "description": "Идентификаторы грузов, по которым нужны отзывы.", "schema": { "type": "array", "items": { "type": "string", "format": "guid" } }, "x-position": 3, "example": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] } ], "responses": { "200": { "description": "Отзывы по запрошенным грузам. Ключ — идентификатор груза.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/NewResponseOperationStatusView" } }, "example": { "3fa85f64-5717-4562-b3fc-2c963f66afa6": { "Status": 0, "Message": "Ок", "Result": [] } } } } }, "400": { "description": "Список идентификаторов пуст или содержит неверный guid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfRequestValidationException" } } } }, "403": { "description": "Фирме закрыт доступ к отзывам.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfAccessDeniedException" } } } } }, "security": [ { "Bearer": [] } ] } }, "/v1.0/loads/search/byboards": { "get": { "tags": [ "Грузы на площадках" ], "summary": "Поиск грузов, размещённых на указанных площадках.", "description": "API для интеграции. Площадка — закрытый список фирм, которым виден груз; в выдачу попадают и ваши грузы, и чужие.\nИскать можно только по площадкам, доступным вашей фирме; общая площадка исключена.", "operationId": "LoadsSearch_Get", "parameters": [ { "name": "boardIds", "in": "query", "style": "form", "explode": true, "description": "Идентификаторы закрытых площадок, по 24 символа. Пустой список — поиск по всем площадкам, доступным фирме.", "schema": { "type": "array", "items": { "type": "string" } }, "x-position": 1, "example": [ "5f1e2d3c4b5a69788796a5b4" ] } ], "responses": { "200": { "description": "Грузы, опубликованные на выбранных площадках.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LoadView" } } } } }, "400": { "description": "Идентификатор площадки не из 24 символов.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfRequestValidationException" } } } }, "403": { "description": "Среди площадок есть недоступная фирме, в том числе общая.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfBoardsAccessDeniedException" } } } } }, "security": [ { "Bearer": [] } ] } }, "/v1.0/loads/{loadId}/atidocs/{documentType}": { "post": { "tags": [ "Грузы" ], "summary": "Создание документа на груз в ATI.Docs.", "description": "API для интеграции. Допустимые значения типа документа отдаёт справочник documenttypes.", "operationId": "Loads_CreateDocument", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "Идентификатор груза.", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "name": "documentType", "in": "path", "required": true, "description": "Тип документа из справочника documenttypes.", "schema": { "type": "string" }, "x-position": 2, "example": "заказ" }, { "name": "templateId", "in": "query", "description": "Идентификатор шаблона документа.", "schema": { "type": "string" }, "x-position": 3, "example": "12345" } ], "responses": { "200": { "description": "Созданный документ.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AtiDocsCreateLoadDocumentResponse" } } } }, "400": { "description": "Идентификатор груза пуст или тип документа не указан.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfRequestValidationException" } } } }, "404": { "description": "Груз не найден.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfLoadNotFoundException" } } } } }, "security": [ { "Bearer": [] } ] } }, "/messenger/1.1/chats/": { "post": { "tags": [ "Chats" ], "summary": "Создание чата", "requestBody": { "description": "Объект, описывающий новый чат", "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "channel_type", "name", "description" ], "properties": { "channel_type": { "type": "string", "enum": [ "dialog", "channel", "group", "ati_driver" ], "description": "тип чата" }, "name": { "type": "string", "description": "имя групп.чата/собеседника" }, "description": { "type": "string", "description": "описание" }, "id": { "type": "string", "description": "{ID аккаунта партнера}.{id контакта} (только для типов dialog, ati_driver)" }, "ati_id": { "type": "string", "description": "{код в ATI.SU партнера}.{id контакта} (только для типов dialog, ati_driver)" }, "is_open": { "type": "boolean", "description": "открытый/закрытый (только для типов channel, group)" }, "members": { "type": "array", "items": { "type": "string" }, "description": "alias'ы (коды в ATI.SU) партнеров с contact_id (только для типов channel, group)" } } }, "examples": { "group": { "value": { "channel_type": "group", "name": "Моя группа", "is_open": true, "description": "Описание моей группы" } }, "channel": { "value": { "channel_type": "channel", "name": "Мой канал", "is_open": true, "description": "Описание моего канала", "members": [ "123.4", "567.8" ] } }, "dialog_by_code": { "value": { "channel_type": "dialog", "name": "Моя компания", "ati_id": "777.0", "description": "Описание моего диалога" } }, "dialog_by_id": { "value": { "channel_type": "dialog", "name": "Моя компания", "id": "1423464.0", "description": "Описание моего диалога" } }, "ati_driver": { "value": { "channel_type": "ati_driver", "name": "Моя компания", "id": "1423464.0", "description": "Описание моего диалога" } } } } } }, "responses": { "200": { "description": "Данные подписки", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } } }, "400": { "description": "Ошибка валидации" } } } }, "/messenger/1.1/chats/{chat_id}/": { "put": { "tags": [ "Chats" ], "summary": "Обновление мета-данных группового чата", "parameters": [ { "in": "path", "name": "chat_id", "required": true, "schema": { "type": "string" }, "description": "id группового чата" } ], "requestBody": { "description": "Объект с измененными данными", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "имя групп.чата" }, "description": { "type": "string", "description": "описание" } } }, "examples": { "group": { "value": { "name": "Новое название группы", "description": "Новое описание моей группы" } } } } } }, "responses": { "200": { "description": "Обновленные данные подписки", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } } }, "400": { "description": "Ошибка валидации" }, "403": { "description": "Только владелец канала/группы может выполнять это действие" }, "404": { "description": "Чат не найден" } } }, "delete": { "tags": [ "Chats" ], "summary": "Удаление группового чата владельцем", "parameters": [ { "in": "path", "name": "chat_id", "required": true, "schema": { "type": "string" }, "description": "id группового чата" } ], "responses": { "204": { "description": "Канал удален" }, "403": { "description": "Пользователь не является владельцем группового чата" }, "404": { "description": "Не найден групповой чат или пользователь в этом чате" } } } }, "/messenger/1.2/subscriptions/": { "get": { "tags": [ "Subscriptions" ], "summary": "Получение всех подписок пользователя", "parameters": [ { "in": "query", "name": "type", "schema": { "type": "string", "enum": [ "channel", "dialog", "group", "groups" ] }, "description": "Необязательный тип подписок (channel, dialog, group, groups)" }, { "in": "query", "name": "limit", "schema": { "type": "integer", "minimum": 0, "maximum": 1000 }, "description": "По сколько чатов выводить на страницу" }, { "in": "query", "name": "before", "schema": { "type": "integer", "minimum": 0 }, "description": "Перед каким временем обновления чата (utime) в формате unix time (микросекунды) необходимо загружать список чатов", "examples": { "before_example": { "value": 1580326210000000, "summary": "Каналы которые последний раз обновились до 27 января 2020 года 19:30:10" } } }, { "in": "query", "name": "after", "schema": { "type": "integer", "minimum": 0 }, "description": "После какого времени обновления чата (utime) в формате unix time (микросекунды) необходимо загружать список чатов", "examples": { "after_example": { "value": 1580326210000000, "summary": "Каналы которые последний раз обновились после 27 января 2020 года 19:30:10" } } } ], "responses": { "200": { "description": "Подписки пользователя", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArrayOfSubscriptions" } } } } } } }, "/messenger/1.1/subscriptions/{chat_id}/": { "get": { "tags": [ "Subscriptions" ], "summary": "Получение информации о подписке", "parameters": [ { "in": "path", "name": "chat_id", "required": true, "schema": { "type": "string" }, "description": "id чата" } ], "responses": { "200": { "description": "Подписки пользователя", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } } }, "404": { "description": "Канал не найден" } } }, "patch": { "tags": [ "Subscriptions" ], "summary": "Принятие приглашения в групповой чат", "parameters": [ { "in": "path", "name": "chat_id", "required": true, "schema": { "type": "string" }, "description": "id групповой чат" } ], "responses": { "204": { "description": "Приглашение принято" }, "400": { "description": "У пользователя нет приглашения" }, "404": { "description": "Канал не найден" } } }, "delete": { "tags": [ "Subscriptions" ], "summary": "Удаление себя из группового чата или удаление приглашения", "parameters": [ { "in": "path", "name": "chat_id", "required": true, "schema": { "type": "string" }, "description": "id группового чата" } ], "responses": { "204": { "description": "Подписка на групповой чат удалена" }, "403": { "description": "Нельзя удалить администратора группового чата" }, "404": { "description": "Канал не найден" } } } }, "/messenger/1.1/chats/{chat_id}/users/": { "get": { "tags": [ "Chat Users" ], "summary": "Получение списка участников", "parameters": [ { "in": "path", "name": "chat_id", "required": true, "schema": { "type": "string" }, "description": "id группового чата" }, { "in": "query", "name": "start", "schema": { "type": "integer" }, "description": "Начало пагинации" }, { "in": "query", "name": "end", "schema": { "type": "integer" }, "description": "Конец пагинации" }, { "in": "query", "name": "with_invite", "schema": { "type": "boolean" }, "description": "Включить в список приглашенных пользователей" }, { "in": "query", "name": "invited", "schema": { "type": "boolean" }, "description": "Вернуть только приглашенных пользователей" } ], "responses": { "200": { "description": "Список участников", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArrayOfUsers" } } } }, "403": { "description": "У вас нет прав. Только администратор может совершать это действие." }, "404": { "description": "Канал не найден, Пользователь в групповом чате не найден" } } }, "post": { "tags": [ "Chat Users" ], "summary": "Приглашение нескольких пользователей в групповой чат", "parameters": [ { "in": "path", "name": "chat_id", "required": true, "schema": { "type": "string" }, "description": "id группового чата" }, { "in": "query", "name": "ati_id", "schema": { "type": "boolean" }, "description": "Использовать алиасы (коды в ATI.SU) с контактами в качестве user_id в поле members" } ], "requestBody": { "description": "Объект, описывающий новый групповой чат", "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "members" ], "properties": { "members": { "type": "array", "items": { "type": "string" } } } } } } }, "responses": { "200": { "description": "Подписки добавленных пользователя", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } } }, "400": { "description": "Пользователь не является владельцем группового чата, Канал был удален, Код пользователя задан в неверном формате" }, "403": { "description": "У вас нет прав. Только администратор может совершать это действие." }, "404": { "description": "Группа не найдена" } } } }, "/messenger/1.1/chats/{chat_id}/users/{user_id}/": { "post": { "tags": [ "Chat Users" ], "summary": "Приглашение пользователя в групповой чат", "parameters": [ { "in": "path", "name": "chat_id", "required": true, "schema": { "type": "string" }, "description": "id группового чата" }, { "in": "path", "name": "user_id", "required": true, "schema": { "type": "string" }, "description": "firm_id юзера с контактом" }, { "in": "query", "name": "ati_id", "schema": { "type": "boolean" }, "description": "Использовать алиас (код в ATI.SU) с контактом в качестве user_id" } ], "responses": { "200": { "description": "Подписка добавленного пользователя", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } } }, "400": { "description": "Пользователь не является владельцем группового чата, Канал был удален, Код пользователя задан в неверном формате" }, "403": { "description": "У вас нет прав. Только администратор может совершать это действие." }, "404": { "description": "Группа не найдена" } } }, "delete": { "tags": [ "Chat Users" ], "summary": "Исключение участника из группового чата", "parameters": [ { "in": "path", "name": "chat_id", "required": true, "schema": { "type": "string" }, "description": "id группового чата" }, { "in": "path", "name": "user_id", "required": true, "schema": { "type": "string" }, "description": "id пользователя" }, { "in": "query", "name": "ati_id", "schema": { "type": "boolean" }, "description": "Использовать алиас (код в ATI.SU) с контактом в качестве user_id" } ], "responses": { "204": { "description": "Подписка удалена" }, "400": { "description": "Код пользователя задан в неверном формате" }, "403": { "description": "Пользователь не является владельцем группового чата, Групповой чат был удален" }, "404": { "description": "Канал не найден" } } } }, "/messenger/1.1/chats/{chat_id}/history/": { "get": { "tags": [ "Chat History" ], "summary": "Получение истории сообщений", "description": "Возвращает список сообщений из эластика", "parameters": [ { "name": "chat_id", "in": "path", "description": "id чата", "required": true, "schema": { "type": "string" } }, { "name": "before", "in": "query", "description": "timestamp, до которого вернуть список сообщений (с пагинацией)", "required": false, "schema": { "type": "integer" }, "example": 1553154991842130 }, { "name": "num", "in": "query", "description": "Ограничить количество выдаваемых сообщений", "schema": { "type": "integer" }, "example": 10 }, { "name": "since", "in": "query", "description": "timestamp, с которого вернуть список сообщений (с пагинацией)", "required": false, "schema": { "type": "integer" }, "example": 1553154991842130 }, { "name": "with_ts", "in": "query", "description": "включить в ответ timestamp прочитанности последнего сообщения", "schema": { "type": "boolean" }, "example": 1 } ], "responses": { "200": { "description": "список сообщения", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArrayOfMessages" } } } } } }, "delete": { "tags": [ "Chat History" ], "summary": "Очистка истории", "parameters": [ { "name": "chat_id", "in": "path", "description": "id чата", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Возвращает объект подписки с обновленным tail и ts", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } } } } } }, "/messenger/1.2/chats/{chat_id}/messages": { "post": { "tags": [ "Messages" ], "summary": "Отправка сообщения", "parameters": [ { "in": "path", "name": "chat_id", "required": true, "schema": { "type": "string" }, "description": "id чата" }, { "in": "formData", "name": "text", "required": false, "schema": { "type": "string" }, "description": "Текст сообщения" }, { "in": "formData", "name": "image_height", "required": false, "schema": { "type": "integer" }, "description": "Высота прикреплённой картинки" }, { "in": "formData", "name": "image_width", "required": false, "schema": { "type": "integer" }, "description": "Ширина прикреплённой картинки" }, { "in": "formData", "name": "geo_longitude", "required": false, "schema": { "type": "number" }, "description": "Долгота для гео-метки в градусах" }, { "in": "formData", "name": "geo_latitude", "required": false, "schema": { "type": "number" }, "description": "Широта для гео-метки в градусах" }, { "in": "formData", "name": "geo_zoom", "required": false, "schema": { "type": "number" }, "description": "Масштаб для гео-метки" } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary", "description": "Прикреплённый файл" }, "image": { "type": "string", "format": "binary", "description": "Прикреплённая картинка" } } } } } }, "responses": { "200": { "description": "json сообщения", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } } } } } }, "/messenger/1.2/messages/{message_id}/image": { "get": { "tags": [ "Messages" ], "summary": "Получение прикреплённого к сообщению изображения", "parameters": [ { "in": "path", "name": "message_id", "required": true, "schema": { "type": "string" }, "description": "id сообщения" }, { "in": "query", "name": "height", "required": false, "schema": { "type": "integer" }, "description": "требуемая высота картинки (по умолчанию используется исходная высота)" }, { "in": "query", "name": "width", "required": false, "schema": { "type": "integer" }, "description": "требуемая ширина картинки (по умолчанию используется исходная ширина)" }, { "name": "biggest_side", "in": "query", "description": "требуемый размер наибольшего измерения картинки (по умолчанию используется исходный размер)", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Картинка, прикреплённая к сообщению" } } } }, "/messenger/1.2/messages/{message_id}/file": { "get": { "tags": [ "Messages" ], "summary": "Получение прикреплённого к сообщению файла", "parameters": [ { "name": "message_id", "in": "path", "description": "id сообщения", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Файл, прикреплённый к сообщению" } } } }, "/messenger/1.1/chats/{chat_id}/settings/": { "post": { "tags": [ "Chats" ], "summary": "Изменение настроек подписки", "description": "Скрытость(hidden), запиненность(pin) в значениях true/false.", "parameters": [ { "name": "chat_id", "in": "path", "description": "id чата", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Объект с изменяемой настройкой", "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "pin": { "type": "boolean" }, "hidden": { "type": "boolean" } } }, "examples": { "both": { "value": { "pin": true, "hidden": false }, "description": "Изменить сразу оба параметра" }, "only_one": { "value": { "pin": true }, "description": "Изменить один параметр" } } } } }, "responses": { "200": { "description": "Возвращает объект подписки с обновленными настройками", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } } }, "400": { "description": "Ошибка валидации" }, "403": { "description": "Скрыть канал можно только после принятия приглашения" }, "404": { "description": "Канал не найден" } } } }, "/messenger/1.1/chats/{chat_id}/messages/{ts_or_id}/": { "delete": { "tags": [ "Chat Messages" ], "summary": "Удаление сообщения из диалога", "description": "Использует timestamp либо id для идентификации сообещния", "parameters": [ { "name": "chat_id", "in": "path", "description": "id чата", "required": true, "schema": { "type": "string" } }, { "name": "ts_or_id", "in": "path", "description": "timestamp либо id удаляемого сообщений", "required": true, "schema": { "oneOf": [ { "type": "string" }, { "type": "integer" } ], "example": [ 1553154991842130, "5b42d88fea1cb745d23db8d7b9de11da5473ad61" ] } } ], "responses": { "200": { "description": "Возвращает объект подписки с обновленным tail и ts", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Subscription" } } } } } } }, "/messenger/1.1/inbox/": { "get": { "tags": [ "Root" ], "summary": "Получение счетчика чатов с непрочитанными сообщениями", "responses": { "200": { "description": "Счетчик непрочитанных", "content": { "application/json": { "schema": { "type": "object", "properties": { "unread": { "type": "integer" } } } } } } } } }, "/messenger/1.1/subscriptions/unread/": { "get": { "tags": [ "Subscriptions" ], "summary": "Получение количества непрочитанных чатов по типам (все/диалоги/групповые чаты)", "parameters": [ { "in": "query", "name": "with_messages", "schema": { "type": "string" }, "description": "Если true, то возвращает дополнительно количество непрочитанных сообщений." } ], "responses": { "200": { "description": "Данные по количеству непрочитанных чатов по типу", "content": { "application/json": { "schema": { "type": "object", "properties": { "all": { "type": "integer" }, "dialogs": { "type": "integer" }, "groups": { "type": "integer" } } } } } } } } }, "/v1/driver/public/presence": { "post": { "tags": [ "DriverIntegrator" ], "summary": "Получение данных о водителе из приложения АТИ Водитель по номеру телефона", "parameters": [ { "name": "X-API-Secret", "in": "header", "required": true, "schema": { "type": "string" }, "example": "924480d5-2704-4f36-b4be-4854b8d587e5" }, { "name": "X-Authenticated-Userid", "in": "header", "required": true, "schema": { "type": "string" }, "example": "14612.0" }, { "name": "X-Ati-Code", "in": "header", "schema": { "type": "string" }, "example": "14612" }, { "name": "X-Ati-User-Attributes", "in": "header", "schema": { "type": "string" }, "example": "0" }, { "name": "X-Ati-User-Attributes2", "in": "header", "schema": { "type": "string" }, "example": "0" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.RequestModels.PublicDriverPresenceRequest" }, "example": { "phones": [ "79338508858", "79031234567" ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.RequestModels.PublicDriverPresenceRequest" }, "example": { "phones": [ "79338508858", "79031234567" ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.RequestModels.PublicDriverPresenceRequest" }, "example": { "phones": [ "79338508858", "79031234567" ] } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.RequestModels.PublicDriverPresenceRequest" }, "example": { "phones": [ "79338508858", "79031234567" ] } } } }, "responses": { "200": { "description": "Данные о водителях", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.ResponseModels.PublicDriverPresenceResponse" } }, "example": [ { "phone": "79338508858", "initial_phone": "79338508858", "last_active": "2024-06-15T10:30:00Z", "has_tracker": true, "sms_invite_status": { "invite_sent": false, "contact_name": null, "ati_id": null, "contact_id": null, "sms_status": "Empty", "when": null } }, { "phone": "79031234567", "initial_phone": "89031234567", "last_active": null, "has_tracker": false, "sms_invite_status": { "invite_sent": true, "contact_name": "Иванов Иван", "ati_id": 14612, "contact_id": 0, "sms_status": "Sent", "when": "2024-06-10T14:00:00Z" } } ] }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.ResponseModels.PublicDriverPresenceResponse" } }, "example": [ { "phone": "79338508858", "initial_phone": "79338508858", "last_active": "2024-06-15T10:30:00Z", "has_tracker": true, "sms_invite_status": { "invite_sent": false, "contact_name": null, "ati_id": null, "contact_id": null, "sms_status": "Empty", "when": null } }, { "phone": "79031234567", "initial_phone": "89031234567", "last_active": null, "has_tracker": false, "sms_invite_status": { "invite_sent": true, "contact_name": "Иванов Иван", "ati_id": 14612, "contact_id": 0, "sms_status": "Sent", "when": "2024-06-10T14:00:00Z" } } ] }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.ResponseModels.PublicDriverPresenceResponse" } }, "example": [ { "phone": "79338508858", "initial_phone": "79338508858", "last_active": "2024-06-15T10:30:00Z", "has_tracker": true, "sms_invite_status": { "invite_sent": false, "contact_name": null, "ati_id": null, "contact_id": null, "sms_status": "Empty", "when": null } }, { "phone": "79031234567", "initial_phone": "89031234567", "last_active": null, "has_tracker": false, "sms_invite_status": { "invite_sent": true, "contact_name": "Иванов Иван", "ati_id": 14612, "contact_id": 0, "sms_status": "Sent", "when": "2024-06-10T14:00:00Z" } } ] } } }, "400": { "description": "Невалидный запрос. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "required_parameter_not_set", "reason": "Не задано обязательное поле phones" } } } }, "401": { "description": "Ошибка авторизации. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "unauthorized_user", "reason": "Не удалось авторизовать пользователя." } } } } } } }, "/v1/driver/public/invite": { "post": { "tags": [ "UserInfoIntegrator" ], "summary": "Отправка SMS-приглашения водителю для установки приложения АТИ Водитель", "parameters": [ { "name": "X-API-Secret", "in": "header", "required": true, "schema": { "type": "string" }, "example": "924480d5-2704-4f36-b4be-4854b8d587e5" }, { "name": "X-Authenticated-Userid", "in": "header", "required": true, "schema": { "type": "string" }, "example": "14612.0" }, { "name": "X-Ati-Code", "in": "header", "schema": { "type": "string" }, "example": "14612" }, { "name": "X-Ati-User-Attributes", "in": "header", "schema": { "type": "string" }, "example": "0" }, { "name": "X-Ati-User-Attributes2", "in": "header", "schema": { "type": "string" }, "example": "0" } ], "requestBody": { "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.RequestModels.InviteUserByPhoneRequest" }, "example": { "Phone": "+7(933)8508858" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.RequestModels.InviteUserByPhoneRequest" }, "example": { "Phone": "+7(933)8508858" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.RequestModels.InviteUserByPhoneRequest" }, "example": { "Phone": "+7(933)8508858" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.RequestModels.InviteUserByPhoneRequest" }, "example": { "Phone": "+7(933)8508858" } } } }, "responses": { "200": { "description": "Результат отправки приглашения", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.ResponseModels.SmsInviteResponse" }, "example": { "ok": true, "details": "Сегодня вами было отправлено приглашений: 1" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.ResponseModels.SmsInviteResponse" }, "example": { "ok": true, "details": "Сегодня вами было отправлено приглашений: 1" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.ResponseModels.SmsInviteResponse" }, "example": { "ok": true, "details": "Сегодня вами было отправлено приглашений: 1" } } } }, "400": { "description": "Невалидный запрос. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "required_parameter_not_set", "reason": "Не задано обязательное поле phones" } } } }, "401": { "description": "Ошибка авторизации. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "unauthorized_user", "reason": "Не удалось авторизовать пользователя." } } } }, "429": { "description": "Превышен лимит запросов. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "sms_invites_limit_reached", "reason": "Превышен лимит отправки смс-приглашений." } } } } } } }, "/gw/driver/v1/carrier/deals/{dealId}/transportations": { "get": { "tags": [ "Заказы" ], "summary": "Получить данные о перевозке водителя для ГП", "parameters": [ { "name": "dealId", "in": "path", "description": "GUID заказа. Получить из [API заказов](https://ati.su/developers/api/orders/deals/)", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-API-Secret", "in": "header", "required": true, "schema": { "type": "string" }, "example": "924480d5-2704-4f36-b4be-4854b8d587e5" }, { "name": "X-Authenticated-Userid", "in": "header", "required": true, "schema": { "type": "string" }, "example": "14612.0" }, { "name": "X-Ati-Code", "in": "header", "schema": { "type": "string" }, "example": "14612" }, { "name": "X-Ati-User-Attributes", "in": "header", "schema": { "type": "string" }, "example": "0" }, { "name": "X-Ati-User-Attributes2", "in": "header", "schema": { "type": "string" }, "example": "0" } ], "responses": { "200": { "description": "Маршрут перевозки", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.ResponseModels.Transportation.Points.TransportationPointResponse" } }, "example": [ { "deal_point_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "ordinal_id": 1, "time": "09:00", "date": "20.06.2024", "time_to": "12:00", "date_to": "20.06.2024", "lat": 55.7558, "lon": 37.6173, "address": "г. Москва, ул. Примерная, д. 1", "city_id": 3611, "region_id": 151, "country_id": 1, "point_type": 1, "contact_persons": [ { "name": "Иванов Иван", "phone": "+7(495)123-45-67", "ordinal_id": 1 } ], "note": "Погрузка", "timeslots_warehouse_id": 12345, "organization_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901" } ] }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.ResponseModels.Transportation.Points.TransportationPointResponse" } }, "example": [ { "deal_point_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "ordinal_id": 1, "time": "09:00", "date": "20.06.2024", "time_to": "12:00", "date_to": "20.06.2024", "lat": 55.7558, "lon": 37.6173, "address": "г. Москва, ул. Примерная, д. 1", "city_id": 3611, "region_id": 151, "country_id": 1, "point_type": 1, "contact_persons": [ { "name": "Иванов Иван", "phone": "+7(495)123-45-67", "ordinal_id": 1 } ], "note": "Погрузка", "timeslots_warehouse_id": 12345, "organization_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901" } ] }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.ResponseModels.Transportation.Points.TransportationPointResponse" } }, "example": [ { "deal_point_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "ordinal_id": 1, "time": "09:00", "date": "20.06.2024", "time_to": "12:00", "date_to": "20.06.2024", "lat": 55.7558, "lon": 37.6173, "address": "г. Москва, ул. Примерная, д. 1", "city_id": 3611, "region_id": 151, "country_id": 1, "point_type": 1, "contact_persons": [ { "name": "Иванов Иван", "phone": "+7(495)123-45-67", "ordinal_id": 1 } ], "note": "Погрузка", "timeslots_warehouse_id": 12345, "organization_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901" } ] } } }, "400": { "description": "Невалидный запрос. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "required_parameter_not_set", "reason": "Не задано обязательное поле phones" } } } }, "401": { "description": "Ошибка авторизации. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "unauthorized_user", "reason": "Не удалось авторизовать пользователя." } } } }, "403": { "description": "Доступ запрещён. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "deal_access_denied_error", "reason": "Отказано в доступе: Действие доступно только перевозчику" } } } }, "404": { "description": "Ресурс не найден. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "deal_not_found_error", "reason": "Заказ не найден" } } } } } }, "post": { "tags": [ "Заказы" ], "summary": "Отправить маршрут перевозки водителю для ГП", "description": "Перед вызовом переведите заказ в исполнение — см. [API заказов](https://ati.su/developers/api/orders/deals/)", "parameters": [ { "name": "dealId", "in": "path", "description": "GUID заказа. Получить из [API заказов](https://ati.su/developers/api/orders/deals/)", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-API-Secret", "in": "header", "required": true, "schema": { "type": "string" }, "example": "924480d5-2704-4f36-b4be-4854b8d587e5" }, { "name": "X-Authenticated-Userid", "in": "header", "required": true, "schema": { "type": "string" }, "example": "14612.0" }, { "name": "X-Ati-Code", "in": "header", "schema": { "type": "string" }, "example": "14612" }, { "name": "X-Ati-User-Attributes", "in": "header", "schema": { "type": "string" }, "example": "0" }, { "name": "X-Ati-User-Attributes2", "in": "header", "schema": { "type": "string" }, "example": "0" } ], "requestBody": { "description": "Точки маршрута перевозки", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.RequestModels.Transportation.Points.TransportationPointRequest" } }, "example": [ { "deal_point_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "ordinal_id": 1, "city_id": 3611, "region_id": 151, "country_id": 1, "point_type": "loading", "organization_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "time": "09:00", "date": "20.06.2024", "time_to": "12:00", "date_to": "20.06.2024", "lat": 55.7558, "lon": 37.6173, "address": "г. Москва, ул. Примерная, д. 1", "contact_persons": [ { "name": "Иванов Иван", "phone": "+7(495)123-45-67", "ordinal_id": 1 } ], "note": "Погрузка", "timeslots_warehouse_id": 12345 } ] }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.RequestModels.Transportation.Points.TransportationPointRequest" } }, "example": [ { "deal_point_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "ordinal_id": 1, "city_id": 3611, "region_id": 151, "country_id": 1, "point_type": "loading", "organization_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "time": "09:00", "date": "20.06.2024", "time_to": "12:00", "date_to": "20.06.2024", "lat": 55.7558, "lon": 37.6173, "address": "г. Москва, ул. Примерная, д. 1", "contact_persons": [ { "name": "Иванов Иван", "phone": "+7(495)123-45-67", "ordinal_id": 1 } ], "note": "Погрузка", "timeslots_warehouse_id": 12345 } ] }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.RequestModels.Transportation.Points.TransportationPointRequest" } }, "example": [ { "deal_point_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "ordinal_id": 1, "city_id": 3611, "region_id": 151, "country_id": 1, "point_type": "loading", "organization_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "time": "09:00", "date": "20.06.2024", "time_to": "12:00", "date_to": "20.06.2024", "lat": 55.7558, "lon": 37.6173, "address": "г. Москва, ул. Примерная, д. 1", "contact_persons": [ { "name": "Иванов Иван", "phone": "+7(495)123-45-67", "ordinal_id": 1 } ], "note": "Погрузка", "timeslots_warehouse_id": 12345 } ] }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.RequestModels.Transportation.Points.TransportationPointRequest" } }, "example": [ { "deal_point_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "ordinal_id": 1, "city_id": 3611, "region_id": 151, "country_id": 1, "point_type": "loading", "organization_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "time": "09:00", "date": "20.06.2024", "time_to": "12:00", "date_to": "20.06.2024", "lat": 55.7558, "lon": 37.6173, "address": "г. Москва, ул. Примерная, д. 1", "contact_persons": [ { "name": "Иванов Иван", "phone": "+7(495)123-45-67", "ordinal_id": 1 } ], "note": "Погрузка", "timeslots_warehouse_id": 12345 } ] } }, "required": true }, "responses": { "200": { "description": "Маршрут перевозки", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.ResponseModels.Transportation.Points.TransportationPointResponse" } }, "example": [ { "deal_point_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "ordinal_id": 1, "time": "09:00", "date": "20.06.2024", "time_to": "12:00", "date_to": "20.06.2024", "lat": 55.7558, "lon": 37.6173, "address": "г. Москва, ул. Примерная, д. 1", "city_id": 3611, "region_id": 151, "country_id": 1, "point_type": 1, "contact_persons": [ { "name": "Иванов Иван", "phone": "+7(495)123-45-67", "ordinal_id": 1 } ], "note": "Погрузка", "timeslots_warehouse_id": 12345, "organization_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901" } ] }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.ResponseModels.Transportation.Points.TransportationPointResponse" } }, "example": [ { "deal_point_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "ordinal_id": 1, "time": "09:00", "date": "20.06.2024", "time_to": "12:00", "date_to": "20.06.2024", "lat": 55.7558, "lon": 37.6173, "address": "г. Москва, ул. Примерная, д. 1", "city_id": 3611, "region_id": 151, "country_id": 1, "point_type": 1, "contact_persons": [ { "name": "Иванов Иван", "phone": "+7(495)123-45-67", "ordinal_id": 1 } ], "note": "Погрузка", "timeslots_warehouse_id": 12345, "organization_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901" } ] }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.ResponseModels.Transportation.Points.TransportationPointResponse" } }, "example": [ { "deal_point_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "ordinal_id": 1, "time": "09:00", "date": "20.06.2024", "time_to": "12:00", "date_to": "20.06.2024", "lat": 55.7558, "lon": 37.6173, "address": "г. Москва, ул. Примерная, д. 1", "city_id": 3611, "region_id": 151, "country_id": 1, "point_type": 1, "contact_persons": [ { "name": "Иванов Иван", "phone": "+7(495)123-45-67", "ordinal_id": 1 } ], "note": "Погрузка", "timeslots_warehouse_id": 12345, "organization_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901" } ] } } }, "400": { "description": "Невалидный запрос. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "required_parameter_not_set", "reason": "Не задано обязательное поле phones" } } } }, "401": { "description": "Ошибка авторизации. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "unauthorized_user", "reason": "Не удалось авторизовать пользователя." } } } }, "403": { "description": "Доступ запрещён. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "deal_access_denied_error", "reason": "Отказано в доступе: Действие доступно только перевозчику" } } } }, "404": { "description": "Ресурс не найден. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "deal_not_found_error", "reason": "Заказ не найден" } } } } } }, "put": { "tags": [ "Заказы" ], "summary": "Изменить маршрут перевозки водителю для ГП", "parameters": [ { "name": "dealId", "in": "path", "description": "GUID заказа. Получить из [API заказов](https://ati.su/developers/api/orders/deals/)", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-API-Secret", "in": "header", "required": true, "schema": { "type": "string" }, "example": "924480d5-2704-4f36-b4be-4854b8d587e5" }, { "name": "X-Authenticated-Userid", "in": "header", "required": true, "schema": { "type": "string" }, "example": "14612.0" }, { "name": "X-Ati-Code", "in": "header", "schema": { "type": "string" }, "example": "14612" }, { "name": "X-Ati-User-Attributes", "in": "header", "schema": { "type": "string" }, "example": "0" }, { "name": "X-Ati-User-Attributes2", "in": "header", "schema": { "type": "string" }, "example": "0" } ], "requestBody": { "description": "Точки маршрута перевозки", "content": { "application/json-patch+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.RequestModels.Transportation.Points.TransportationPointRequest" } }, "example": [ { "deal_point_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "ordinal_id": 1, "city_id": 3611, "region_id": 151, "country_id": 1, "point_type": "loading", "organization_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "time": "09:00", "date": "20.06.2024", "time_to": "12:00", "date_to": "20.06.2024", "lat": 55.7558, "lon": 37.6173, "address": "г. Москва, ул. Примерная, д. 1", "contact_persons": [ { "name": "Иванов Иван", "phone": "+7(495)123-45-67", "ordinal_id": 1 } ], "note": "Погрузка", "timeslots_warehouse_id": 12345 } ] }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.RequestModels.Transportation.Points.TransportationPointRequest" } }, "example": [ { "deal_point_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "ordinal_id": 1, "city_id": 3611, "region_id": 151, "country_id": 1, "point_type": "loading", "organization_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "time": "09:00", "date": "20.06.2024", "time_to": "12:00", "date_to": "20.06.2024", "lat": 55.7558, "lon": 37.6173, "address": "г. Москва, ул. Примерная, д. 1", "contact_persons": [ { "name": "Иванов Иван", "phone": "+7(495)123-45-67", "ordinal_id": 1 } ], "note": "Погрузка", "timeslots_warehouse_id": 12345 } ] }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.RequestModels.Transportation.Points.TransportationPointRequest" } }, "example": [ { "deal_point_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "ordinal_id": 1, "city_id": 3611, "region_id": 151, "country_id": 1, "point_type": "loading", "organization_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "time": "09:00", "date": "20.06.2024", "time_to": "12:00", "date_to": "20.06.2024", "lat": 55.7558, "lon": 37.6173, "address": "г. Москва, ул. Примерная, д. 1", "contact_persons": [ { "name": "Иванов Иван", "phone": "+7(495)123-45-67", "ordinal_id": 1 } ], "note": "Погрузка", "timeslots_warehouse_id": 12345 } ] }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.RequestModels.Transportation.Points.TransportationPointRequest" } }, "example": [ { "deal_point_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "ordinal_id": 1, "city_id": 3611, "region_id": 151, "country_id": 1, "point_type": "loading", "organization_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901", "time": "09:00", "date": "20.06.2024", "time_to": "12:00", "date_to": "20.06.2024", "lat": 55.7558, "lon": 37.6173, "address": "г. Москва, ул. Примерная, д. 1", "contact_persons": [ { "name": "Иванов Иван", "phone": "+7(495)123-45-67", "ordinal_id": 1 } ], "note": "Погрузка", "timeslots_warehouse_id": 12345 } ] } }, "required": true }, "responses": { "200": { "description": "Маршрут перевозки", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.ResponseModels.Transportation.Points.TransportationPointResponse" } }, "example": [ { "deal_point_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "ordinal_id": 1, "time": "09:00", "date": "20.06.2024", "time_to": "12:00", "date_to": "20.06.2024", "lat": 55.7558, "lon": 37.6173, "address": "г. Москва, ул. Примерная, д. 1", "city_id": 3611, "region_id": 151, "country_id": 1, "point_type": 1, "contact_persons": [ { "name": "Иванов Иван", "phone": "+7(495)123-45-67", "ordinal_id": 1 } ], "note": "Погрузка", "timeslots_warehouse_id": 12345, "organization_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901" } ] }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.ResponseModels.Transportation.Points.TransportationPointResponse" } }, "example": [ { "deal_point_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "ordinal_id": 1, "time": "09:00", "date": "20.06.2024", "time_to": "12:00", "date_to": "20.06.2024", "lat": 55.7558, "lon": 37.6173, "address": "г. Москва, ул. Примерная, д. 1", "city_id": 3611, "region_id": 151, "country_id": 1, "point_type": 1, "contact_persons": [ { "name": "Иванов Иван", "phone": "+7(495)123-45-67", "ordinal_id": 1 } ], "note": "Погрузка", "timeslots_warehouse_id": 12345, "organization_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901" } ] }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.ResponseModels.Transportation.Points.TransportationPointResponse" } }, "example": [ { "deal_point_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "ordinal_id": 1, "time": "09:00", "date": "20.06.2024", "time_to": "12:00", "date_to": "20.06.2024", "lat": 55.7558, "lon": 37.6173, "address": "г. Москва, ул. Примерная, д. 1", "city_id": 3611, "region_id": 151, "country_id": 1, "point_type": 1, "contact_persons": [ { "name": "Иванов Иван", "phone": "+7(495)123-45-67", "ordinal_id": 1 } ], "note": "Погрузка", "timeslots_warehouse_id": 12345, "organization_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901" } ] } } }, "400": { "description": "Невалидный запрос. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "required_parameter_not_set", "reason": "Не задано обязательное поле phones" } } } }, "401": { "description": "Ошибка авторизации. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "unauthorized_user", "reason": "Не удалось авторизовать пользователя." } } } }, "403": { "description": "Доступ запрещён. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "deal_access_denied_error", "reason": "Отказано в доступе: Действие доступно только перевозчику" } } } }, "404": { "description": "Ресурс не найден. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "deal_not_found_error", "reason": "Заказ не найден" } } } } } }, "delete": { "tags": [ "Заказы" ], "summary": "Отозвать маршрут перевозки у водителя для ГП", "parameters": [ { "name": "dealId", "in": "path", "description": "GUID заказа. Получить из [API заказов](https://ati.su/developers/api/orders/deals/)", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-API-Secret", "in": "header", "required": true, "schema": { "type": "string" }, "example": "924480d5-2704-4f36-b4be-4854b8d587e5" }, { "name": "X-Authenticated-Userid", "in": "header", "required": true, "schema": { "type": "string" }, "example": "14612.0" }, { "name": "X-Ati-Code", "in": "header", "schema": { "type": "string" }, "example": "14612" }, { "name": "X-Ati-User-Attributes", "in": "header", "schema": { "type": "string" }, "example": "0" }, { "name": "X-Ati-User-Attributes2", "in": "header", "schema": { "type": "string" }, "example": "0" } ], "responses": { "200": { "description": "Перевозка отозвана у водителя" }, "400": { "description": "Невалидный запрос. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "required_parameter_not_set", "reason": "Не задано обязательное поле phones" } } } }, "401": { "description": "Ошибка авторизации. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "unauthorized_user", "reason": "Не удалось авторизовать пользователя." } } } }, "403": { "description": "Доступ запрещён. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "deal_access_denied_error", "reason": "Отказано в доступе: Действие доступно только перевозчику" } } } }, "404": { "description": "Ресурс не найден. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "deal_not_found_error", "reason": "Заказ не найден" } } } } } } }, "/v1.2/orders/carrier/map_route/by_deal": { "get": { "tags": [ "АТИ Водитель" ], "summary": "Получение информации о пройденном маршруте АТИ Водителя", "description": "Возвращает информацию о маршруте, пройденном водителем с использованием приложения, а также о начальной, конечной и промежуточных точках маршрута.\nОтвет метода можно использовать, например, для отображения маршрута на карте.", "operationId": "Carrier_GetRoutedMapInfo", "parameters": [ { "name": "deal_id", "x-originalName": "dealId", "in": "query", "description": "Id Заказа", "schema": { "type": "string", "format": "guid" }, "x-position": 1 }, { "name": "south_west_lat", "x-originalName": "southWestLat", "in": "query", "description": "Широта юго-запад", "schema": { "type": "number", "format": "double" }, "x-position": 2 }, { "name": "south_west_lng", "x-originalName": "southWestLng", "in": "query", "description": "Долгота юго-запад", "schema": { "type": "number", "format": "double" }, "x-position": 3 }, { "name": "north_east_lat", "x-originalName": "northEastLat", "in": "query", "description": "Широта северо-восток", "schema": { "type": "number", "format": "double" }, "x-position": 4 }, { "name": "north_east_lng", "x-originalName": "northEastLng", "in": "query", "description": "Долгота северо-восток", "schema": { "type": "number", "format": "double" }, "x-position": 5 }, { "name": "zoom", "in": "query", "description": "Коэффициент масштабирования", "schema": { "type": "number", "format": "double" }, "x-position": 6 } ], "responses": { "200": { "description": "Информация для карты", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DealMapView" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/carrier/map/history": { "get": { "tags": [ "АТИ Водитель" ], "summary": "Получение истории", "description": "Массив событий, произошедших в пути следования водителя. Например: поломка, ДТП.", "operationId": "Carrier_GetHistory", "parameters": [ { "name": "deal_id", "x-originalName": "dealId", "in": "query", "description": "Id Заказа ", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "responses": { "200": { "description": "История выполнения заказа водителем", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MapHistoryView" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/carrier/{dealId}/tracker_access": { "post": { "tags": [ "АТИ Водитель" ], "summary": "Установка доступа грузовладельца к данным из АТИ Водителя.", "description": "По умолчанию грузовладелец не может следить за водителем на карте.\nС помощью метода можно открывать и закрывать грузовладельцу доступ к этой информации (данные, возвращаемые методом `/map/by_deal`).", "operationId": "Carrier_SetTrackerAccess", "parameters": [ { "name": "dealId", "in": "path", "required": true, "description": "Id Заказа", "schema": { "type": "string", "format": "guid" }, "x-position": 1 }, { "name": "value", "in": "query", "description": "Значение доступа\n \n* `0` — Запретить доступ\n* `1` — Разрешить доступ", "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TrackerOwnerAccess" } ] }, "x-position": 2 } ], "responses": { "200": { "description": "Успешное выполнение операции" }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1/driver/public/deal/users_activity": { "post": { "tags": [ "DealIntegrator" ], "summary": "Получение сводной информации об активности водителей по заказам", "parameters": [ { "name": "X-API-Secret", "in": "header", "required": true, "schema": { "type": "string" }, "example": "924480d5-2704-4f36-b4be-4854b8d587e5" }, { "name": "X-Authenticated-Userid", "in": "header", "required": true, "schema": { "type": "string" }, "example": "14612.0" }, { "name": "X-Ati-Code", "in": "header", "schema": { "type": "string" }, "example": "14612" }, { "name": "X-Ati-User-Attributes", "in": "header", "schema": { "type": "string" }, "example": "0" }, { "name": "X-Ati-User-Attributes2", "in": "header", "schema": { "type": "string" }, "example": "0" } ], "requestBody": { "description": "Список заказов и телефонов водителей", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.PublicModels.PublicDriverActivityRequest" }, "example": { "deals": [ { "phone": "+7(933)8508858", "deal_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.PublicModels.PublicDriverActivityRequest" }, "example": { "deals": [ { "phone": "+7(933)8508858", "deal_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" } ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.PublicModels.PublicDriverActivityRequest" }, "example": { "deals": [ { "phone": "+7(933)8508858", "deal_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" } ] } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.PublicModels.PublicDriverActivityRequest" }, "example": { "deals": [ { "phone": "+7(933)8508858", "deal_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" } ] } } }, "required": true }, "responses": { "200": { "description": "Активность водителей по заказам", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.PublicModels.PublicListDealsDigestResponse" }, "example": { "deals": [ { "deal_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "initial_phone": "+7(933)8508858", "phone": "79338508858", "tracker_offer_status": "sent", "reason_changing_offer_status": null, "status": "go_to_loading", "extended_status": "none", "tracker_finished_at": null, "last_active": "2024-06-15T10:30:00Z", "has_tracker": true, "last_location": { "lon": 37.6173, "lat": 55.7558, "events": [ { "type": "status", "tag": "go_to_loading", "date": "2024-06-15T10:25:00Z" } ] }, "gps_status_date": "2024-06-15T10:25:00Z" } ] } }, "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.PublicModels.PublicListDealsDigestResponse" }, "example": { "deals": [ { "deal_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "initial_phone": "+7(933)8508858", "phone": "79338508858", "tracker_offer_status": "sent", "reason_changing_offer_status": null, "status": "go_to_loading", "extended_status": "none", "tracker_finished_at": null, "last_active": "2024-06-15T10:30:00Z", "has_tracker": true, "last_location": { "lon": 37.6173, "lat": 55.7558, "events": [ { "type": "status", "tag": "go_to_loading", "date": "2024-06-15T10:25:00Z" } ] }, "gps_status_date": "2024-06-15T10:25:00Z" } ] } }, "text/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.PublicModels.PublicListDealsDigestResponse" }, "example": { "deals": [ { "deal_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890", "initial_phone": "+7(933)8508858", "phone": "79338508858", "tracker_offer_status": "sent", "reason_changing_offer_status": null, "status": "go_to_loading", "extended_status": "none", "tracker_finished_at": null, "last_active": "2024-06-15T10:30:00Z", "has_tracker": true, "last_location": { "lon": 37.6173, "lat": 55.7558, "events": [ { "type": "status", "tag": "go_to_loading", "date": "2024-06-15T10:25:00Z" } ] }, "gps_status_date": "2024-06-15T10:25:00Z" } ] } } } }, "400": { "description": "Невалидный запрос. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "required_parameter_not_set", "reason": "Не задано обязательное поле phones" } } } }, "401": { "description": "Ошибка авторизации. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "unauthorized_user", "reason": "Не удалось авторизовать пользователя." } } } }, "403": { "description": "Доступ запрещён. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "deal_access_denied_error", "reason": "Отказано в доступе: Действие доступно только перевозчику" } } } }, "404": { "description": "Ресурс не найден. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "deal_not_found_error", "reason": "Заказ не найден" } } } } } } }, "/v1.2/orders/{dealId}": { "get": { "tags": [ "Заказы" ], "summary": "Получение информации по Заказу", "description": "Позволяет получить Заказ, в котором пользователь принимает участие", "operationId": "Orders_GetOrderInfo", "parameters": [ { "name": "dealId", "in": "path", "required": true, "description": "Id Заказа", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "responses": { "200": { "description": "Возвращает информацию по Заказу", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderViewOfFullDealView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/search": { "post": { "tags": [ "Заказы" ], "summary": "Получение списка Заказов по фильтру", "description": "Позволяет список Заказов по указанным id грузов, если список пуст вернет все Заказы в которых пользователь принимает участие", "operationId": "Orders_GetOrders", "requestBody": { "x-name": "filter", "description": "Фильтр для получения заказов", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrderFilter2" } ] } } }, "x-position": 1 }, "responses": { "200": { "description": "Возвращает информацию о Заказах по фильтру", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OrderViewOfFullDealView" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/{dealId}/decline": { "delete": { "tags": [ "Заказы" ], "summary": "Отклонение Заказа с выбором действия", "description": "Грузовладелец может отклонить Заказ в согласовании, в том числе с\nсозданными документами через АТИ-Доки.\nПри отклонении Заказа можно выбрать, что сделать с грузом:\n1= выставить груз без Торгов,\n2 = перенести груз в Архив.\n3 = сменить победителя, если в Торгах были еще участники\n4 = восстановить груз и перезапустить Торги, если они были запущены", "operationId": "Orders_Decline2", "parameters": [ { "name": "dealId", "in": "path", "required": true, "description": "Id заказа", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "requestBody": { "x-name": "declineOrderDto", "description": "Причина отмены + действие после", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DeclineOrderIntegratorsDto" } ] } } }, "x-position": 2 }, "responses": { "200": { "description": "Успешное отклонение заказа", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } }, "security": [ { "JWT": [] } ] } }, "/v2/orders/unilateral": { "post": { "tags": [ "Заказы" ], "summary": "Создание и изменение заявки водителю.", "operationId": "Orders_SaveUnilateral", "requestBody": { "x-name": "request", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SaveUnilateralOrderDtoNew" } ] } } }, "x-position": 1 }, "responses": { "200": { "description": "Возвращает информацию по Заказу", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnilateralOrderViewOfFullDealView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/get_orders_statuses": { "post": { "tags": [ "Заказы" ], "summary": "Получение статусов Заказов", "description": "Позволяет получить список статусов Заказов для указанных грузов", "operationId": "Orders_GetDealsStatusInfoByLoadsIds", "requestBody": { "x-name": "loadIds", "description": "Список Id грузов", "content": { "application/json": { "schema": { "type": "array", "nullable": true, "items": { "type": "string", "format": "guid" } } } }, "x-position": 1 }, "responses": { "200": { "description": "Возвращает объект _Id груза - список статусов связанных Заказов_", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/DealStatusView" } } } } } } }, "security": [ { "JWT": [] } ] } }, "/gw/driver/v1/transportations/{dealId}/status": { "post": { "tags": [ "Заказы" ], "summary": "Сменить статус перевозки по заказу", "parameters": [ { "name": "dealId", "in": "path", "description": "GUID заказа. Получить из [API заказов](https://ati.su/developers/api/orders/deals/)", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-API-Secret", "in": "header", "required": true, "schema": { "type": "string" }, "example": "924480d5-2704-4f36-b4be-4854b8d587e5" }, { "name": "X-Authenticated-Userid", "in": "header", "required": true, "schema": { "type": "string" }, "example": "14612.0" }, { "name": "X-Ati-Code", "in": "header", "schema": { "type": "string" }, "example": "14612" }, { "name": "X-Ati-User-Attributes", "in": "header", "schema": { "type": "string" }, "example": "0" }, { "name": "X-Ati-User-Attributes2", "in": "header", "schema": { "type": "string" }, "example": "0" } ], "requestBody": { "description": "Новый статус перевозки", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.RequestModels.TransportationStatuses.TransportationStatusRequest" }, "example": { "in_work_status": 1 } }, "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.RequestModels.TransportationStatuses.TransportationStatusRequest" }, "example": { "in_work_status": 1 } }, "text/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.RequestModels.TransportationStatuses.TransportationStatusRequest" }, "example": { "in_work_status": 1 } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.RequestModels.TransportationStatuses.TransportationStatusRequest" }, "example": { "in_work_status": 1 } } }, "required": true }, "responses": { "200": { "description": "Статус перевозки изменён", "content": { "text/plain": { "schema": { "type": "boolean" }, "example": true }, "application/json": { "schema": { "type": "boolean" }, "example": true }, "text/json": { "schema": { "type": "boolean" }, "example": true } } }, "400": { "description": "Невалидный запрос. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "required_parameter_not_set", "reason": "Не задано обязательное поле phones" } } } }, "401": { "description": "Ошибка авторизации. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "unauthorized_user", "reason": "Не удалось авторизовать пользователя." } } } }, "403": { "description": "Доступ запрещён. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "deal_access_denied_error", "reason": "Отказано в доступе: Действие доступно только перевозчику" } } } }, "404": { "description": "Ресурс не найден. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException" }, "example": { "error": "deal_not_found_error", "reason": "Заказ не найден" } } } } } } }, "/v1.2/orders/{dealId}/pay_docs": { "post": { "tags": [ "Заказы" ], "summary": "Изменение информации о статусе документов и оплаты", "description": "Позволяет установить статус документов и оплаты для Заказа.\nТребуется DealState Заказа `10` или `5`.", "operationId": "Orders_SetPaymentStatus", "parameters": [ { "name": "dealId", "in": "path", "required": true, "description": "Id Заказа", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "requestBody": { "x-name": "payDocs", "description": "Информация о статусе документов и оплаты", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PayDocsDto2" } ] } } }, "x-position": 2 }, "responses": { "200": { "description": "Успешное изменение статуса" }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/{dealId}/move_to_work": { "post": { "tags": [ "Заказы" ], "summary": "Создание Заказа без документов", "description": "Позволяет создать Заказ без оформления документов через АТИ-Доки сразу после того, как перевозчик пришлет вам предложение на перевозку.", "operationId": "Orders_MoveToWork", "parameters": [ { "name": "dealId", "in": "path", "required": true, "description": "ID Заказа", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "requestBody": { "x-name": "dto", "description": "Параметры Заказа", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrderToWorkDtoInbox" } ] } } }, "x-position": 2 }, "responses": { "200": { "description": "Успешное создание Заказа" }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/{dealId}/accept": { "post": { "tags": [ "Заказы" ], "summary": "Создание Заказа с документом через АТИ-Доки", "description": "Позволяет создать Заказ с документом через АТИ-Доки", "operationId": "Orders_Accept", "parameters": [ { "name": "dealId", "in": "path", "required": true, "description": "Id Заказа", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "requestBody": { "x-name": "dto", "description": "Данные грузовладельца для Заказа", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DealAcceptFromLoadIntegratorsDtoInbox" } ] } } }, "x-position": 2 }, "responses": { "200": { "description": "Параметры ссылки для открытия Заказа в АТИ-Доках", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentInfoShortView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/{dealId}/accept_file": { "post": { "tags": [ "Заказы" ], "summary": "Создание Заказа с документом через загрузку файла", "description": "Позволяет создать Заказ с документом через загрузку файла, содержащего информацию о заказе (адреса, контакты, сроки, стоимость перевозки, условия и др.)\nContent-Type: multipart/form-data", "operationId": "Orders_AcceptWithFile", "parameters": [ { "name": "dealId", "in": "path", "required": true, "description": "Id Заказа", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "document_type": { "type": "string", "nullable": true }, "requisite_id": { "type": "string", "format": "guid", "nullable": true }, "signer_id": { "type": "string", "format": "guid", "nullable": true }, "contract_number": { "type": "string", "nullable": true }, "contract_start_date": { "type": "string", "format": "date-time", "nullable": true }, "attachment": { "type": "string", "format": "binary", "nullable": true } } } } } }, "responses": { "200": { "description": "Параметры ссылки для открытия Заказа", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentInfoShortView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/takeload/{loadId}": { "post": { "tags": [ "Заказы" ], "summary": "Взятие груза / Редактирование Заказа", "description": "Взятие груза возможно в том случае, если пользователь является победителем Торгов (аукциона), получил приглашение от грузовладельца или состоит на площадке, где опубликован груз.", "operationId": "Orders_TakeLoad", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "Id груза", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "requestBody": { "x-name": "loadTakeInfoIntegratorsDto", "description": "Параметры Заказа", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/LoadTakeInfoIntegratorsDto" } ] } } }, "x-position": 2 }, "responses": { "200": { "description": "Успешное взятие/редактирование", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderViewOfFullDealView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/{dealId}/finish": { "put": { "tags": [ "Заказы" ], "summary": "Завершение перевозки", "description": "Завершает перевозку\n\n*Завершить перевозку можно в том случае, если DealState Заказа `4`*", "operationId": "Orders_Finish", "parameters": [ { "name": "dealId", "in": "path", "required": true, "description": "Id Заказа", "schema": { "type": "string", "format": "guid" }, "x-position": 1 }, { "name": "waitPayment", "in": "query", "description": "При выставлении этого флага Заказ переносится на вкладку \"ДО и Оплата\"", "schema": { "type": "boolean" }, "x-position": 2 } ], "responses": { "200": { "description": "Успешное завершение" }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/driver": { "put": { "tags": [ "Заказы" ], "summary": "Смена Водителя в Заказе", "description": "Смена Водителя для Заказов без документов, созданных в системе АТИ-Доки.\nТребуется DealState Заказа `4`.\nСменить Водителя может как грузовладелец, так и перевозчик.", "operationId": "Orders_ChangeDriver", "requestBody": { "x-name": "dto", "description": "Информация о смене водителя", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ChangeDriverDto" } ] } } }, "x-position": 1 }, "responses": { "200": { "description": "Успешная смена водителя" }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/truck": { "put": { "tags": [ "Заказы" ], "summary": "Смена ТС в Заказе", "description": "Смена Транспортного Средства для Заказов без документов, созданных в системе АТИ-Доки.\nТребуется DealState Заказа `4`.\nСменить ТС может как грузовладелец, так и перевозчик.", "operationId": "Orders_ChangeTruck", "requestBody": { "x-name": "dto", "description": "Информация по смене ТС", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ChangeTruckDto" } ] } } }, "x-position": 1 }, "responses": { "200": { "description": "Успешная смена ТС" }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/rate": { "put": { "tags": [ "Заказы" ], "summary": "Изменение ставки в Заказе", "description": "Изменение ставки в Заказе без документов, созданных в системе АТИ-Доки.\nТребуется DealState Заказа `4` - В исполнении, `10` - Документы и Оплата.\nИзменить ставку может грузовладелец.", "operationId": "Orders_ChangeRate", "requestBody": { "x-name": "dto", "description": "Параметры изменения ставки", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ChangeRateDto" } ] } } }, "x-position": 1 }, "responses": { "200": { "description": "Успешное изменение ставки" }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/address": { "put": { "tags": [ "Заказы" ], "summary": "Изменение маршрута в Заказе", "description": "Изменение маршрута в Заказе без документов, созданных в системе АТИ-Доки.\nТребуется DealState Заказа `4` - В исполнении, `10` - Документы и Оплата.\nИзменить маршрут может грузовладелец.", "operationId": "Orders_ChangeAddress", "requestBody": { "x-name": "dto", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ChangeAddressDto" } ] } } }, "x-position": 1 }, "responses": { "200": { "description": "Возвращает структуру такого же вида, как на входе, с признаком изменения changed" }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/dates": { "put": { "tags": [ "Заказы" ], "summary": "Изменение дат и времени загрузки, разгрузки в Заказе", "description": "Изменение дат и времени загрузки, разгрузки в Заказе без документов, созданных в системе АТИ-Доки.\nИзменить даты и время может грузовладелец.", "operationId": "Orders_ChangeDates", "requestBody": { "x-name": "dto", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ChangeDatesDto" } ] } } }, "x-position": 1 }, "responses": { "200": { "description": "Возвращает структуру такого же вида, как на входе, включая данные, которые были" }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/contacts": { "put": { "tags": [ "Заказы" ], "summary": "Смена контактов в Заказе", "description": "Сменить контакты может грузовладелец", "operationId": "Orders_ChangeContacts", "requestBody": { "x-name": "dto", "description": "Параметры смены контактов", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ChangeContactsDto" } ] } } }, "x-position": 1 }, "responses": { "200": { "description": "Успешная смена контактов" }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/note": { "put": { "tags": [ "Заказы" ], "summary": "Изменение примечания к грузу в Заказе", "operationId": "Orders_ChangeNote", "requestBody": { "x-name": "dto", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ChangeNoteDto" } ] } } }, "x-position": 1 }, "responses": { "200": { "description": "Успешное изменение примечания" }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/{dealId}/delete_obsolete": { "delete": { "tags": [ "Заказы" ], "summary": "Удаление неактуального заказа", "description": "Удаляет заказ, которые не может быть выполнен, например взятый перевозчиком, а затем отклоненный грузовладельцем.", "operationId": "Orders_DeleteObsolete", "parameters": [ { "name": "dealId", "in": "path", "required": true, "description": "Id заказа", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "responses": { "200": { "description": "Успешное удаление" }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/redirect/to_deal/{dealId}": { "get": { "tags": [ "Попап создания/редактирования заявки" ], "summary": "Получение ссылки на попап редактирования документа", "description": "Открытие попапа происходит по ссылке. Возможно только в том случае, если действие производит грузовладелец, а Заказ находится на этапе согласования.", "operationId": "Redirect_GetDealRedirect", "parameters": [ { "name": "dealId", "in": "path", "required": true, "description": "Id Заказа", "schema": { "type": "string", "format": "guid" }, "x-position": 1 }, { "name": "action", "in": "query", "description": "Выполняемое действие, должен быть равен \"create_document\"", "schema": { "type": "string" }, "x-position": 2 } ], "responses": { "200": { "description": "Успешное получение ссылки", "content": { "application/json": { "schema": { "type": "string" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/documents/{parentDocumentId}/invoice": { "post": { "tags": [ "Создание документов" ], "summary": "Создание счета", "description": "Позволяет перевозчику и грузовладельцу создать счет для Заказа, оформленного через систему АТИ-Доки, для Заказа в статусах: исполнение, документы и оплата, в архиве", "operationId": "AdditionalDocuments_CreateInvoice", "parameters": [ { "name": "parentDocumentId", "in": "path", "required": true, "description": "Id документа", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "Возвращает информацию по счету", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentMinView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/documents/{parentDocumentId}/act": { "post": { "tags": [ "Создание документов" ], "summary": "Создание акта", "description": "Позволяет перевозчику и грузовладельцу создать двухсторонний акт для Заказа, оформленного через систему АТИ-Доки, для Заказа в статусах: исполнение, документы и оплата, в архиве", "operationId": "AdditionalDocuments_CreateAct", "parameters": [ { "name": "parentDocumentId", "in": "path", "required": true, "description": "Id документа", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "Возвращает информацию по акту", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentMinView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/documents/{parentDocumentId}/unilateral_dissolution": { "post": { "tags": [ "Создание документов" ], "summary": "Создание уведомления о расторжении", "description": "Позволяет перевозчику и грузовладельцу создать уведомление об отклонении Заказа, оформленного через систему АТИ-Доки, для Заказа в исполнении", "operationId": "AdditionalDocuments_CreateUnilateralDissolution", "parameters": [ { "name": "parentDocumentId", "in": "path", "required": true, "description": "Id документа", "schema": { "type": "string" }, "x-position": 1 } ], "responses": { "200": { "description": "Возвращает информацию по уведомлению", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentMinView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/docs/{documentId}/access": { "put": { "tags": [ "Документы в заказах" ], "summary": "Настройка доступа к документу заказа", "operationId": "Docs_ChangeAccess", "parameters": [ { "name": "documentId", "in": "path", "required": true, "description": "Id документа", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "requestBody": { "x-name": "dto", "description": "Настройка доступа", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DealDocumentAccessDto" } ] } } }, "x-position": 2 }, "responses": { "200": { "description": "Успешное изменение доступа", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/files/info": { "post": { "tags": [ "Файлы в заказах" ], "summary": "Добавление данных файла к заказу", "description": "Позволяет добавить данные файла к заказу", "operationId": "Files_SaveFileInfo", "requestBody": { "x-name": "file", "description": "Данные файла", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DealFileInfoDto3" } ] } } }, "x-position": 1 }, "responses": { "200": { "description": "Успешное добавление", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealFileView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/files/{fileId}": { "delete": { "tags": [ "Файлы в заказах" ], "summary": "Удаление приложенного файла заказа", "operationId": "Files_RemoveFile", "parameters": [ { "name": "fileId", "in": "path", "required": true, "description": "Id файла", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "responses": { "200": { "description": "Успешное удаление" }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/files/{fileId}/access": { "put": { "tags": [ "Файлы в заказах" ], "summary": "Настройка доступа к файлу заказа", "operationId": "Files_ChangeAccess", "parameters": [ { "name": "fileId", "in": "path", "required": true, "description": "Id файла", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "requestBody": { "x-name": "dto", "description": "Настройка доступа", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DealFileAccessDto" } ] } } }, "x-position": 2 }, "responses": { "200": { "description": "Успешное изменение доступа", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/invites": { "post": { "tags": [ "Персональные приглашения" ], "summary": "Отправка приглашения", "description": "Отправляет приглашение оформить заказ грузоперевозчику с оповещением\n \n*Отправленное повторно приглашение удалит предыдущее*", "operationId": "PersonalInvitations_Invite", "requestBody": { "x-name": "dto", "description": "Параметры приглашения", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PersonalInvitationDTO" } ] } } }, "x-position": 1 }, "responses": { "200": { "description": "Приглашение отправлено" }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/invites/counter_offer": { "post": { "tags": [ "Персональные приглашения" ], "summary": "Отправка приглашения по встречному предложению", "description": "Отправляет приглашение оформить заказ грузоперевозчику по встречному предложению", "operationId": "PersonalInvitations_CounterOfferInvite", "requestBody": { "x-name": "dto", "description": "Параметры приглашения", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PersonalOfferInvitationDTO" } ] } } }, "x-position": 1 }, "responses": { "200": { "description": "Приглашение отправлено" }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/invites/{loadId}": { "get": { "tags": [ "Персональные приглашения" ], "summary": "Получение отправленных приглашений", "operationId": "PersonalInvitations_Get", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "ID груза", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "responses": { "200": { "description": "Отправленные приглашения", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LoadPersonalInvitationView" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/invites/my": { "get": { "tags": [ "Персональные приглашения" ], "summary": "Получение списка приглашений", "operationId": "PersonalInvitations_Get2", "parameters": [ { "name": "role", "in": "query", "description": "Роль пользователя: `0` — Грузовладелец, `1` — Перевозчик", "schema": { "$ref": "#/components/schemas/OrderRole" }, "x-position": 1 } ], "responses": { "200": { "description": "Список приглашений на перевозку груза", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PersonalInvitationView3" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/invites/{loadId}/{contactId}": { "delete": { "tags": [ "Персональные приглашения" ], "summary": "Отказ от приглашения", "operationId": "PersonalInvitations_Delete", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "ID груза", "schema": { "type": "string", "format": "guid" }, "x-position": 1 }, { "name": "contactId", "in": "path", "required": true, "schema": { "type": "string" }, "x-position": 2 } ], "responses": { "200": { "description": "Успешный отказ от приглашения" }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/v1.2/orders/invites/by_taker_id/{loadId}/{takerAtiId}": { "delete": { "tags": [ "Персональные приглашения" ], "summary": "Удаление предложения", "operationId": "PersonalInvitations_Delete2", "parameters": [ { "name": "loadId", "in": "path", "required": true, "description": "ID груза", "schema": { "type": "string", "format": "guid" }, "x-position": 1 }, { "name": "takerAtiId", "in": "path", "required": true, "description": "Id аккаунта приглашаемой фирмы", "schema": { "type": "string" }, "x-position": 2 } ], "responses": { "200": { "description": "Успешное удаление предложения" } }, "security": [ { "JWT": [] } ] } }, "/presence/state/{code_id}/": { "get": { "tags": [ "Users Status" ], "summary": "Получение статуса пользователя", "parameters": [ { "in": "path", "name": "code_id", "required": true, "schema": { "type": "string", "example": "123.0" }, "description": "id пользователя" } ], "responses": { "200": { "description": "Список пользователей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/presence__User" } } } }, "401": { "description": "Ошибка авторизации." } } } }, "/presence/state": { "post": { "tags": [ "Users Status" ], "summary": "Возвращает статус для списка пользователей", "requestBody": { "description": "Список пользователей", "required": true, "content": { "application/json": { "schema": { "items": { "type": "string", "example": "123456.0" }, "type": "array" } } } }, "responses": { "200": { "description": "Список пользователей", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StatesOfUsers" } } } }, "400": { "description": "Bad Request." }, "401": { "description": "Ошибка авторизации." } } } }, "/gw/timeslots/api/v1/terminal": { "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Terminal" }, "examples": { "Create Terminal": { "value": { "name": "Тестовая площадка", "gates_count": "3", "loading_type": "any", "warehouse": 24540, "schedule": [ { "time_from": "00:00", "time_to": "23:59", "day_of_week": "1" } ], "contacts": [ { "name": "Имя менеджера склада", "phone": "+7 000 000-00-00", "country_phone_id": "0", "warehouse": 34824 } ] } } } } } }, "responses": { "200": { "description": "Возвращается созданная или обновленная площадка погрузки-выгрузки", "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" }, "result": { "type": "object", "properties": { "terminal": { "$ref": "#/components/schemas/Terminal" } } } } }, "examples": { "Terminal Created": { "value": { "ok": true, "result": { "terminal": { "id": 35262, "gates": [], "schedule": [ { "day_of_week": "1", "time_from": "00:00:00", "time_to": "23:59:00" } ], "contacts": [ { "id": 35498, "name": "Имя менеджера склада", "phone": "+7 000 000-00-00", "country_phone_id": "0" } ], "name": "Тестовая площадка", "gates_count": 3, "loading_type": "any", "date_creation": "2023-07-04T08:09:18.676843+03:00", "date_modified": "2023-07-04T08:09:18.676871+03:00", "deleted": false, "is_test": true, "warehouse": 34824 } } } } } } } }, "400": { "description": "Ошибка валидации. Возникает, когда в какое-то из полей передано недопустимое значение", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SingleError" }, { "$ref": "#/components/schemas/MultipleError" } ] }, "examples": { "Validation Errors": { "value": { "error": "multiple_errors", "error_list": [ { "error": "loading_type", "reason": "Значения test нет среди допустимых вариантов." }, { "error": "warehouse", "reason": "Некорректный тип. Ожидалось значение первичного ключа, получен str." } ], "reason": "invalid" } } } } } } } }, "get": { "responses": { "200": { "description": "Возвращаются площадки погрузки-выгрузки", "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" }, "result": { "type": "object", "properties": { "count": { "type": "integer" }, "terminals": { "type": "array", "description": "Список терминалов", "items": { "$ref": "#/components/schemas/Terminal" } } } } } }, "examples": { "Returned Terminals": { "value": { "ok": true, "result": { "count": 2, "terminals": [ { "id": 35260, "gates": [], "schedule": [ { "day_of_week": "1", "time_from": "00:00:00", "time_to": "23:59:00" }, { "day_of_week": "2", "time_from": "00:00:00", "time_to": "23:59:00" }, { "day_of_week": "3", "time_from": "00:00:00", "time_to": "23:59:00" }, { "day_of_week": "4", "time_from": "00:00:00", "time_to": "23:59:00" }, { "day_of_week": "5", "time_from": "00:00:00", "time_to": "23:59:00" }, { "day_of_week": "6", "time_from": "00:00:00", "time_to": "23:59:00" }, { "day_of_week": "7", "time_from": "00:00:00", "time_to": "23:59:00" } ], "contacts": [ { "id": 35496, "name": "Имя менеджера склада", "phone": "+7 000 000-00-00", "country_phone_id": "0" } ], "name": "Площадка", "gates_count": 1, "loading_type": "any", "date_creation": "2023-07-04T07:45:11.954912+03:00", "date_modified": "2023-07-04T07:45:11.954929+03:00", "deleted": false, "is_test": false, "warehouse": 34824 }, { "id": 35259, "gates": [], "schedule": [], "contacts": [], "name": "Площадка", "gates_count": 1, "loading_type": "any", "date_creation": "2023-07-04T06:57:45.340826+03:00", "date_modified": "2023-07-04T07:34:58.968527+03:00", "deleted": true, "is_test": false, "warehouse": 34823 } ] } } } } } } } } }, "delete": { "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "terminal_ids": { "type": "list", "description": "Список удаляемых площадок погрузки-выгрузки", "items": { "type": "integer", "description": "Идентификатор площадки погрузки-выгрузки" } } }, "required": [ "terminal_ids" ] }, "examples": { "Delete terminals": { "value": { "terminal_ids": [ 35262 ] } } } } } }, "responses": { "200": { "description": "Возвращается список удаленных площадок погрузки-выгрузки, а также списки ошибок, если таковые возникли", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "result": { "type": "object", "properties": { "200": { "type": "array", "description": "Список идентификаторов удаленных площадок погрузки-выгрузки", "items": { "type": "integer", "description": "Идентификатор площадки погрузки-выгрузки" } }, "400": { "type": "array", "description": "Список идентификаторов складов, при удалении которых возникли ошибки валидации", "items": { "type": "integer", "description": "Идентификатор склада" } }, "500": { "type": "array", "description": "Список идентификаторов складов, при удалении которых возникли ошибки сервера", "items": { "type": "integer", "description": "Идентификатор склада" } } } } } }, "examples": { "Terminals Deleted": { "value": { "ok": true, "result": { "200": [ 35262 ], "400": [], "500": [] } } } } } } }, "400": { "description": "Ошибка валидации. Возникает, когда в какое-то из полей передано недопустимое значение", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleError" }, "examples": { "Validation Error": { "value": { "error": "bad request", "reason": "Необходимо передать список terminal_ids", "details": null } } } } } } } } }, "/gw/timeslots/api/v1/timeslots": { "post": { "description": "Метод создания или обновления бронирования", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "timeslot": { "$ref": "#/components/schemas/TimeSlot" } }, "required": [ "timeslot", "terminal", "warehouse", "approve_status" ] }, "examples": { "Create Time Slot": { "value": { "timeslot": { "attachments": [], "terminal": 35264, "gate_number": 1, "action_type": "loading_unloading", "comment": "Тестовый комментарий", "date_from": "2023-07-04", "date_to": "2023-07-04", "time_from": "00:00", "time_to": "00:00", "warehouse": 34824, "approve_status": "approved" } } } } } } }, "responses": { "200": { "description": "Возвращаются актуальные данные созданного или измененного склада", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "result": { "type": "object", "properties": { "warehouse": { "$ref": "#/components/schemas/TimeSlot" } } } } }, "examples": { "Time Slot Created": { "value": { "ok": true, "result": { "timeslot": { "id": 12429, "time_from": "00:00", "time_to": "00:00", "warehouse_info": { "id": 34824, "name": "Тестовый склад", "address": "Гельсингфорсская улица, 2А", "city_verbose": "Санкт-Петербург, РФ", "utc_offset": 180, "owner": 4022713 }, "attached_files": [], "can_be_edited": true, "is_expired": true, "timeslot_readable_id": "34824-12429", "approve_status": "approved", "action_type": "loading_unloading", "slot_owner": 4022713, "contact_id": 0, "email": "", "contact_name": null, "contact_phone": "", "country_phone_id": "", "gate_number": 1, "car_number": null, "car_capacity": null, "body_type": null, "cargo": "", "cargo_count": null, "cargo_unit": "", "cargo_owner": "", "cargo_owner_contact_name": "", "cargo_owner_contact_number": "", "comment": "Тестовый комментарий", "firm_name": "", "date_from": "2023-07-04", "date_to": "2023-07-04", "date_creation": "2023-07-04T08:29:44.939037+03:00", "date_modified": "2023-07-04T08:29:44.939059+03:00", "deleted": false, "is_test": true, "warehouse": 34824, "terminal": 35264, "order_point": null, "warehouse_name": "Тестовый склад", "terminal_name": "Тестовая площадка" } } } } } } } }, "400": { "description": "Ошибка валидации. Возникает, когда в какое-то из полей передано недопустимое значение", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SingleError" }, { "$ref": "#/components/schemas/MultipleError" } ] }, "examples": { "Validation Errors": { "value": { "error": "multiple_errors", "error_list": [ { "error": "time_to", "reason": "Неправильный формат времени. Используйте один из этих форматов: hh:mm." }, { "error": "approve_status", "reason": "Значения test нет среди допустимых вариантов." } ], "reason": "invalid" } } } } } } } } }, "/gw/timeslots/api/v1/timeslots/my": { "get": { "responses": { "200": { "description": "Возвращаются все бронирования и точки заказа без бронирований", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "result": { "type": "object", "properties": { "order_points_without_slots_count": { "type": "integer", "description": "Количество точек заказа, для которых не создано бронирование" }, "order_points_without_slots": { "type": "array", "items": { "$ref": "#/components/schemas/OrderPoint" } }, "count": { "type": "integer", "description": "Количество созданных бронирований" }, "time_slots": { "type": "array", "items": { "$ref": "#/components/schemas/TimeSlot" } }, "accounts": { "type": "array", "items": { "$ref": "#/components/schemas/time-slots_v1__Account" } }, "timeslot_filters": { "type": "object", "properties": { "timeslot_id": { "type": "integer" }, "order_point_id": { "type": "integer" }, "only_timeslots": { "type": "boolean" }, "only_order_points_without_slots": { "type": "boolean" } } } } } } }, "example": { "lol": { "kek": 1 } } } } } } } }, "/gw/timeslots/api/v1/timeslots/{ati_id}": { "get": { "parameters": [ { "in": "path", "name": "ati_id", "required": true, "schema": { "type": "integer", "minimum": 1, "description": "Идентификатор фирмы" } }, { "in": "query", "name": "gates", "schema": { "type": "string" }, "description": "Номера площадок погрузки-выгрузки" }, { "in": "query", "name": "warehouse_id", "schema": { "type": "integer" }, "description": "Идентификатор склада" }, { "in": "query", "name": "terminal_id", "schema": { "type": "integer" }, "description": "Идентификатор площадки погрузки-разгрузки" }, { "in": "query", "name": "date_from", "schema": { "type": "string" }, "description": "Дата начала бронирований" }, { "in": "query", "name": "date_to", "schema": { "type": "string" }, "description": "Дата окончания бронирований" }, { "in": "query", "name": "time_from", "schema": { "type": "string" }, "description": "Время начала бронирований" }, { "in": "query", "name": "time_to", "schema": { "type": "string" }, "description": "Время окончания бронирований" }, { "in": "query", "name": "deal_id", "schema": { "type": "string" }, "description": "Идентификатор сделки" }, { "in": "query", "name": "ordinal_id", "description": "Порядковый номер точки в заказе", "schema": { "type": "string" } }, { "in": "query", "name": "order_point_type", "description": "Тип точки в заказе. 1 - точка загрузки, 2 - точка разгрузки", "schema": { "type": "integer", "enum": [ 1, 2 ] } }, { "in": "query", "name": "approve_status", "description": "Статус бронирования", "schema": { "$ref": "#/components/schemas/ApproveStatus" } }, { "in": "query", "name": "timeslot_id", "description": "Идентификатор бронирования", "schema": { "type": "integer" } }, { "in": "query", "name": "order_point_id", "description": "Идентификатор точки заказа", "schema": { "type": "integer" } }, { "in": "query", "name": "only_timeslots", "description": "Флаг, определяющий, что надо вернуть только бронирования, без точек из заказа", "schema": { "type": "boolean", "default": false } }, { "in": "query", "name": "only_order_points_without_slots", "description": "Флаг, определяющий, что надо вернуть только точки из заказа без бронирований", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Возвращается информация бронированиях с учетом фильтров", "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" }, "result": { "type": "object", "properties": { "count": { "type": "integer", "description": "Количество найденных бронирований" }, "time_slots": { "$ref": "#/components/schemas/TimeSlot" }, "accounts": { "$ref": "#/components/schemas/time-slots_v1__Account" }, "timeslot_filters": { "type": "object", "properties": { "timeslot_id": { "type": "integer" }, "order_point_id": { "type": "integer" }, "only_timeslots": { "type": "boolean" }, "only_order_points_without_slots": { "type": "boolean" } } } } } } }, "examples": { "Returned Timeslots": { "value": { "ok": true, "result": { "count": 1, "time_slots": [ { "id": 12429, "time_from": "00:00", "time_to": "00:00", "warehouse_info": { "id": 34824, "name": "Тестовый склад", "address": "Гельсингфорсская улица, 2А", "city_verbose": "Санкт-Петербург, РФ", "utc_offset": 180, "owner": 4022713 }, "staying_statuses_history": [ { "status_name": "Ожидается", "date_start": "2023-07-04T08:29:44.946522+03:00", "date_end": null, "staying_status": 173845, "timeslot": 12429, "comment": "", "color": "rgb(219, 169, 46)" } ], "attached_files": [], "can_be_edited": true, "is_expired": true, "timeslot_readable_id": "34824-12429", "approve_status": "approved", "action_type": "loading_unloading", "slot_owner": 4022713, "contact_id": 0, "email": "", "contact_name": null, "contact_phone": "", "country_phone_id": "", "gate_number": 1, "car_number": null, "car_capacity": null, "body_type": null, "cargo": "", "cargo_count": null, "cargo_unit": "", "cargo_owner": "", "cargo_owner_contact_name": "", "cargo_owner_contact_number": "", "comment": "Тестовый комментарий", "firm_name": "", "date_from": "2023-07-04", "date_to": "2023-07-04", "date_creation": "2023-07-04T08:29:44.939037+03:00", "date_modified": "2023-07-04T08:29:44.939059+03:00", "deleted": false, "is_test": true, "warehouse": 34824, "terminal": 35264, "order_point": null, "warehouse_name": "Тестовый склад", "terminal_name": "Тестовая площадка" } ], "accounts": { "4022713": { "firm_type": "Экспедитор", "firm_id": 4022713, "account_id": "4022713", "full_firm_name": "JtNEFfon8443, ИП", "firm_name": "JtNEFfon8443", "brand": null, "location": { "city_id": 1, "region_id": 153, "country_id": 1, "full_name": "Санкт-Петербург, Санкт-Петербург (регион), Россия", "short_name": "Санкт-Петербург", "is_regional_center": true, "city_size": 6, "fias_id": "c2deb16a-0330-4f05-821f-1d09c93331e6", "attributes": 2052, "city_name": "Санкт-Петербург", "region_name": "Санкт-Петербург (регион)", "country_name": "Россия", "country_code_name": "RUS" }, "passport": { "ati_id": "4022713", "total_score": 0, "ati_data_match_point": 0, "account_lifetime_point": 0, "business_activity_point": 0, "round_table_point": 0, "claim_point": 0, "prof_activity_point": 0, "ati_administration_point": 0, "clones_point": 0, "egr_point": 0, "mass_registration_point": 0, "mass_founder_point": 0, "firm_lifetime_point": 0, "guaranteed_payment_point": 0, "virtual_account_debts_point": 0, "bad_partner_mentions_point": 0, "ri_users_attributes": 100380, "recommendations_count": 0, "status": 2, "status_description": "Отсутствует балл \"Аккаунт подтвержден\" или cумма любых красных баллов меньше или равна 1", "negative_points_sum": 0 }, "contacts": [ { "id": 2, "name": "contact" }, { "id": 0, "name": "director" } ] } }, "timeslot_filters": { "timeslot_id": null, "order_point_id": null, "only_timeslots": false, "only_order_points_without_slots": false } } } } } } } }, "400": { "description": "Фирма не найдена", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleError" }, "examples": { "Firm Not Found": { "value": { "error": "bad_request", "reason": "Фирма не найдена" } } } } } } } } }, "/gw/timeslots/api/v1/timeslots/counters": { "post": { "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "warehouse_ids": { "type": "array", "items": { "type": "integer", "description": "Идентификатор склада во Временных окнах" } } }, "required": [ "warehouse_ids" ] }, "examples": { "Get Time Slots Counters": { "value": { "warehouse_ids": [ 34824 ] } } } } } }, "responses": { "200": { "description": "Возвращаются количество бронирований пользователей в статусе await_reaction в переданных складах", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "result": { "type": "object", "additionalProperties": { "type": "integer" } } } }, "examples": { "Returned Time Slots Counters": { "value": { "ok": true, "result": { "34824": 0 } } } } } } }, "400": { "description": "Ошибка валидации. Возникает, когда в какое-то из полей передано недопустимое значение", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleError" }, "examples": { "Bad Warehouse Ids": { "value": { "error": "bad_request", "reason": "warehouse_ids должен содержать айдишники складов", "details": null } } } } } } } } }, "/gw/timeslots/api/v1/timeslots/history/{timeslot_id}": { "get": { "operationId": "", "parameters": [ { "in": "path", "name": "timeslot_id", "required": true, "schema": { "type": "integer", "minimum": 1, "description": "Идентификатор фирмы" } } ], "responses": { "200": { "description": "Возвращается история изменений бронирования", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "result": { "type": "object", "properties": { "history_changes": { "type": "array", "items": { "$ref": "#/components/schemas/TimeSlotHistoryItem" } } } } } }, "examples": { "Time Slot History": { "value": { "ok": true, "result": { "history_changes": [ { "iso_warehouse_local_datetime": "2023-07-05T08:19:13.132092+03:00", "editor_info": { "name": "director" }, "changes": { "created": [], "updated": [ { "field": { "name": "comment", "old_value": "Тестовый комментарий", "new_value": "Измененный комментарий" } } ], "deleted": [] } }, { "iso_warehouse_local_datetime": "2023-07-04T08:29:44.939059+03:00", "editor_info": { "name": "director" }, "changes": { "created": [ { "field": { "name": "timeslot_created", "old_value": null, "new_value": null } }, { "field": { "name": "staying_statuses", "old_value": null, "new_value": [ "Ожидается" ] } } ], "updated": [], "deleted": [] } } ] } } } } } } }, "404": { "description": "Бронирование не найдено", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleError" }, "examples": { "Not Found": { "value": { "error": "not_found", "reason": "Timeslot not found" } } } } } } } } }, "/gw/timeslots/api/v1/warehouse": { "post": { "description": "Метод создания или обновления склада", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор склада. Если указан, то при наличии склада в системе, его данные будут обновлены" }, "name": { "type": "string", "description": "Название склада" }, "address": { "type": "string", "description": "Адрес склада" }, "city_id": { "type": "integer", "description": "Идентификатор города. Ему соответствует название города из [словаря](https://ati.su/developers/api/dictionaries/geo/)" }, "contacts": { "type": "array", "description": "Контакты контактного лица/лиц склада", "items": { "$ref": "#/components/schemas/WarehouseContact" } }, "schedule": { "type": "array", "description": "Список рабочих дней склада", "items": { "$ref": "#/components/schemas/ScheduleItem" } } }, "required": [ "name", "address", "city_id", "contacts", "schedule" ] }, "examples": { "Create warehouse": { "value": { "name": "Тестовый склад", "address": "Гельсингфорсская улица, 2А", "city_id": 1, "contacts": [ { "name": "Имя менеджера склада", "phone": "+7 000 000-00-00", "country_phone_id": 0 } ], "schedule": [ { "time_from": "00:00", "time_to": "23:59", "day_of_week": 1 }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": 2 }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": 3 }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": 4 }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": 5 }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": 6 }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": 7 } ] } } } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "result": { "type": "object", "properties": { "warehouse": { "$ref": "#/components/schemas/Warehouse" } } } } }, "examples": { "Warehouse Created": { "value": { "ok": true, "result": { "warehouse": { "id": 29583, "schedule": [ { "time_from": "00:00", "time_to": "23:59", "day_of_week": "1" }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": "2" }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": "3" }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": "4" }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": "5" }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": "6" }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": "7" } ], "contacts": [ { "id": 31311, "name": "Имя менеджера склада", "phone": "+7 000 000-00-00", "country_phone_id": "0", "warehouse": 29583 } ], "name": "Тестовый склад", "address": "Гельсингфорсская улица, 2А", "owner": 9338034, "city_id": 1, "country_id": 1, "region_id": 153, "city_verbose": "Санкт-Петербург, РФ", "utc_offset": 180, "date_creation": "2023-06-27T09:57:27.615139+03:00", "date_modified": "2023-06-27T09:57:27.615186+03:00", "deleted": false, "is_test": true } } } } } } }, "description": "Возвращаются актуальные данные созданного или измененного склада" }, "400": { "description": "Ошибка валидации. Возникает, когда в какое-то из полей передано недопустимое значение", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SingleError" }, { "$ref": "#/components/schemas/MultipleError" } ] }, "examples": { "Validation Errors": { "value": { "error": "multiple_errors", "error_list": [ { "error": "non_field_errors", "reason": "Ожидался list со значениями, но был получен \"str\"." }, { "error": "non_field_errors", "reason": "Ожидался list со значениями, но был получен \"str\"." } ], "reason": "invalid" } } } } } } } }, "get": { "description": "Метод получения всех складов пользователя", "responses": { "200": { "description": "Возвращаются все склады пользователя", "content": { "application/json": { "schema": { "type": "object", "properties": { "partners_warehouses_count": { "type": "integer", "description": "Количество складов, с которыми у пользователя установлена связь" }, "partners_warehouses": { "type": "array", "items": { "$ref": "#/components/schemas/Warehouse" }, "description": "Список складов, с которыми у пользователя установлена связь" }, "count": { "type": "integer", "description": "Количество складов" }, "warehouses": { "type": "array", "description": "Список складов", "items": { "$ref": "#/components/schemas/Warehouse" } } } }, "examples": { "Warehouses Returned": { "value": { "ok": true, "result": { "partners_warehouses_count": 0, "partners_warehouses": [], "count": 1, "warehouses": [ { "id": 34823, "schedule": [ { "time_from": "00:00", "time_to": "23:59", "day_of_week": "1" }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": "2" }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": "3" }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": "4" }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": "5" }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": "6" }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": "7" } ], "contacts": [ { "id": 36735, "name": "Имя менеджера склада", "phone": "+7 000 000-00-00", "country_phone_id": "0", "warehouse": 34823 } ], "sms_enabled": false, "name": "Тестовый склад", "address": "Гельсингфорсская улица, 2А", "owner": 4022713, "city_id": 1, "country_id": 1, "region_id": 153, "city_verbose": "Санкт-Петербург, РФ", "utc_offset": 180, "date_creation": "2023-07-04T06:57:45.295611+03:00", "date_modified": "2023-07-04T06:57:45.295633+03:00", "deleted": false, "is_test": true } ] } } } } } } } } }, "delete": { "description": "Метод удаления складов", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "warehouse_ids": { "type": "list", "description": "Список идентификаторов складов, которые нужно удалить", "items": { "type": "integer", "description": "Идентификатор склада" } } }, "required": [ "warehouse_ids" ] }, "examples": { "Delete warehouse": { "value": { "warehouse_ids": [ 34823 ] } } } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "result": { "type": "object", "properties": { "200": { "type": "array", "description": "Список идентификаторов удаленных складов", "items": { "type": "integer", "description": "Идентификатор склада" } }, "400": { "type": "array", "description": "Список идентификаторов складов, при удалении которых возникли ошибки валидации", "items": { "type": "integer", "description": "Идентификатор склада" } }, "500": { "type": "array", "description": "Список идентификаторов складов, при удалении которых возникли ошибки сервера", "items": { "type": "integer", "description": "Идентификатор склада" } } } } } }, "examples": { "Warehouse Deleted": { "value": { "ok": true, "result": { "200": [ 34823 ], "400": [], "500": [] } } } } } }, "description": "Возвращаются актуальные данные созданного или измененного склада" }, "400": { "description": "Ошибка валидации. Возникает, когда в какое-то из полей передано недопустимое значение", "content": { "application/json": { "schema": { "anyOf": [ { "$ref": "#/components/schemas/SingleError" }, { "$ref": "#/components/schemas/MultipleError" } ] }, "examples": { "Validation Error": { "value": { "error": "bad request", "reason": "Необходимо передать список warehouse_ids", "details": null } } } } } } } } }, "/gw/timeslots/api/v1/warehouse/{warehouse_id}": { "get": { "parameters": [ { "in": "path", "name": "warehouse_id", "required": true, "schema": { "type": "integer", "minimum": 1, "description": "Идентификатор склада" } } ], "responses": { "200": { "description": "Возвращается информация о складе с указанным идентификатором", "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" }, "result": { "$ref": "#/components/schemas/Warehouse" } } }, "examples": { "Warehouse Returned": { "value": { "ok": true, "result": { "warehouse": { "id": 34823, "schedule": [ { "time_from": "00:00", "time_to": "23:59", "day_of_week": "1" }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": "2" }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": "3" }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": "4" }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": "5" }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": "6" }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": "7" } ], "contacts": [ { "id": 36735, "name": "Имя менеджера склада", "phone": "+7 000 000-00-00", "country_phone_id": "0", "warehouse": 34823 } ], "sms_enabled": false, "name": "Тестовый склад", "address": "Гельсингфорсская улица, 2А", "owner": 4022713, "city_id": 1, "country_id": 1, "region_id": 153, "city_verbose": "Санкт-Петербург, РФ", "utc_offset": 180, "date_creation": "2023-07-04T06:57:45.295611+03:00", "date_modified": "2023-07-04T06:57:45.295633+03:00", "deleted": false, "is_test": true } } } } } } } }, "404": { "description": "Склад не найден", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleError" }, "examples": { "Not Found": { "value": { "error": "not_found", "reason": "Склад не найден", "details": null } } } } } } } } }, "/gw/timeslots/api/v1/warehouse/workload/{warehouse_id}": { "get": { "parameters": [ { "in": "path", "name": "warehouse_id", "required": true, "schema": { "type": "integer", "minimum": 1, "description": "Идентификатор склада" } }, { "in": "query", "name": "loading_type", "required": true, "schema": { "$ref": "#/components/schemas/time-slots_v1__LoadingType" }, "description": "Cоответствует типу загрузки площадки погрузки-выгрузки" } ], "responses": { "200": { "description": "Возвращается информация о загруженности склада с указанным идентификатором и указанным типом загрузки", "content": { "application/json": { "schema": { "properties": { "ok": { "type": "boolean" }, "result": { "type": "object", "properties": { "workload": { "type": "array", "items": { "$ref": "#/components/schemas/WarehouseWorkloadItem" } }, "warehouse": { "$ref": "#/components/schemas/Warehouse" } } } } }, "examples": { "Returned Workload": { "value": { "ok": true, "result": { "workload": [ { "date": "2023-07-04T04:26:09.706493Z", "weekday": 2, "possible_slots_count": 24, "available_slots_count": 24, "loading_level": "low" }, { "date": "2023-07-05T04:26:09.706493Z", "weekday": 3, "possible_slots_count": 24, "available_slots_count": 24, "loading_level": "low" }, { "date": "2023-07-06T04:26:09.706493Z", "weekday": 4, "possible_slots_count": 24, "available_slots_count": 24, "loading_level": "low" }, { "date": "2023-07-07T04:26:09.706493Z", "weekday": 5, "possible_slots_count": 24, "available_slots_count": 24, "loading_level": "low" }, { "date": "2023-07-08T04:26:09.706493Z", "weekday": 6, "possible_slots_count": 24, "available_slots_count": 24, "loading_level": "low" }, { "date": "2023-07-09T04:26:09.706493Z", "weekday": 7, "possible_slots_count": 24, "available_slots_count": 24, "loading_level": "low" }, { "date": "2023-07-10T04:26:09.706493Z", "weekday": 1, "possible_slots_count": 24, "available_slots_count": 24, "loading_level": "low" }, { "date": "2023-07-11T04:26:09.706493Z", "weekday": 2, "possible_slots_count": 24, "available_slots_count": 24, "loading_level": "low" }, { "date": "2023-07-12T04:26:09.706493Z", "weekday": 3, "possible_slots_count": 24, "available_slots_count": 24, "loading_level": "low" }, { "date": "2023-07-13T04:26:09.706493Z", "weekday": 4, "possible_slots_count": 24, "available_slots_count": 24, "loading_level": "low" }, { "date": "2023-07-14T04:26:09.706493Z", "weekday": 5, "possible_slots_count": 24, "available_slots_count": 24, "loading_level": "low" }, { "date": "2023-07-15T04:26:09.706493Z", "weekday": 6, "possible_slots_count": 24, "available_slots_count": 24, "loading_level": "low" }, { "date": "2023-07-16T04:26:09.706493Z", "weekday": 7, "possible_slots_count": 24, "available_slots_count": 24, "loading_level": "low" }, { "date": "2023-07-17T04:26:09.706493Z", "weekday": 1, "possible_slots_count": 24, "available_slots_count": 24, "loading_level": "low" } ], "warehouse": { "id": 34823, "schedule": [ { "time_from": "00:00", "time_to": "23:59", "day_of_week": "1" }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": "2" }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": "3" }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": "4" }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": "5" }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": "6" }, { "time_from": "00:00", "time_to": "23:59", "day_of_week": "7" } ], "contacts": [ { "id": 36735, "name": "Имя менеджера склада", "phone": "+7 000 000-00-00", "country_phone_id": "0", "warehouse": 34823 } ], "sms_enabled": false, "name": "Тестовый склад", "address": "Гельсингфорсская улица, 2А", "owner": 4022713, "city_id": 1, "country_id": 1, "region_id": 153, "city_verbose": "Санкт-Петербург, РФ", "utc_offset": 180, "date_creation": "2023-07-04T06:57:45.295611+03:00", "date_modified": "2023-07-04T06:57:45.295633+03:00", "deleted": false, "is_test": true } } } } } } } }, "404": { "description": "Склад не найден", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SingleError" }, "examples": { "Not Found": { "value": { "error": "not_found", "reason": "Склад не найден", "details": null } } } } } } } } }, "/v1.0/trucks/search/by-filter": { "post": { "tags": [ "IntegratorSearch" ], "summary": "Поиск транспорта по фильтру", "parameters": [ { "name": "demo", "in": "query", "description": "Использовать демо версию", "schema": { "type": "boolean" } } ], "requestBody": { "description": "", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SearchDescriptorModel" } ] } }, "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SearchDescriptorModel" } ] } }, "text/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SearchDescriptorModel" } ] } }, "application/*+json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/SearchDescriptorModel" } ] } } } }, "responses": { "200": { "description": "Success", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/IntegratorSearchResultView" } }, "application/json": { "schema": { "$ref": "#/components/schemas/IntegratorSearchResultView" } }, "text/json": { "schema": { "$ref": "#/components/schemas/IntegratorSearchResultView" } } } } } } }, "/gw/trucks/integrator/v1/trucks/{truckId}": { "get": { "tags": [ "v1 Ваши машины" ], "summary": "Получение машины", "operationId": "TrucksV1_Get", "parameters": [ { "name": "truckId", "in": "path", "required": true, "description": "Идентификатор машины", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckViewV1" } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] }, "put": { "tags": [ "v1 Ваши машины" ], "summary": "Изменение машины", "operationId": "TrucksV1_PutPUT", "parameters": [ { "name": "truckId", "in": "path", "required": true, "description": "Идентификатор машины", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody": { "x-name": "truck", "description": "Измененная машина", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckForUpdateV1Request" } } }, "x-position": 2 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckViewV1" } } } }, "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckViewV1" } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] }, "delete": { "tags": [ "v1 Ваши машины" ], "summary": "Архивирование машины", "operationId": "TrucksV1_Delete2", "parameters": [ { "name": "truckId", "in": "path", "required": true, "description": "Идентификатор машины", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObsoleteSuccessView" } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/trucks/integrator/v1/trucks": { "get": { "tags": [ "v1 Ваши машины" ], "summary": "Получение машин контакта", "operationId": "TrucksV1_GetTrucksByContact", "parameters": [ { "name": "contactId", "in": "query", "description": "Идентификатор контакта", "schema": { "type": "integer", "format": "int32", "nullable": true }, "x-position": 1, "example": 0 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TruckViewV1" } } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] }, "post": { "tags": [ "v1 Ваши машины" ], "summary": "Создание машины", "operationId": "TrucksV1_Post", "requestBody": { "x-name": "truck", "description": "Машина", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckForInsertV1Request" } } }, "x-position": 1 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckViewV1" } } } }, "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckViewV1" } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] }, "delete": { "tags": [ "v1 Ваши машины" ], "summary": "Архивирование нескольких машин", "operationId": "TrucksV1_Delete", "requestBody": { "x-name": "ids", "description": "Идентификаторы машин", "content": { "application/json": { "schema": { "type": "array", "nullable": true, "items": { "type": "string", "format": "guid" } } } }, "x-position": 1 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/trucks/integrator/v1/trucks/count": { "get": { "tags": [ "v1 Ваши машины" ], "summary": "Получение счетчиков машин", "operationId": "TrucksV1_GetCounters", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckCounters" } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/trucks/integrator/v1/trucks/get_access": { "get": { "tags": [ "v1 Ваши машины" ], "summary": "Метод получения состояния доступности сервиса машин\nИспользуется мобильными приложениями", "operationId": "TrucksV1_GetAccess", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserAccessToAddTruckSummary" } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/trucks/integrator/v1/trucks/{truckId}/renew": { "put": { "tags": [ "v1 Ваши машины" ], "summary": "Обновление машины", "operationId": "TrucksV1_RenewPUT", "parameters": [ { "name": "truckId", "in": "path", "required": true, "description": "Идентификатор машины", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObsoleteSuccessView" } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/trucks/integrator/v1/unpublished-trucks/{truckId}": { "get": { "tags": [ "v1 Архив машин" ], "summary": "Получение архивированной машины", "operationId": "UnpublishedTrucksV1_GetUnpublishedTruckById", "parameters": [ { "name": "truckId", "in": "path", "required": true, "description": "Идентификатор машины", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckViewV1" } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] }, "delete": { "tags": [ "v1 Архив машин" ], "summary": "Удаление машины из архива", "operationId": "UnpublishedTrucksV1_DeleteTruckFromArchive", "parameters": [ { "name": "truckId", "in": "path", "required": true, "description": "Идентификатор машины.", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckViewV1" } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/trucks/integrator/v1/unpublished-trucks": { "get": { "tags": [ "v1 Архив машин" ], "summary": "Получение архивированных машин для контакта", "operationId": "UnpublishedTrucksV1_GetUnpublishedTrucksByContactId", "parameters": [ { "name": "contactId", "in": "query", "description": "Идентификатор контакта", "schema": { "type": "integer", "format": "int32", "nullable": true }, "x-position": 1, "example": 0 } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TruckViewV1" } } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] }, "delete": { "tags": [ "v1 Архив машин" ], "summary": "Массовое удаление машин из архива", "operationId": "UnpublishedTrucksV1_DeleteTrucksFromArchive", "requestBody": { "x-name": "truckIds", "description": "Идентификаторы машин.", "content": { "application/json": { "schema": { "type": "array", "nullable": true, "items": { "type": "string", "format": "guid" } } } }, "x-position": 1 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/trucks/integrator/v1/unpublished-trucks/{truckId}/restore": { "post": { "tags": [ "v1 Архив машин" ], "summary": "Восстановление одной машины", "operationId": "UnpublishedTrucksV1_RestoreTruckWithEditPOST", "parameters": [ { "name": "truckId", "in": "path", "required": true, "description": "Идентификатор машины.", "schema": { "type": "string", "format": "guid" }, "x-position": 2, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody": { "x-name": "truck", "description": "Данные восстанавливаемой машины.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckForInsertV1Request" } } }, "x-position": 1 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckViewV1" } } } }, "202": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckViewV1" } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/trucks/integrator/v1/trucks/renew": { "post": { "tags": [ "v1 Ваши машины" ], "summary": "Обновление нескольких машин", "operationId": "TrucksV1_RenewPOST2", "requestBody": { "x-name": "ids", "description": "Идентификаторы машин", "content": { "application/json": { "schema": { "type": "array", "nullable": true, "items": { "type": "string", "format": "guid" } } } }, "x-position": 1 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] }, "put": { "tags": [ "v1 Ваши машины" ], "summary": "Обновление нескольких машин", "operationId": "TrucksV1_RenewPUT2", "requestBody": { "x-name": "ids", "description": "Идентификаторы машин", "content": { "application/json": { "schema": { "type": "array", "nullable": true, "items": { "type": "string", "format": "guid" } } } }, "x-position": 1 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": {} } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/trucks/integrator/v1/trucks/comments": { "get": { "tags": [ "Комментарии ваших машин" ], "summary": "Получение комментариев по всем машинам пользователя", "operationId": "TrucksComments_GetCommentsForAllUserTrucks", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyCommentView" } } } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/trucks/integrator/v1/trucks/{truckId}/comments": { "get": { "tags": [ "Комментарии ваших машин" ], "summary": "Получение комментариев по машине", "operationId": "TrucksComments_GetTruckComments", "parameters": [ { "name": "truckId", "in": "path", "required": true, "description": "Идентификатор машины", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyCommentView" } } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] }, "put": { "tags": [ "Комментарии ваших машин" ], "summary": "Добавление/изменение комментария", "operationId": "TrucksComments_UpsertTruckCommentPUT", "parameters": [ { "name": "truckId", "in": "path", "required": true, "description": "Идентификатор машины", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody": { "x-name": "comment", "description": "Комментарий к машине", "content": { "application/json": { "schema": { "type": "string", "nullable": true } } }, "x-position": 2 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyCommentView" } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] }, "delete": { "tags": [ "Комментарии ваших машин" ], "summary": "Удаление комментария по машине", "operationId": "TrucksComments_DeleteTruckCommentDELETE", "parameters": [ { "name": "truckId", "in": "path", "required": true, "description": "Идентификатор машины", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { "description": "" }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/trucks/integrator/v1/trucks/{truckId}/comments/edit": { "post": { "tags": [ "Комментарии ваших машин" ], "summary": "Добавление/изменение комментария", "operationId": "TrucksComments_UpsertTruckCommentPOST2", "parameters": [ { "name": "truckId", "in": "path", "required": true, "description": "Идентификатор машины", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody": { "x-name": "comment", "description": "Комментарий к машине", "content": { "application/json": { "schema": { "type": "string", "nullable": true } } }, "x-position": 2 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyCommentView" } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/trucks/integrator/v1/trucks/{truckId}/comments/delete": { "post": { "tags": [ "Комментарии ваших машин" ], "summary": "Удаление комментария по машине", "operationId": "TrucksComments_DeleteTruckCommentPOST", "parameters": [ { "name": "truckId", "in": "path", "required": true, "description": "Идентификатор машины", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { "description": "" }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/trucks/integrator/v1/unpublished-trucks/{truckId}/comments": { "get": { "tags": [ "Комментарии архивных машин" ], "summary": "Получение комментариев по архивной машине", "operationId": "UnpublishedTrucksComments_GetUnpublishedTruckComments", "parameters": [ { "name": "truckId", "in": "path", "required": true, "description": "Идентификатор машины", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyCommentView" } } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] }, "put": { "tags": [ "Комментарии архивных машин" ], "summary": "Добавление/изменение комментария", "operationId": "UnpublishedTrucksComments_UpsertUnpublishedTruckCommentPUT", "parameters": [ { "name": "truckId", "in": "path", "required": true, "description": "Идентификатор машины", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody": { "x-name": "comment", "description": "Комментарий", "content": { "application/json": { "schema": { "type": "string", "nullable": true } } }, "x-position": 2 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyCommentView" } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] }, "delete": { "tags": [ "Комментарии архивных машин" ], "summary": "Удаление комментария по машине", "operationId": "UnpublishedTrucksComments_DeleteUnpublishedTruckCommentDELETE", "parameters": [ { "name": "truckId", "in": "path", "required": true, "description": "Идентификатор машины", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { "description": "" }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/trucks/integrator/v1/unpublished-trucks/comments": { "get": { "tags": [ "Комментарии архивных машин" ], "summary": "Получение комментариев по всем машинам пользователя", "operationId": "UnpublishedTrucksComments_GetCommentsForAllUserUnpublishedTrucks", "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/LegacyCommentView" } } } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/trucks/integrator/v1/unpublished-trucks/{truckId}/comments/edit": { "post": { "tags": [ "Комментарии архивных машин" ], "summary": "Добавление/изменение комментария", "operationId": "UnpublishedTrucksComments_UpsertUnpublishedTruckCommentPOST2", "parameters": [ { "name": "truckId", "in": "path", "required": true, "description": "Идентификатор машины", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody": { "x-name": "comment", "description": "Комментарий", "content": { "application/json": { "schema": { "type": "string", "nullable": true } } }, "x-position": 2 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LegacyCommentView" } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/trucks/integrator/v1/unpublished-trucks/{truckId}/comments/delete": { "post": { "tags": [ "Комментарии архивных машин" ], "summary": "Удаление комментария по машине", "operationId": "UnpublishedTrucksComments_DeleteUnpublishedTruckCommentPOST", "parameters": [ { "name": "truckId", "in": "path", "required": true, "description": "Идентификатор машины", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { "description": "" }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/trucks/integrator/v1/trucks/{truckId}/priority": { "put": { "tags": [ "v1 Ваши машины" ], "summary": "Изменение приоритетного показа в актуальной машине", "operationId": "TrucksV1_UpsertPriority", "parameters": [ { "name": "truckId", "in": "path", "required": true, "description": "Идентификатор машины", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody": { "x-name": "priority", "description": "Настройки приоритетного показа", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriorityDtoRequest" } } }, "x-position": 2 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckViewV1" } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] }, "delete": { "tags": [ "v1 Ваши машины" ], "summary": "Удаление приоритетного показа для машины", "operationId": "TrucksV1_DeletePriority", "parameters": [ { "name": "truckId", "in": "path", "required": true, "description": "Идентификатор машины", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckViewV1" } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "description": "Ошибка выполнения запроса к API машин.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "validation_error" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Ошибка валидации" }, "error_list": { "type": "array", "description": "Ошибки отдельных полей.", "nullable": true, "items": { "$ref": "#/components/schemas/IntegratorErrorItemResponse" } }, "remaining_minutes": { "type": "integer", "description": "Оставшееся время до повтора операции в минутах.", "format": "int32", "nullable": true, "example": 59 }, "duplicate_truck_id": { "type": "string", "description": "Идентификатор существующей машины-дубликата.", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/v1.1/trucks/{truckId}/counter_offers": { "put": { "tags": [ "TruckResponses" ], "parameters": [ { "name": "truckId", "in": "path", "required": true, "description": "ID машины", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "required": true, "description": "Данные встречного предложения", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTruckCounterOfferRequest" }, "example": { "offerer_contact_id": 0, "cash_sum": 65000, "currency_id": 1, "sum_with_nds": 0, "nds_currency_id": 0, "sum_without_nds": 0, "not_nds_currency_id": 0, "note": "Готовы забрать сегодня", "prepay_percent": 30, "delay_payment_days": 5, "loading_city_id": 146, "unloading_city_id": 2, "weight": 20, "volume": 82, "car_delivery_date": "2026-04-24T00:00:00Z", "unload_payment": false, "coloading": false } } } }, "responses": { "201": { "description": "Встречное предложение создано или изменено", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CounterOfferWithSenderView" } } } }, "4XX": { "$ref": "#/components/responses/CommonError" } } }, "delete": { "tags": [ "TruckResponses" ], "parameters": [ { "name": "truckId", "in": "path", "required": true, "description": "ID машины", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Удаленные встречные предложения", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CounterOfferWithSenderView" } } } } }, "204": { "description": "На машине не было отзывов" }, "4XX": { "$ref": "#/components/responses/CommonError" } } } }, "/v1.1/trucks/counter_offers/received": { "get": { "tags": [ "TruckResponses" ], "parameters": [ { "name": "newerThan", "in": "query", "required": false, "description": "Вернуть отзывы, измененные после указанной даты. Если модификатора часового пояса нет, дата отправляется в формате UTC+3 (Москва)", "schema": { "type": "string", "format": "date-time" } }, { "name": "includeArchived", "in": "query", "required": false, "description": "Включать архивные машины", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Список отзывов на ваши машины", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CounterOfferWithSenderView" } } } } }, "4XX": { "$ref": "#/components/responses/CommonError" } } } }, "/v1.1/trucks/counter_offers/by_truck_ids": { "post": { "tags": [ "TruckResponses" ], "parameters": [ { "name": "includeArchived", "in": "query", "required": false, "description": "Включать архивные машины", "schema": { "type": "boolean", "default": false } } ], "requestBody": { "required": true, "description": "Список ID машин", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckIdUuidList" }, "example": [ "ce303e3c-210b-ec11-bb9f-0cc47af30c1b", "80f2f0f4-89a9-4ff5-95eb-6cf7b4a577c1" ] } } }, "responses": { "200": { "description": "Встречные предложения по списку машин", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CounterOffersByTruckIdsView" } } } }, "4XX": { "$ref": "#/components/responses/CommonError" } } } }, "/v1.1/trucks/counter_offers/my": { "get": { "tags": [ "TruckResponses" ], "parameters": [ { "name": "newerThan", "in": "query", "required": false, "description": "Вернуть отзывы, измененные после указанной даты. Если модификатора часового пояса нет, дата отправляется в формате UTC+3 (Москва)", "schema": { "type": "string", "format": "date-time" } }, { "name": "includeArchived", "in": "query", "required": false, "description": "Включать архивные машины", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "Список ваших отзывов на чужие машины", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CounterOfferWithSenderView" } } } } }, "4XX": { "$ref": "#/components/responses/CommonError" } } } }, "/gw/truck_responses/public/v1.1/trucks/counter_offers/{offerId}": { "delete": { "tags": [ "TruckResponses" ], "parameters": [ { "name": "offerId", "in": "path", "required": true, "description": "ID отзыва", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Удаленный отзыв", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CounterOfferWithSenderView" } } } }, "4XX": { "$ref": "#/components/responses/CommonError" } } } }, "/gw/truck_responses/public/v1.1/trucks/counter_offers/unviewed_count/by_truck_ids": { "post": { "tags": [ "TruckResponses" ], "requestBody": { "required": true, "description": "Список truck_id машин.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckIdUuidList" }, "example": [ "ce303e3c-210b-ec11-bb9f-0cc47af30c1b", "80f2f0f4-89a9-4ff5-95eb-6cf7b4a577c1" ] } } }, "responses": { "200": { "description": "Количество непросмотренных встречных предложений по машинам", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnviewedCounterOffersCountByTruckResponse" } } } }, "4XX": { "$ref": "#/components/responses/CommonError" } } } }, "/gw/truck_responses/v2/trucks/counter-offers/unviewed-count/by-truck-ids": { "post": { "tags": [ "TruckResponses" ], "requestBody": { "required": true, "description": "Список ID машин", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckIdUuidList" }, "example": [ "ce303e3c-210b-ec11-bb9f-0cc47af30c1b", "80f2f0f4-89a9-4ff5-95eb-6cf7b4a577c1" ] } } }, "responses": { "200": { "description": "Количество непросмотренных встречных предложений по машинам", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnviewedCounterOffersCountByTruckResponse" } } } }, "4XX": { "$ref": "#/components/responses/CommonError" } } } }, "/gw/truck_responses/v1/trucks/published/counter_offers/count": { "post": { "tags": [ "TruckResponses" ], "requestBody": { "required": true, "description": "Список ID опубликованных машин", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckIdUuidList" }, "example": [ "ce303e3c-210b-ec11-bb9f-0cc47af30c1b", "80f2f0f4-89a9-4ff5-95eb-6cf7b4a577c1" ] } } }, "responses": { "200": { "description": "Счетчики встречных предложений по опубликованным машинам", "content": { "application/json": { "schema": { "type": "object", "x-dictionary-key-name": "truck_id", "additionalProperties": { "$ref": "#/components/schemas/YourCounterOffersCountView" } } } } }, "4XX": { "$ref": "#/components/responses/CommonError" } } } }, "/gw/truck_responses/v1/trucks/archive/counter_offers/count": { "post": { "tags": [ "TruckResponses" ], "requestBody": { "required": true, "description": "Список ID архивных машин", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TruckIdUuidList" }, "example": [ "ce303e3c-210b-ec11-bb9f-0cc47af30c1b", "80f2f0f4-89a9-4ff5-95eb-6cf7b4a577c1" ] } } }, "responses": { "200": { "description": "Счетчики встречных предложений по архивным машинам", "content": { "application/json": { "schema": { "type": "object", "x-dictionary-key-name": "truck_id", "additionalProperties": { "$ref": "#/components/schemas/ArchiveCounterOffersCountView" } } } } }, "4XX": { "$ref": "#/components/responses/CommonError" } } } }, "/v1.0/activities/statistics/{atiId}/year": { "get": { "parameters": [ { "in": "path", "name": "atiId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "examples": { "response": { "value": { "atiId": "1054756", "statisticItems": { "add_forum_msg": { "stats": { "2018-06-01T00:00:00": 3, "2018-07-01T00:00:00": 3, "2018-09-01T00:00:00": 1, "2018-10-01T00:00:00": 2, "2019-02-01T00:00:00": 1, "2019-04-01T00:00:00": 2, "2019-05-01T00:00:00": 1 }, "zone": 64 }, "add_load": { "stats": { "2018-06-01T00:00:00": 2, "2019-04-01T00:00:00": 1 }, "zone": 16 }, "add_truck": { "stats": { "2018-06-01T00:00:00": 2, "2018-09-01T00:00:00": 1, "2018-11-01T00:00:00": 1, "2019-02-01T00:00:00": 1 }, "zone": 8 }, "auction_participated": { "stats": {}, "zone": 32768 }, "auction_won": { "stats": {}, "zone": 65536 }, "deals_declined": { "stats": {}, "zone": 8192 }, "deals_declined_by_me": { "stats": {}, "zone": 4096 }, "deals_finished": { "stats": {}, "zone": 512 }, "exclusive_loads_count": { "stats": {}, "zone": 262144 }, "firm_participations_count": { "stats": { "2019-04-01T00:00:00": 2, "2019-05-01T00:00:00": 2 }, "zone": 1048576 }, "forum": { "stats": { "2018-05-01T00:00:00": 9, "2018-06-01T00:00:00": 15, "2018-07-01T00:00:00": 6, "2018-08-01T00:00:00": 6, "2018-09-01T00:00:00": 8, "2018-10-01T00:00:00": 9, "2018-11-01T00:00:00": 6, "2018-12-01T00:00:00": 6, "2019-01-01T00:00:00": 2, "2019-02-01T00:00:00": 4, "2019-03-01T00:00:00": 3, "2019-04-01T00:00:00": 12, "2019-05-01T00:00:00": 2 }, "zone": 32 }, "load_search": { "stats": { "2018-06-01T00:00:00": 10, "2018-07-01T00:00:00": 4, "2018-08-01T00:00:00": 7, "2018-09-01T00:00:00": 7, "2018-10-01T00:00:00": 5, "2018-11-01T00:00:00": 4, "2018-12-01T00:00:00": 5, "2019-02-01T00:00:00": 5, "2019-03-01T00:00:00": 7, "2019-04-01T00:00:00": 3 }, "zone": 4 }, "loads_count": { "stats": {}, "zone": 131072 }, "other": { "stats": { "2018-05-01T00:00:00": 13, "2018-06-01T00:00:00": 18, "2018-07-01T00:00:00": 14, "2018-08-01T00:00:00": 13, "2018-09-01T00:00:00": 11, "2018-10-01T00:00:00": 15, "2018-11-01T00:00:00": 21, "2018-12-01T00:00:00": 15, "2019-01-01T00:00:00": 9, "2019-02-01T00:00:00": 16, "2019-03-01T00:00:00": 12, "2019-04-01T00:00:00": 17, "2019-05-01T00:00:00": 6 }, "zone": 1 }, "own_auction_finished": { "stats": {}, "zone": 16384 }, "own_deals_declined": { "stats": {}, "zone": 2048 }, "own_deals_declined_by_me": { "stats": {}, "zone": 1024 }, "own_deals_finished": { "stats": {}, "zone": 256 }, "tender": { "stats": { "2018-05-01T00:00:00": 3, "2018-06-01T00:00:00": 2, "2018-07-01T00:00:00": 3, "2018-08-01T00:00:00": 1, "2018-09-01T00:00:00": 3, "2018-10-01T00:00:00": 3, "2018-11-01T00:00:00": 3, "2018-12-01T00:00:00": 2, "2019-04-01T00:00:00": 1 }, "zone": 128 }, "truck_search": { "stats": { "2018-05-01T00:00:00": 2, "2018-06-01T00:00:00": 5, "2018-07-01T00:00:00": 2, "2018-08-01T00:00:00": 3, "2018-09-01T00:00:00": 2, "2018-10-01T00:00:00": 1, "2018-11-01T00:00:00": 4, "2018-12-01T00:00:00": 2, "2019-03-01T00:00:00": 1 }, "zone": 2 }, "users_count_on_firm_boards": { "stats": { "2019-04-01T00:00:00": 0, "2019-05-01T00:00:00": 0 }, "zone": 524288 } } } } }, "schema": { "$ref": "#/components/schemas/UserSiteActivityStatistics" } } }, "description": "Success" }, "401": { "content": { "application/json": { "examples": { "response": { "value": { "Code": 401, "Message": "Unauthorized" } } }, "schema": { "$ref": "#/components/schemas/activities__ExceptionResult" } } }, "description": "Unauthorized" }, "403": { "content": { "application/json": { "examples": { "response": { "value": { "Code": 403, "Message": "Forbidden" } } }, "schema": { "$ref": "#/components/schemas/activities__ExceptionResult" } } }, "description": "Forbidden" } }, "tags": [ "UserSiteActivities" ], "operationId": "GetStatisticsPastYearPublic", "summary": "Получить статистику фирмы за год" } }, "/webhooks/v1/create": { "post": { "tags": [ "Create" ], "summary": "Создаёт вебхук.", "operationId": "Create_Create", "requestBody": { "x-name": "Request", "description": "Запрос создания вебхука", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HookCreate" } } }, "required": true, "x-position": 6 }, "responses": { "202": { "description": "HTTP 202, если создание принято;\n4XX при ошибке запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptedView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ErrorViewBase" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/gw/oauth2/webhooks/v1/create": { "post": { "tags": [ "Create" ], "summary": "Создаёт вебхук.", "operationId": "Create_Create", "requestBody": { "x-name": "Request", "description": "Запрос создания вебхука", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HookCreate" } } }, "required": true, "x-position": 6 }, "responses": { "202": { "description": "HTTP 202, если создание принято;\n4XX при ошибке запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptedView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ErrorViewBase" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/webhooks/v1/status/{id}": { "get": { "tags": [ "Status" ], "summary": "Возвращает состояние вебхука.", "operationId": "Status_Status", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Идентификатор вебхука.", "schema": { "type": "string", "example": "644bdc87dbd6fc3747887c7b" }, "x-position": 1 } ], "responses": { "200": { "description": "HTTP 200 с состоянием вебхука при успехе;\n4XX при ошибке запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HookStatusView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ErrorViewBase" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/gw/oauth2/webhooks/v1/status/{id}": { "get": { "tags": [ "Status" ], "summary": "Возвращает состояние вебхука.", "operationId": "Status_Status", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Идентификатор вебхука.", "schema": { "type": "string", "example": "644bdc87dbd6fc3747887c7b" }, "x-position": 1 } ], "responses": { "200": { "description": "HTTP 200 с состоянием вебхука при успехе;\n4XX при ошибке запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HookStatusView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ErrorViewBase" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/webhooks/v1/subscriptions/{id}": { "get": { "tags": [ "Get" ], "summary": "Получить параметры фильтра", "operationId": "Get_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Идентификатор подписки.", "schema": { "type": "string", "example": "644bdc87dbd6fc3747887c7b" }, "x-position": 1, "example": "644bdc87dbd6fc3747887c7b" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionParametersView" } } } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Edit" ], "summary": "Отредактировать параметры фильтра", "operationId": "Edit_Edit", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Идентификатор подписки.", "schema": { "type": "string", "example": "644bdc87dbd6fc3747887c7b" }, "x-position": 1, "example": "644bdc87dbd6fc3747887c7b" } ], "requestBody": { "x-name": "Parameters", "description": "Параметры фильтра", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionParametersDto" } } }, "required": true, "x-position": 4 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionParametersView" } } } } }, "security": [ { "JWT": [] } ] } }, "/gw/oauth2/webhooks/v1/subscriptions/{id}": { "get": { "tags": [ "Get" ], "summary": "Получить параметры фильтра", "operationId": "Get_Get", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Идентификатор подписки.", "schema": { "type": "string", "example": "644bdc87dbd6fc3747887c7b" }, "x-position": 1, "example": "644bdc87dbd6fc3747887c7b" } ], "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionParametersView" } } } } }, "security": [ { "JWT": [] } ] }, "put": { "tags": [ "Edit" ], "summary": "Отредактировать параметры фильтра", "operationId": "Edit_Edit", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Идентификатор подписки.", "schema": { "type": "string", "example": "644bdc87dbd6fc3747887c7b" }, "x-position": 1, "example": "644bdc87dbd6fc3747887c7b" } ], "requestBody": { "x-name": "Parameters", "description": "Параметры фильтра", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionParametersDto" } } }, "required": true, "x-position": 4 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubscriptionParametersView" } } } } }, "security": [ { "JWT": [] } ] } }, "/webhooks/v1/status": { "get": { "tags": [ "Status" ], "summary": "Возвращает состояния нескольких вебхуков.", "operationId": "Status_StatusAll", "parameters": [ { "name": "statuses", "in": "query", "style": "form", "explode": true, "description": "Фильтр по состояниям вебхуков.", "schema": { "type": "array", "nullable": true, "example": "active", "items": { "$ref": "#/components/schemas/HookStatusType" } }, "x-position": 3 } ], "responses": { "200": { "description": "HTTP 200 со списком состояний вебхуков.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HookStatusView" } } } } } }, "security": [ { "JWT": [] } ] } }, "/gw/oauth2/webhooks/v1/status": { "get": { "tags": [ "Status" ], "summary": "Возвращает состояния нескольких вебхуков.", "operationId": "Status_StatusAll", "parameters": [ { "name": "statuses", "in": "query", "style": "form", "explode": true, "description": "Фильтр по состояниям вебхуков.", "schema": { "type": "array", "nullable": true, "example": "active", "items": { "$ref": "#/components/schemas/HookStatusType" } }, "x-position": 3 } ], "responses": { "200": { "description": "HTTP 200 со списком состояний вебхуков.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HookStatusView" } } } } } }, "security": [ { "JWT": [] } ] } }, "/webhooks/v1/distributions/failed/{id}": { "get": { "tags": [ "Distributions" ], "summary": "Возвращает проваленные отправки вебхука.", "operationId": "Distributions_GetFailed", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Идентификатор вебхука.", "schema": { "type": "string", "example": "644bdc87dbd6fc3747887c7b" }, "x-position": 1 }, { "name": "since", "in": "query", "description": "Начальная дата фильтра (UTC).", "schema": { "type": "string", "format": "date-time", "nullable": true, "example": "2024-01-15T10:30:00Z" }, "x-position": 2 } ], "responses": { "200": { "description": "HTTP 200 со списком проваленных отправок;\n4XX при ошибке запроса.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FailedDistributionView" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ErrorViewBase" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/gw/oauth2/webhooks/v1/distributions/failed/{id}": { "get": { "tags": [ "Distributions" ], "summary": "Возвращает проваленные отправки вебхука.", "operationId": "Distributions_GetFailed", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Идентификатор вебхука.", "schema": { "type": "string", "example": "644bdc87dbd6fc3747887c7b" }, "x-position": 1 }, { "name": "since", "in": "query", "description": "Начальная дата фильтра (UTC).", "schema": { "type": "string", "format": "date-time", "nullable": true, "example": "2024-01-15T10:30:00Z" }, "x-position": 2 } ], "responses": { "200": { "description": "HTTP 200 со списком проваленных отправок;\n4XX при ошибке запроса.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FailedDistributionView" } } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ErrorViewBase" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/webhooks/v1/delete/{id}": { "delete": { "tags": [ "Delete" ], "summary": "Удаляет вебхук.", "operationId": "Delete_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Идентификатор вебхука.", "schema": { "type": "string", "example": "644bdc87dbd6fc3747887c7b" }, "x-position": 1 } ], "responses": { "202": { "description": "HTTP 202, если удаление принято;\n4XX при ошибке запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptedView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ErrorViewBase" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/gw/oauth2/webhooks/v1/delete/{id}": { "delete": { "tags": [ "Delete" ], "summary": "Удаляет вебхук.", "operationId": "Delete_Delete", "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Идентификатор вебхука.", "schema": { "type": "string", "example": "644bdc87dbd6fc3747887c7b" }, "x-position": 1 } ], "responses": { "202": { "description": "HTTP 202, если удаление принято;\n4XX при ошибке запроса.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcceptedView" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ErrorViewBase" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/oauth2/token": { "post": { "tags": [ "Auth" ], "summary": "Выпускает или обновляет access-токен.", "operationId": "post_token", "requestBody": { "description": "Данные для выпуска или обновления access-токена.", "content": { "application/json-patch+json": { "schema": { "allOf": [ { "description": "Запрос на выпуск или обновление access-токена.", "$ref": "#/components/schemas/AccessTokenRequest" } ], "description": "Запрос на выпуск или обновление access-токена.", "example": { "client_id": "\n ati-cargo-app\n ", "client_secret": "\n secret-abc-123\n ", "code": "\n auth-code-123\n ", "refresh_token": "\n refresh-token-123\n ", "grant_type": 0 } }, "example": { "client_id": "\n ati-cargo-app\n ", "client_secret": "\n secret-abc-123\n ", "code": "\n auth-code-123\n ", "refresh_token": "\n refresh-token-123\n ", "grant_type": 0 } }, "application/json": { "schema": { "allOf": [ { "description": "Запрос на выпуск или обновление access-токена.", "$ref": "#/components/schemas/AccessTokenRequest" } ], "description": "Запрос на выпуск или обновление access-токена.", "example": { "client_id": "\n ati-cargo-app\n ", "client_secret": "\n secret-abc-123\n ", "code": "\n auth-code-123\n ", "refresh_token": "\n refresh-token-123\n ", "grant_type": 0 } }, "example": { "client_id": "\n ati-cargo-app\n ", "client_secret": "\n secret-abc-123\n ", "code": "\n auth-code-123\n ", "refresh_token": "\n refresh-token-123\n ", "grant_type": 0 } }, "text/json": { "schema": { "allOf": [ { "description": "Запрос на выпуск или обновление access-токена.", "$ref": "#/components/schemas/AccessTokenRequest" } ], "description": "Запрос на выпуск или обновление access-токена.", "example": { "client_id": "\n ati-cargo-app\n ", "client_secret": "\n secret-abc-123\n ", "code": "\n auth-code-123\n ", "refresh_token": "\n refresh-token-123\n ", "grant_type": 0 } }, "example": { "client_id": "\n ati-cargo-app\n ", "client_secret": "\n secret-abc-123\n ", "code": "\n auth-code-123\n ", "refresh_token": "\n refresh-token-123\n ", "grant_type": 0 } }, "application/*+json": { "schema": { "allOf": [ { "description": "Запрос на выпуск или обновление access-токена.", "$ref": "#/components/schemas/AccessTokenRequest" } ], "description": "Запрос на выпуск или обновление access-токена.", "example": { "client_id": "\n ati-cargo-app\n ", "client_secret": "\n secret-abc-123\n ", "code": "\n auth-code-123\n ", "refresh_token": "\n refresh-token-123\n ", "grant_type": 0 } }, "example": { "client_id": "\n ati-cargo-app\n ", "client_secret": "\n secret-abc-123\n ", "code": "\n auth-code-123\n ", "refresh_token": "\n refresh-token-123\n ", "grant_type": 0 } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Данные access-токена OAuth-клиента.", "$ref": "#/components/schemas/AccessTokenModel" }, "example": { "client_id": "\n ati-cargo-app\n ", "firm_id": 12345, "contact_id": 67890, "access_token": "\n access-token-123\n ", "scope": "\n profile orders.read\n ", "refresh_token": "\n refresh-token-123\n ", "token_type": "\n Bearer\n ", "o_auth_user_id": "\n 2f7b0a74-2c2f-4f1f-9a63-cac4a7d0b2f4\n ", "expire_time": "\n 2024-01-15T10:30:00Z\n ", "expires_in": 3600 } } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Не авторизован", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "un_authorized", "reason": "Не авторизован" } } } }, "402": { "description": "Метод доступен только платным пользователям.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "payment_required", "reason": "Метод доступен только платным пользователям." } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "504": { "description": "Сервер не ответил во время.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "timeout", "reason": "Сервер не ответил во время." } } } } } } }, "/oauth2/info": { "get": { "tags": [ "Users" ], "summary": "Возвращает внешний идентификатор текущего пользователя.", "operationId": "get_info", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "description": "Внешний идентификатор пользователя для интеграторов.", "$ref": "#/components/schemas/OAuthUser" }, "example": { "firm_id": 12345, "contact_id": 67890, "o_auth_user_id": "\n 2f7b0a74-2c2f-4f1f-9a63-cac4a7d0b2f4\n " } } } }, "400": { "description": "Неверные входные данные.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } } } }, "401": { "description": "Unauthorized" }, "402": { "description": "Метод доступен только платным пользователям.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "payment_required", "reason": "Метод доступен только платным пользователям." } } } }, "403": { "description": "Отсутствует разрешение.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "forbidden", "reason": "Отсутствует разрешение." } } } }, "404": { "description": "Ресурс не найден", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "not_found", "reason": "Ресурс не найден" } } } }, "500": { "description": "Произошла ошибка во время выполнения запроса.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "internal_error", "reason": "Произошла ошибка во время выполнения запроса." } } } }, "504": { "description": "Сервер не ответил во время.", "content": { "application/json": { "schema": { "description": "Стандартный ответ с описанием ошибки", "$ref": "#/components/schemas/sphinx-search-api__ErrorResponse" }, "example": { "error": "timeout", "reason": "Сервер не ответил во время." } } } } } } }, "/impersonaldeals/v1/get_deals": { "post": { "tags": [ "Обезличенные сделки" ], "summary": "Получить обезличенные сделки", "description": "Возвращает обезличенные сделки, удовлетворяющие переданным параметрам.\n\nПри `demo=true` возвращает демонстрационный набор данных без обращения к реальным сделкам.", "operationId": "get_deals_v1_get_deals_post", "parameters": [ { "name": "demo", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Вернуть демонстрационные данные вместо реальных сделок (для тестового доступа).", "examples": [ false ], "default": false, "title": "Demo" }, "description": "Вернуть демонстрационные данные вместо реальных сделок (для тестового доступа).", "example": false } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDealsParams" } } } }, "responses": { "200": { "description": "Обезличенные сделки, удовлетворяющие параметрам", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReturnData" }, "title": "Response 200 Get Deals V1 Get Deals Post" } } } }, "400": { "description": "Слишком большой объём данных под запрос. Код: `FACELESS_41_LARGE_DEALS_NUMBER_SIZE`", "content": { "application/json": { "examples": { "single": { "summary": "Одна ошибка: error_list пуст", "value": { "error": "FACELESS_41_LARGE_DEALS_NUMBER_SIZE", "reason": "Данных под запрос больше 20 Мб. Измените параметры поиска.", "error_list": [] } } }, "schema": { "$ref": "#/components/schemas/faceless_api__ErrorFormatResponse" } } } }, "402": { "description": "Не удалось списать атисы за запрошенные сделки. Возможные коды: `FACELESS_49_GET_DEALS_BILLING_ERROR`, `FACELESS_51_NOT_ENOUGH_MONEY`, `FACELESS_50_PAYMENT_FORBIDDEN`", "content": { "application/json": { "examples": { "single": { "summary": "Одна ошибка: error_list пуст", "value": { "error": "FACELESS_49_GET_DEALS_BILLING_ERROR", "reason": "Мы не смогли списать атисы за запрошенные сделки. Повторите попытку позже.", "error_list": [] } } }, "schema": { "$ref": "#/components/schemas/faceless_api__ErrorFormatResponse" } } } }, "403": { "description": "Доступ запрещён. Возможные коды: `FACELESS_42_FORBIDDEN`, `FACELESS_48_DATE_BLOCK`, `FACELESS_47_MAX_DEALS_BLOCK`, `FACELESS_46_MIN_DEALS_BLOCK`", "content": { "application/json": { "examples": { "single": { "summary": "Одна ошибка: error_list пуст", "value": { "error": "FACELESS_42_FORBIDDEN", "reason": "У вас нет доступа к этому API!", "details": { "about": "Доступ к API предоставляется по запросу. По вопросам подключения обращайтесь к Александру Вильде. Email: sas@ati.su Телефон: + 7-812-602-01-04 доб.108" }, "error_list": [] } } }, "schema": { "$ref": "#/components/schemas/faceless_api__ErrorFormatResponse" } } } }, "404": { "description": "Отсутствуют сделки по данным параметрам. Код: `FACELESS_39_DEALS_NOT_FOUND`", "content": { "application/json": { "examples": { "single": { "summary": "Одна ошибка: error_list пуст", "value": { "error": "FACELESS_39_DEALS_NOT_FOUND", "reason": "Нет сделок по заданным параметрам. Измените параметры поиска.", "error_list": [] } } }, "schema": { "$ref": "#/components/schemas/faceless_api__ErrorFormatResponse" } } } }, "408": { "description": "Время ожидания истекло. Код: `FACELESS_40_LARGE_DEALS_NUMBER_TIMEOUT`", "content": { "application/json": { "examples": { "single": { "summary": "Одна ошибка: error_list пуст", "value": { "error": "FACELESS_40_LARGE_DEALS_NUMBER_TIMEOUT", "reason": "Данных под запрос слишком много. Время ожидания истекло. Измените параметры поиска.", "error_list": [] } } }, "schema": { "$ref": "#/components/schemas/faceless_api__ErrorFormatResponse" } } } }, "422": { "description": "Неверные входные параметры. Возможные коды: `FACELESS_37_FIELD_REQUIRED`, `FACELESS_14_WRONG_DATE_FORMAT`, `FACELESS_45_DATE_OUT_OF_RANGE`, `FACELESS_32_START_DATE_GT_END_DATE`, `FACELESS_31_FROM_OR_TO_NEEDED`, `FACELESS_30_WRONG_ADR`, `FACELESS_25_WRONG_ATI_GEO_POINT_TYPE`, `FACELESS_26_ATI_COUNTRY_NOT_FOUND`, `FACELESS_27_ATI_REGION_NOT_FOUND`, `FACELESS_28_ATI_CITY_NOT_FOUND`, `FACELESS_33_BAD_COUNTRY`, `FACELESS_53_VALIDATION_ERROR`, `FACELESS_54_CONDITION_ERROR`", "content": { "application/json": { "examples": { "multiple": { "summary": "Несколько ошибок: разбирать нужно error_list", "value": { "error": "validation_errors", "reason": "Произошли ошибки валидации", "error_list": [ { "error": "FACELESS_37_FIELD_REQUIRED", "reason": "Отсутствует обязательное поле!", "details": { "location": "StartDate" } }, { "error": "FACELESS_14_WRONG_DATE_FORMAT", "reason": "Укажите дату в формате ISO-8601 (YYYY-MM-DD).", "details": { "location": "EndDate" } } ] } } }, "schema": { "$ref": "#/components/schemas/faceless_api__ErrorFormatResponse" } } } } } } }, "/impersonaldeals/v1/give_deals": { "post": { "tags": [ "Обезличенные сделки" ], "summary": "Предоставить обезличенные сделки", "description": "Принимает и сохраняет обезличенные сделки.\n\nПри `demo=true` сделки проходят ту же валидацию, что и при реальной отправке, и\nметод отдаёт те же ошибки, но сделки не сохраняются и атисы не списываются.", "operationId": "give_deals_v1_give_deals_post", "parameters": [ { "name": "demo", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Если `true`, сделки проходят ту же валидацию, что и при реальной отправке, но не сохраняются и не тарифицируются (тестовый режим).", "examples": [ false ], "default": false, "title": "Demo" }, "description": "Если `true`, сделки проходят ту же валидацию, что и при реальной отправке, но не сохраняются и не тарифицируются (тестовый режим).", "example": false } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ThirdPartyDealsParams" }, "example": { "Data": [ { "LoadId": "E45CCE73-Q040-6641-A19A-FFFFFFFFFFFF", "Date": "2021-01-01", "From": { "AtiId": { "Id": 3611, "Type": 2 } }, "To": { "AtiId": { "Id": 1, "Type": 2 } }, "Distance": 750, "Weight": 45.5, "CarType": 1, "DogruzType": 1, "Rate": "27500.00", "CurrencyId": 1, "PaymentType": 2, "Executor": 1 } ] } } } }, "responses": { "200": { "description": "Ваши данные успешно приняты. Тело ответа — boolean `true`. При `demo=true` означает, что сделки прошли валидацию, но сохранены не были.", "content": { "application/json": { "schema": { "type": "boolean" }, "example": true } } }, "402": { "description": "Не удалось начислить атисы, сделки не были загружены. Код: `FACELESS_52_GIVE_DEALS_BILLING_ERROR`", "content": { "application/json": { "examples": { "single": { "summary": "Одна ошибка: error_list пуст", "value": { "error": "FACELESS_52_GIVE_DEALS_BILLING_ERROR", "reason": "Мы не смогли начислить атисы. Сделки не были загружены. Повторите загрузку позже.", "error_list": [] } } }, "schema": { "$ref": "#/components/schemas/faceless_api__ErrorFormatResponse" } } } }, "403": { "description": "Доступ запрещён. Возможные коды: `FACELESS_42_FORBIDDEN`, `FACELESS_48_DATE_BLOCK`", "content": { "application/json": { "examples": { "single": { "summary": "Одна ошибка: error_list пуст", "value": { "error": "FACELESS_42_FORBIDDEN", "reason": "У вас нет доступа к этому API!", "details": { "about": "Доступ к API предоставляется по запросу. По вопросам подключения обращайтесь к Александру Вильде. Email: sas@ati.su Телефон: + 7-812-602-01-04 доб.108" }, "error_list": [] } } }, "schema": { "$ref": "#/components/schemas/faceless_api__ErrorFormatResponse" } } } }, "411": { "description": "Все ошибки в пакете — одного кода: не удалось рассчитать расстояние. Если среди ошибок есть хотя бы одна с другим кодом, возвращается 422. Сделки без ошибок при этом сохраняются. Код: `FACELESS_3_UNCALCULATED_DISTANCE`", "content": { "application/json": { "examples": { "multiple": { "summary": "Несколько ошибок: разбирать нужно error_list", "value": { "error": "validation_errors", "reason": "Произошли ошибки валидации", "error_list": [ { "error": "FACELESS_3_UNCALCULATED_DISTANCE", "reason": "Не удалось рассчитать расстояние между точками. Укажите его самостоятельно.", "details": { "location": "Data -> 0 -> Distance", "index": 0, "LoadId": "test001" } } ] } } }, "schema": { "$ref": "#/components/schemas/faceless_api__ErrorFormatResponse" } } } }, "422": { "description": "Ошибки валидации переданных сделок. Одна сделка может дать несколько ошибок, все они перечислены в `error_list`: `details.index` и `details.LoadId` указывают на проблемную сделку в массиве `Data`, а `details.location` — на конкретное поле. Возможные значения `error` перечислены в схеме `FacelessErrorCode`. Сделки без ошибок при этом сохраняются: ответ 422 не означает, что не принят весь пакет. При `demo=true` не сохраняется ничего, но состав ошибок тот же.", "content": { "application/json": { "examples": { "multiple": { "summary": "Несколько ошибок: разбирать нужно error_list", "value": { "error": "validation_errors", "reason": "Произошли ошибки валидации", "error_list": [ { "error": "FACELESS_28_ATI_CITY_NOT_FOUND", "reason": "Данного города нет в списке городов ATI.SU!", "details": { "location": "Data -> 0 -> From -> AtiId -> Id", "index": 0, "LoadId": "test001" } }, { "error": "FACELESS_15_WEIGHT_OR_VOLUME_NEEDED", "reason": "Укажите значение Weight или Volume. Один из параметров обязательно должен быть заполнен.", "details": { "location": "Data -> 1", "index": 1, "LoadId": "test002" } } ] } } }, "schema": { "$ref": "#/components/schemas/faceless_api__ErrorFormatResponse" } } } } } } }, "/impersonaldeals/v1/get_deals_count": { "post": { "tags": [ "Обезличенные сделки" ], "summary": "Получить количество обезличенных сделок", "description": "Возвращает количество обезличенных сделок, удовлетворяющих переданным параметрам.", "operationId": "get_deals_count_v1_get_deals_count_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DealsParams" } } }, "required": true }, "responses": { "200": { "description": "Количество обезличенных сделок, удовлетворяющих параметрам", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DataCount" } } } }, "403": { "description": "Доступ запрещён. Возможные коды: `FACELESS_42_FORBIDDEN`, `FACELESS_48_DATE_BLOCK`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/faceless_api__ErrorFormatResponse" }, "examples": { "single": { "summary": "Одна ошибка: error_list пуст", "value": { "error": "FACELESS_42_FORBIDDEN", "reason": "У вас нет доступа к этому API!", "details": { "about": "Доступ к API предоставляется по запросу. По вопросам подключения обращайтесь к Александру Вильде. Email: sas@ati.su Телефон: + 7-812-602-01-04 доб.108" }, "error_list": [] } } } } } }, "422": { "description": "Неверные входные параметры. Возможные коды: `FACELESS_37_FIELD_REQUIRED`, `FACELESS_14_WRONG_DATE_FORMAT`, `FACELESS_45_DATE_OUT_OF_RANGE`, `FACELESS_32_START_DATE_GT_END_DATE`, `FACELESS_31_FROM_OR_TO_NEEDED`, `FACELESS_30_WRONG_ADR`, `FACELESS_25_WRONG_ATI_GEO_POINT_TYPE`, `FACELESS_26_ATI_COUNTRY_NOT_FOUND`, `FACELESS_27_ATI_REGION_NOT_FOUND`, `FACELESS_28_ATI_CITY_NOT_FOUND`, `FACELESS_33_BAD_COUNTRY`, `FACELESS_53_VALIDATION_ERROR`, `FACELESS_54_CONDITION_ERROR`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/faceless_api__ErrorFormatResponse" }, "examples": { "multiple": { "summary": "Несколько ошибок: разбирать нужно error_list", "value": { "error": "validation_errors", "reason": "Произошли ошибки валидации", "error_list": [ { "error": "FACELESS_37_FIELD_REQUIRED", "reason": "Отсутствует обязательное поле!", "details": { "location": "StartDate" } }, { "error": "FACELESS_14_WRONG_DATE_FORMAT", "reason": "Укажите дату в формате ISO-8601 (YYYY-MM-DD).", "details": { "location": "EndDate" } } ] } } } } } } } } }, "/impersonaldeals/v1/get_deals_statistic": { "post": { "tags": [ "Обезличенные сделки" ], "summary": "Получить статистику по принятым/отданным сделкам", "description": "Возвращает статистику по принятым/отданным сделкам за период.\n\nСтатистика формируется по своей фирме и группируется по типам сделок (город-город, регион-регион) и временным периодам.", "operationId": "get_deals_statistic_v1_get_deals_statistic_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetStatistic" } } }, "required": true }, "responses": { "200": { "description": "Статистика по принятым/отданным сделкам", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Statistic" }, "example": { "GivenDealsCityToCity": { "FromNowTo6MonthsAgo": { "Count": 120, "OneDealsPrice": 27500, "TotalSum": 3300000 }, "From6MonthsTo12MonthsAgo": { "Count": 60, "OneDealsPrice": 27500, "TotalSum": 1650000 }, "From1YearTo2YearsAgo": { "Count": 40, "OneDealsPrice": 27500, "TotalSum": 1100000 }, "From2YearsTo4YearsAgo": { "Count": 20, "OneDealsPrice": 27500, "TotalSum": 550000 }, "From4YearsAgo": { "Count": 10, "OneDealsPrice": 27500, "TotalSum": 275000 } }, "TakenDealsCityToCity": { "FromNowTo6MonthsAgo": { "Count": 70, "OneDealsPrice": 27500, "TotalSum": 1925000 }, "From6MonthsTo12MonthsAgo": { "Count": 40, "OneDealsPrice": 27500, "TotalSum": 1100000 }, "From1YearTo2YearsAgo": { "Count": 25, "OneDealsPrice": 27500, "TotalSum": 687500 }, "From2YearsTo4YearsAgo": { "Count": 15, "OneDealsPrice": 27500, "TotalSum": 412500 }, "From4YearsAgo": { "Count": 5, "OneDealsPrice": 27500, "TotalSum": 137500 } }, "GivenDealsRegionToRegion": { "FromNowTo6MonthsAgo": { "Count": 40, "OneDealsPrice": 27500, "TotalSum": 1100000 }, "From6MonthsTo12MonthsAgo": { "Count": 25, "OneDealsPrice": 27500, "TotalSum": 687500 }, "From1YearTo2YearsAgo": { "Count": 15, "OneDealsPrice": 27500, "TotalSum": 412500 }, "From2YearsTo4YearsAgo": { "Count": 7, "OneDealsPrice": 27500, "TotalSum": 192500 }, "From4YearsAgo": { "Count": 3, "OneDealsPrice": 27500, "TotalSum": 82500 } }, "TakenDealsRegionToRegion": { "FromNowTo6MonthsAgo": { "Count": 25, "OneDealsPrice": 27500, "TotalSum": 687500 }, "From6MonthsTo12MonthsAgo": { "Count": 15, "OneDealsPrice": 27500, "TotalSum": 412500 }, "From1YearTo2YearsAgo": { "Count": 8, "OneDealsPrice": 27500, "TotalSum": 220000 }, "From2YearsTo4YearsAgo": { "Count": 5, "OneDealsPrice": 27500, "TotalSum": 137500 }, "From4YearsAgo": { "Count": 2, "OneDealsPrice": 27500, "TotalSum": 55000 } }, "AllGivenCount": 340, "AllGivenPrice": 9350000, "AllTakenCount": 210, "AllTakenPrice": 5775000, "GivenInLast30Days": 28, "CurrentTakeLimit": 100, "CurrentTakenCount": 15 } } } }, "403": { "description": "Доступ запрещён. Возможные коды: `FACELESS_42_FORBIDDEN`, `FACELESS_48_DATE_BLOCK`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/faceless_api__ErrorFormatResponse" }, "examples": { "single": { "summary": "Одна ошибка: error_list пуст", "value": { "error": "FACELESS_42_FORBIDDEN", "reason": "У вас нет доступа к этому API!", "details": { "about": "Доступ к API предоставляется по запросу. По вопросам подключения обращайтесь к Александру Вильде. Email: sas@ati.su Телефон: + 7-812-602-01-04 доб.108" }, "error_list": [] } } } } } }, "404": { "description": "Нет сделок по заданным параметрам. Код: `FACELESS_39_DEALS_NOT_FOUND`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/faceless_api__ErrorFormatResponse" }, "examples": { "single": { "summary": "Одна ошибка: error_list пуст", "value": { "error": "FACELESS_39_DEALS_NOT_FOUND", "reason": "Нет сделок по заданным параметрам. Измените параметры поиска.", "error_list": [] } } } } } }, "422": { "description": "Неверные входные параметры. Возможные коды: `FACELESS_37_FIELD_REQUIRED`, `FACELESS_14_WRONG_DATE_FORMAT`, `FACELESS_45_DATE_OUT_OF_RANGE`, `FACELESS_32_START_DATE_GT_END_DATE`, `FACELESS_53_VALIDATION_ERROR`, `FACELESS_54_CONDITION_ERROR`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/faceless_api__ErrorFormatResponse" }, "examples": { "multiple": { "summary": "Несколько ошибок: разбирать нужно error_list", "value": { "error": "validation_errors", "reason": "Произошли ошибки валидации", "error_list": [ { "error": "FACELESS_37_FIELD_REQUIRED", "reason": "Отсутствует обязательное поле!", "details": { "location": "StartDate" } }, { "error": "FACELESS_14_WRONG_DATE_FORMAT", "reason": "Укажите дату в формате ISO-8601 (YYYY-MM-DD).", "details": { "location": "EndDate" } } ] } } } } } } } } }, "/gw/norn/v2/all_directions": { "get": { "summary": "Возвращает список доступных направлений - для интеграторов", "operationId": "get_all_directions_v2_all_directions_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllDirectionsResponseV1", "type": "string", "title": "Response 200 Get All Directions V2 All Directions Get" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recommended_price__ErrorFormatResponse" } } } } } } }, "/gw/norn/v1/all_directions": { "get": { "summary": "Возвращает список доступных направлений - для интеграторов", "operationId": "get_all_directions_v1_all_directions_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllDirectionsResponseV1", "type": "string", "title": "Response 200 Get All Directions V1 All Directions Get" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recommended_price__ErrorFormatResponse" } } } } } } }, "/gw/norn/v2/chart": { "post": { "summary": "Возвращает рекомендованные цены, СС и сделки по заданным параметрам", "description": "Возвращает рекомендованные цены, СС и сделки по заданным параметрам.\nДоступные направления брать из методов `/all_directions`.\n\nЕсли по направлению нет данных на определённую дату, то соответствующая\nточка в ответе будет отсутствовать и значения в параметрах динамики\nна отсутствующую дату будет `null`.\n\nЗначения `*_line` в ответе отсортированы по убыванию даты в `x`", "operationId": "get_priceline_v2_chart_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InputParams" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiteChartResponse", "type": "string", "title": "Response 200 Get Priceline V2 Chart Post" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recommended_price__ErrorFormatResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recommended_price__ErrorFormatResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recommended_price__HTTPValidationError" } } } } } } }, "/gw/norn/v1/chart": { "post": { "summary": "Возвращает рекомендованные цены, СС и сделки по заданным параметрам", "description": "Возвращает рекомендованные цены, СС и сделки по заданным параметрам.\nДоступные направления брать из методов `/all_directions`.\n\nЕсли по направлению нет данных на определённую дату, то соответствующая\nточка в ответе будет отсутствовать и значения в параметрах динамики\nна отсутствующую дату будет `null`.\n\nЗначения `*_line` в ответе отсортированы по убыванию даты в `x`", "operationId": "get_priceline_v1_chart_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InputParams" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SiteChartResponse", "type": "string", "title": "Response 200 Get Priceline V1 Chart Post" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recommended_price__ErrorFormatResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recommended_price__ErrorFormatResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recommended_price__HTTPValidationError" } } } } } } }, "/v2/dstats/active_firms/search": { "post": { "parameters": [ { "description": "Использовать демо-режим", "in": "query", "name": "demo", "schema": { "default": false, "type": "boolean" }, "x-nullable": false } ], "responses": { "200": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/ActiveFirmsViewOfActiveFirmsResultViewV2" } } }, "description": "Активные перевозчики", "x-nullable": false }, "400": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/vandamus_v2__FinalExceptionView" } } }, "description": "Ошибка в запросе", "x-nullable": false }, "403": { "content": { "*/*": { "schema": { "$ref": "#/components/schemas/vandamus_v2__FinalExceptionView" } } }, "description": "У вас нет доступа к данному API", "x-nullable": false } }, "security": [ { "JWT": [] } ], "tags": [ "API активных перевозчиков" ], "operationId": "ActiveFirms_SearchActiveTruckers", "requestBody": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/ActiveTruckersWithActualGeoDto" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ActiveTruckersWithActualGeoDto" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/ActiveTruckersWithActualGeoDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActiveTruckersWithActualGeoDto" } } }, "description": "Параметры запроса" }, "summary": "Получение активных перевозчиков по заданным параметрам" } }, "/priceline/license/v2/all_directions": { "get": { "tags": [ "License" ], "summary": "Возвращает список всех доступных направлений и доступные типы кузова для направления", "operationId": "get_all_directions_license_license_v2_all_directions_get", "parameters": [ { "name": "demo", "in": "query", "required": false, "schema": { "type": "boolean", "description": "При значении true возвращаются демонстрационные данные", "default": false, "title": "Demo" }, "description": "При значении true возвращаются демонстрационные данные", "example": false } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllDirectionsResponseLicenseV2" } } } }, "422": { "description": "Ошибка валидации параметров запроса", "content": { "application/json": { "example": { "error": "Тип поданного параметра отличается от ожидаемого - неверное значение", "reason": "location: , ('body', 'CarType'); type: value_error", "details": {} }, "schema": { "$ref": "#/components/schemas/priceline_api__ErrorFormatResponse" } } } } } } }, "/priceline/license/v1/all_directions": { "get": { "tags": [ "License" ], "summary": "Возвращает список всех доступных направлений и доступные типы кузова для направления", "operationId": "get_all_directions_license_license_v1_all_directions_get", "parameters": [ { "name": "demo", "in": "query", "required": false, "schema": { "type": "boolean", "description": "При значении true возвращаются демонстрационные данные", "default": false, "title": "Demo" }, "description": "При значении true возвращаются демонстрационные данные", "example": false } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AllDirectionsResponseLicenseV1" } } } }, "422": { "description": "Ошибка валидации параметров запроса", "content": { "application/json": { "example": { "error": "Тип поданного параметра отличается от ожидаемого - неверное значение", "reason": "location: , ('body', 'CarType'); type: value_error", "details": {} }, "schema": { "$ref": "#/components/schemas/priceline_api__ErrorFormatResponse" } } } } } } }, "/priceline/license/v1/average_prices": { "post": { "tags": [ "License" ], "summary": "Метод получения средних цен", "operationId": "average_prices_license_v1_average_prices_post", "parameters": [ { "name": "demo", "in": "query", "required": false, "schema": { "type": "boolean", "description": "При значении true возвращаются демонстрационные данные", "default": false, "title": "Demo" }, "description": "При значении true возвращаются демонстрационные данные", "example": false } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestParams" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseParams" } } } }, "402": { "description": "Действие лицензии не покрывает текущий период", "content": { "application/json": { "example": { "error": "Access error", "reason": "Действие вашего доступа закончилось." }, "schema": { "$ref": "#/components/schemas/priceline_api__ErrorFormatResponse" } } } }, "403": { "description": "Нет доступа к API — требуется оплаченная лицензия", "content": { "application/json": { "example": { "error": "Access error", "reason": "Оплатите лицензию для получения доступа." }, "schema": { "$ref": "#/components/schemas/priceline_api__ErrorFormatResponse" } } } }, "404": { "description": "По запрошенным параметрам данные не найдены", "content": { "application/json": { "example": { "error": "PRICELINE_5_DIRECTION_NOT_FOUND", "reason": "По запрошенным параметрам данные не найдены", "details": { "From": { "RegionId": 153153 }, "To": { "RegionId": 153 } } }, "schema": { "$ref": "#/components/schemas/priceline_api__ErrorFormatResponse" } } } }, "422": { "description": "Ошибка валидации параметров запроса", "content": { "application/json": { "example": { "error": "Тип поданного параметра отличается от ожидаемого - неверное значение", "reason": "location: , ('body', 'CarType'); type: value_error", "details": {} }, "schema": { "$ref": "#/components/schemas/priceline_api__ErrorFormatResponse" } } } }, "429": { "description": "Превышен лимит запросов к API", "content": { "application/json": { "example": { "error": "Rate limit error", "reason": "Вы достигли лимита API-запросов за текущий месяц. Чтобы увеличить лимит — свяжитесь с отделом продаж: +7 812 602-01-15." }, "schema": { "$ref": "#/components/schemas/priceline_api__ErrorFormatResponse" } } } } } } }, "/priceline/license/v1/usage-statistics": { "get": { "tags": [ "License" ], "summary": "Возвращает количество запросов к сервису за текущий период", "operationId": "get_usage_statistics_license_v1_usage_statistics_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageStatisticsResponseSchema" } } } }, "402": { "description": "Действие лицензии не покрывает текущий период", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/priceline_api__ErrorFormatResponse" }, "example": { "error": "Access error", "reason": "Действие вашего доступа закончилось." } } } }, "403": { "description": "Нет доступа к API — требуется оплаченная лицензия", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/priceline_api__ErrorFormatResponse" }, "example": { "error": "Access error", "reason": "Оплатите лицензию для получения доступа." } } } } } } }, "/index/license/v1/index_by_direction": { "post": { "tags": [ "Внешнее АПИ" ], "summary": "Динамика индекса по направлению", "description": "Динамика индекса по направлению", "operationId": "index_by_direction_license_v1_index_by_direction_post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenseIndexByDirectionRequest" } } }, "required": true }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenseIndexByDirectionResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorFormatResponse" } } } }, "422": { "description": "Validation Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/index-by-directions__HTTPValidationError" } } } } } } }, "/index/license/v1/directions": { "get": { "tags": [ "Внешнее АПИ" ], "summary": "Доступные направления индекса", "description": "Доступные направления индекса", "operationId": "get_directions_license_v1_directions_get", "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenseDirectionsResponse" } } } } } } }, "/gw/cargo-counter-offers-api/integrator/v1/cargos/interception/{carrierViewId}/counter-offers": { "post": { "tags": [ "Встречные предложения" ], "summary": "Создание встречного предложения из перехвата грузов", "operationId": "CounterOffer_CreateFromInterception", "parameters": [ { "name": "carrierViewId", "in": "path", "required": true, "description": "Идентификатор карточки груза в сценарии перехвата", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody": { "x-name": "cargoCounterOfferDto", "description": "Данные встречного предложения", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CargoCounterOfferIntegratorDto" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CargoCounterOfferIntegratorView" } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Код ошибки", "example": "string" }, "reason": { "type": "string", "description": "Причина ошибки", "nullable": true, "example": "string" }, "details": { "type": "array", "description": "Детали ошибки", "nullable": true, "items": { "$ref": "#/components/schemas/ExceptionDetailView" } } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/v1.0/loads/new/interception/{carrierViewId}/responses": { "put": { "tags": [ "Отзывы на грузы (новая структура)" ], "summary": "Добавление либо редактирование отзыва на груз, найденный через перехват.", "description": "API для интеграции. Та же семантика, что и у отзыва по идентификатору груза, но груз адресуется идентификатором показа перевозчику.", "operationId": "NewLoadResponses_UpsertInterceptionResponsePUT", "parameters": [ { "name": "carrierViewId", "in": "path", "required": true, "description": "Идентификатор показа груза перевозчику.", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody": { "x-name": "response", "description": "Отзыв на груз.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CounterOfferUpsertDto" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "Сохранённый отзыв.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewLoadResponseViewStandart" } } } }, "400": { "description": "Тело запроса не разобрано или поля не прошли проверку.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValidationErrorView" } } } }, "403": { "description": "Фирме закрыт доступ к отзывам или груз ей не виден.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfAccessDeniedException" } } } }, "404": { "description": "Показ груза перевозчику или сам груз не найден.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfLoadNotFoundException" } } } } }, "security": [ { "Bearer": [] } ] } }, "/gw/cargo-counter-offers-api/integrator/v1/cargos/interception/{carrierViewId}/counter-offers/{cargoCounterOfferId}": { "put": { "tags": [ "Встречные предложения" ], "summary": "Обновление встречного предложения из перехвата грузов", "operationId": "CounterOffer_UpdateFromInterception", "parameters": [ { "name": "carrierViewId", "in": "path", "required": true, "description": "Идентификатор карточки груза в сценарии перехвата", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, { "name": "cargoCounterOfferId", "in": "path", "required": true, "description": "ID встречного предложения", "schema": { "type": "string", "format": "guid" }, "x-position": 2, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody": { "x-name": "cargoCounterOfferDto", "description": "Данные встречного предложения", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CargoCounterOfferIntegratorDto" } } }, "required": true, "x-position": 3 }, "responses": { "200": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CargoCounterOfferIntegratorView" } } } }, "4XX": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Код ошибки", "example": "string" }, "reason": { "type": "string", "description": "Причина ошибки", "nullable": true, "example": "string" }, "details": { "type": "array", "description": "Детали ошибки", "nullable": true, "items": { "$ref": "#/components/schemas/ExceptionDetailView" } } } } } } } }, "security": [ { "Bearer": [] } ] } }, "/v1.0/loads/new/interception/{carrierViewId}/responses/edit": { "post": { "tags": [ "Отзывы на грузы (новая структура)" ], "summary": "Добавление либо редактирование отзыва на груз, найденный через перехват.", "description": "API для интеграции. Та же семантика, что и у отзыва по идентификатору груза, но груз адресуется идентификатором показа перевозчику.", "operationId": "NewLoadResponses_UpsertInterceptionResponsePOST", "parameters": [ { "name": "carrierViewId", "in": "path", "required": true, "description": "Идентификатор показа груза перевозчику.", "schema": { "type": "string", "format": "guid" }, "x-position": 1, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ], "requestBody": { "x-name": "response", "description": "Отзыв на груз.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CounterOfferUpsertDto" } } }, "required": true, "x-position": 2 }, "responses": { "200": { "description": "Сохранённый отзыв.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewLoadResponseViewStandart" } } } }, "400": { "description": "Тело запроса не разобрано или поля не прошли проверку.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonValidationErrorView" } } } }, "403": { "description": "Фирме закрыт доступ к отзывам или груз ей не виден.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfAccessDeniedException" } } } }, "404": { "description": "Показ груза перевозчику или сам груз не найден.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinalExceptionModelOfLoadNotFoundException" } } } } }, "security": [ { "Bearer": [] } ] } }, "/webapi/bazaar/v1/price_prediction_api": { "post": { "tags": [ "price_prediction_api" ], "summary": "Ставки в похожих грузах - API", "description": "Предоставляет средние значения ставок участников ATI.SU для похожих грузов.\n Учитываются параметры груза: направление перевозки, тип груза и кузова, объём,\n вес, тип упаковки, количество мест и класс опасности, а также тип оплаты:\n с НДС, без НДС и наличными.\n\n Для отладки интеграции есть демо-режим: передайте `demo=true` в query-параметрах,\n и метод вернёт фиксированный тестовый ответ без обращения к модели предсказания.", "operationId": "price_prediction_api_v1_price_prediction_api_post", "parameters": [ { "name": "demo", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Демо-режим для отладки интеграции: при `true` метод\n возвращает фиксированный тестовый ответ без обращения к модели\n предсказания.", "example": true, "default": false, "title": "Demo" }, "description": "Демо-режим для отладки интеграции: при `true` метод\n возвращает фиксированный тестовый ответ без обращения к модели\n предсказания." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoadParamsApi" } } }, "description": "Параметры груза и маршрута для расчёта цены." }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PricePredictionResponseFormatRoot" } } } }, "403": { "description": "Нет прав на доступ к методу", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bazaar_api__ErrorFormatResponse" } } } }, "422": { "description": "Ошибка валидации параметров или город не найден", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/bazaar_api__ErrorFormatResponse" } } } } } } }, "/gw/gis-rm/v1/distance": { "post": { "tags": [ "Route" ], "summary": "Получение расстояния (платный)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDistanceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetDistanceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GetDistanceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DistanceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DistanceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DistanceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } } } } } } }, "/gw/oauth2/gis-rm/v1/distance": { "post": { "tags": [ "Route" ], "summary": "Получение расстояния (платный)", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDistanceRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetDistanceRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GetDistanceRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DistanceResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DistanceResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DistanceResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } } } } } } }, "/gw/gis-rm/v1/route-info": { "post": { "tags": [ "Route" ], "summary": "Получение маршрута (платный)", "parameters": [ { "name": "visual-route", "in": "query", "description": "В ответе надо вернуть координаты маршрута", "schema": { "type": "boolean" } }, { "name": "route-info", "in": "query", "description": "В ответе надо вернуть информацию о попутных трассах и населённых пунктах", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Параметры маршрута", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRouteInfoIntegratorRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetRouteInfoIntegratorRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GetRouteInfoIntegratorRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/gis-rm__RouteResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/gis-rm__RouteResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/gis-rm__RouteResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } } } } } } }, "/gw/oauth2/gis-rm/v1/route-info": { "post": { "tags": [ "Route" ], "summary": "Получение маршрута (платный)", "parameters": [ { "name": "visual-route", "in": "query", "description": "В ответе надо вернуть координаты маршрута", "schema": { "type": "boolean" } }, { "name": "route-info", "in": "query", "description": "В ответе надо вернуть информацию о попутных трассах и населённых пунктах", "schema": { "type": "boolean" } } ], "requestBody": { "description": "Параметры маршрута", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetRouteInfoIntegratorRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetRouteInfoIntegratorRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GetRouteInfoIntegratorRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/gis-rm__RouteResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/gis-rm__RouteResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/gis-rm__RouteResponse" } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } } } } } } }, "/gw/gis-rm/v1/nearest-cities/with-roads-distance": { "post": { "tags": [ "NearestCities" ], "summary": "Получение ближайших населённых пунктов с расстоянием по дорогам (платный)", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetNearestCitiesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetNearestCitiesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GetNearestCitiesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CityWithDistanceResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CityWithDistanceResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CityWithDistanceResponse" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } } } } } } }, "/gw/oauth2/gis-rm/v1/nearest-cities/with-roads-distance": { "post": { "tags": [ "NearestCities" ], "summary": "Получение ближайших населённых пунктов с расстоянием по дорогам (платный)", "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetNearestCitiesRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GetNearestCitiesRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/GetNearestCitiesRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CityWithDistanceResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CityWithDistanceResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CityWithDistanceResponse" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } } } } } } }, "/gw/gis-rm/v1/cities-in-radius": { "post": { "tags": [ "NearestCities" ], "summary": "Поиск в радиусе. Получение всех населённых пунктов, до которых можно доехать по дорогам, не превышая заданное расстояние (платный)", "requestBody": { "description": "GeoService.Models.Request.CitiesInRadiusRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CitiesInRadiusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CitiesInRadiusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CitiesInRadiusRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CityIdWithDistance" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CityIdWithDistance" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CityIdWithDistance" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } } } } } } }, "/gw/oauth2/gis-rm/v1/cities-in-radius": { "post": { "tags": [ "NearestCities" ], "summary": "Поиск в радиусе. Получение всех населённых пунктов, до которых можно доехать по дорогам, не превышая заданное расстояние (платный)", "requestBody": { "description": "GeoService.Models.Request.CitiesInRadiusRequest", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CitiesInRadiusRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CitiesInRadiusRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CitiesInRadiusRequest" } } } }, "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CityIdWithDistance" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CityIdWithDistance" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CityIdWithDistance" } } } } }, "400": { "description": "Bad Request", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } } } }, "403": { "description": "Forbidden", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } } } }, "429": { "description": "Too Many Requests", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SingleErrorResponse" } } } } } } }, "/v1.2/orders/{dealId}/inwork": { "post": { "tags": [ "Заказы" ], "summary": "Смена cтатуса перевозки Заказа", "description": "Позволяет установить статус перевозки для Заказа.\nТребуется DealState Заказа `4`.\nУстановить статус может как грузовладелец так и перевозчик.", "operationId": "Orders_SetInWorkStatus", "parameters": [ { "name": "dealId", "in": "path", "required": true, "description": "Id Заказа", "schema": { "type": "string", "format": "guid" }, "x-position": 1 } ], "requestBody": { "x-name": "dealInWork", "description": "Cтатус перевозки Заказа и его параметры", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DealInWorkDto2" } ] } } }, "x-position": 2 }, "responses": { "200": { "description": "Успешное изменение статуса", "content": { "application/json": { "schema": { "type": "boolean" } } } }, "4XX": { "description": "Ошибка запроса. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)", "content": { "application/json": { "schema": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinalExceptionModelOfFileAccessDeniedException" } ] } } } } }, "security": [ { "JWT": [] } ] } }, "/documents/{doc_id}/approve/": { "put": { "parameters": [ { "description": "Идентификатор документа", "in": "path", "name": "doc_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentUpdateResult" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/DocumentUpdateResult" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DocumentUpdateResult" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/DocumentUpdateResult" } } }, "description": "Результат запроса" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/doki__ErrorResponse" } }, "application/octet-stream": { "schema": { "$ref": "#/components/schemas/doki__ErrorResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/doki__ErrorResponse" } }, "text/plain": { "schema": { "$ref": "#/components/schemas/doki__ErrorResponse" } } }, "description": "Ошибка запроса, документ не может быть одобрен." } }, "tags": [ "Document", "Folder" ], "description": "После одобрения документ перемещается в папку \"Одобренные\".\nОдобрить можно только документ, ожидающий решения.\n", "summary": "Одобрить документ" } } }, "components": { "schemas": { "AuctionFinishAction": { "description": "Финальное действие после завершения аукциона\r\n* `1` — Опубликовать груз со ставкой\r\n* `2` — Опубликовать груз с запросом ставки\r\n* `3` — Удалить груз", "enum": [ 1, 2, 3 ], "format": "int32", "type": "integer" }, "AuctionFinishType": { "description": "Тип окончания аукциона\r\n\r\n* `0` - По времени\r\n* `1` - По минимальной ставке\r\n* `2` - Досрочное", "enum": [ 0, 1, 2 ], "format": "int32", "type": "integer" }, "AuctionOfLoadOwner": { "description": "Торги (аукцион) для грузовладельца", "properties": { "accept_second_pay_type": { "description": "Возможность принимать другой тип оплаты (с НДС или без НДС)", "example": true, "type": "boolean" }, "active_deal_id": { "description": "Id сделки, привязанной к Торгам (аукциону)", "format": "uuid", "type": "string" }, "auction_id": { "description": "Id Торгов (аукциона)", "example": "2fb965f2-85e9-4213-90e7-f396e47219e7", "format": "uuid", "type": "string" }, "auction_rates": { "description": "Список ставок по Торгам (аукциону)", "items": { "$ref": "#/components/schemas/AuctionRateOfLoadOwner" }, "type": "array" }, "auction_restart_parameters": { "$ref": "#/components/schemas/AuctionRestartParams" }, "auto_renew": { "description": "Автопродление Торгов (аукциона) при выставлении ставки в последние 5 минут до окончания Торгов (аукциона)", "example": false, "type": "boolean" }, "currency": { "description": "Валюта ставки на груз", "example": 1, "format": "int32", "type": "integer" }, "current_rate_with_nds": { "description": "Текущая ставка с НДС", "example": 25000, "format": "double", "type": "number" }, "current_rate_without_nds": { "description": "Текущая ставка без НДС", "example": 20000, "format": "double", "type": "number" }, "deleted": { "description": "Аукцион помечен удалённым - спустя некоторое время он автоматически удалится полностью", "example": true, "type": "boolean" }, "docs_expired_date": { "description": "Время окончания подачи документов (только для победителя)", "format": "date-time", "type": "string" }, "duration": { "description": "Длительность Торгов (аукциона) в минутах", "format": "int32", "type": "integer" }, "end_date": { "description": "Время окончания Торгов (аукциона)", "example": "2019-03-11T10:08:03.2530000+00:00", "format": "date-time", "type": "string" }, "end_date_boundary": { "description": "Время окончания Торгов (аукциона), после которого они автоматически завершаются, если нет автопродления", "example": "2019-05-21T15:15:10.8370000+00:00", "format": "date-time", "type": "string" }, "finish_type": { "$ref": "#/components/schemas/AuctionFinishType" }, "finished": { "description": "Завершены ли Торги (аукцион)", "example": true, "type": "boolean" }, "is_docs_expired": { "description": "Время подачи документов истекло (только для победителя)", "type": "boolean" }, "load_id": { "description": "Id груза, для которого активны Торги (аукцион)", "example": "2fb965f2-85e9-4213-90e7-f396e47219e7", "format": "uuid", "type": "string" }, "max_rate": { "description": "Максимально допустимая ставка по Торгам (аукциону) при автоповышении (RaiseBid = true)", "format": "double", "type": "number" }, "max_renew_time": { "description": "Максимально допустимое время, на которое сдвигается окончание Торгов (аукциона) при включённом AutoRenew (в минутах)", "format": "int32", "type": "integer" }, "nds": { "description": "Ставка НДС", "format": "double", "type": "number" }, "next_rate_with_nds": { "description": "Следующая возможная ставка с НДС", "format": "double", "type": "number" }, "next_rate_without_nds": { "description": "Следующая возможная ставка без НДС", "format": "double", "type": "number" }, "participants_count": { "description": "Количество участников", "example": 2, "format": "int32", "type": "integer" }, "raise_bid": { "description": "Автоповышение ставки на Шаг (step), если нет предложений", "type": "boolean" }, "raise_bid_interval": { "description": "Период увеличения ставки в минутах при автоповышении (RaiseBid = true)", "format": "int32", "type": "integer" }, "refuse_bet_prohibited": { "description": "Отмена ставки запрещена", "example": true, "type": "boolean" }, "renew_time": { "description": "Время, на которое сдвигается окончание Торгов (аукциона) при включённом AutoRenew (в минутах)", "example": 3, "format": "int32", "type": "integer" }, "response_in_minutes": { "description": "Количество минут с момента начала Торгов (аукциона) (StartDate), после которых возможно принимать встречные предложения", "format": "int32", "type": "integer" }, "response_prohibited": { "description": "Встречные предложения запрещены", "example": true, "type": "boolean" }, "server_date": { "description": "Серверное время. Для синхронизации Торгов (аукциона)", "example": "2019-06-04T18:24:45.7898742+00:00", "format": "date-time", "type": "string" }, "start_date": { "description": "Время начала Торгов (аукциона)", "example": "2019-03-11T10:05:03.7900000+00:00", "format": "date-time", "type": "string" }, "start_since_first_bet": { "description": "Длительность Торгов (аукциона) отсчитывается с момента первой ставки", "type": "boolean" }, "state": { "$ref": "#/components/schemas/AuctionState" }, "step": { "description": "Шаг изменения ставки Торгов (аукциона)", "example": 1000, "format": "double", "type": "number" }, "time_to_provide_documents": { "description": "Время на предоставление перевозчиком данных для заявки (в часах)", "format": "double", "type": "number" }, "win_date": { "description": "Время выигрыша ставки (только для победителя)", "format": "date-time", "type": "string" }, "winner_criterion": { "$ref": "#/components/schemas/WinnerCriteria" } }, "required": [ "auction_id", "auto_renew", "currency", "deleted", "finished", "load_id", "participants_count", "server_date", "start_date", "step" ], "type": "object" }, "AuctionOfTaker": { "description": "Торги (аукцион) для перевозчика", "properties": { "auction_id": { "description": "Id Торгов (аукциона)", "example": "2fb965f2-85e9-4213-90e7-f396e47219e7", "format": "uuid", "type": "string" }, "currency": { "description": "Валюта ставки на груз", "example": 1, "format": "int32", "type": "integer" }, "current_rate_with_nds": { "description": "Текущая ставка с НДС", "example": 25000, "format": "double", "type": "number" }, "current_rate_without_nds": { "description": "Текущая ставка без НДС", "example": 20000, "format": "double", "type": "number" }, "end_date": { "description": "Время окончания Торгов (аукциона)", "example": "2019-03-11T10:08:03.2530000+00:00", "format": "date-time", "type": "string" }, "finished": { "description": "Завершены ли Торги (аукцион)", "example": true, "type": "boolean" }, "is_our_rate_best": { "description": "Ставка лучшая в незавершенных Торгах (аукционе) (в завершенных - не отображается)", "type": "boolean" }, "load_id": { "description": "Id груза, для которого активны Торги (аукцион)", "example": "2fb965f2-85e9-4213-90e7-f396e47219e7", "format": "uuid", "type": "string" }, "next_rate_with_nds": { "description": "Следующая возможная ставка с НДС", "format": "double", "type": "number" }, "next_rate_without_nds": { "description": "Следующая возможная ставка без НДС", "format": "double", "type": "number" }, "our_rate": { "$ref": "#/components/schemas/AuctionRateOfTaker" }, "participants_count": { "description": "Количество участников", "example": 2, "format": "int32", "type": "integer" }, "refuse_bet_prohibited": { "description": "Отмена ставки запрещена", "example": true, "type": "boolean" }, "response_prohibited": { "description": "Встречные предложения запрещены", "example": true, "type": "boolean" }, "server_date": { "description": "Серверное время. Для синхронизации Торгов (аукциона)", "example": "2019-06-04T18:24:45.7898742+00:00", "format": "date-time", "type": "string" }, "start_date": { "description": "Время начала Торгов (аукциона)", "example": "2019-03-11T10:05:03.7900000+00:00", "format": "date-time", "type": "string" }, "winner_criterion": { "$ref": "#/components/schemas/WinnerCriteria" } }, "required": [ "auction_id", "currency", "finished", "load_id", "participants_count", "server_date", "start_date" ], "type": "object" }, "AuctionOfTakerWinner": { "description": "Торги (аукцион) для победителя", "properties": { "active_deal_id": { "description": "Id сделки, привязанной к Торгам (аукциону)", "format": "uuid", "type": "string" }, "auction_id": { "description": "Id Торгов (аукциона)", "example": "2fb965f2-85e9-4213-90e7-f396e47219e7", "format": "uuid", "type": "string" }, "currency": { "description": "Валюта ставки на груз", "example": 1, "format": "int32", "type": "integer" }, "current_rate_with_nds": { "description": "Текущая ставка с НДС", "example": 25000, "format": "double", "type": "number" }, "current_rate_without_nds": { "description": "Текущая ставка без НДС", "example": 20000, "format": "double", "type": "number" }, "docs_expired_date": { "description": "Время окончания подачи документов (только для победителя)", "format": "date-time", "type": "string" }, "end_date": { "description": "Время окончания Торгов (аукциона)", "example": "2019-03-11T10:08:03.2530000+00:00", "format": "date-time", "type": "string" }, "finished": { "description": "Завершены ли Торги (аукцион)", "example": true, "type": "boolean" }, "is_docs_expired": { "description": "Время подачи документов истекло (только для победителя)", "type": "boolean" }, "load_id": { "description": "Id груза, для которого активны Торги (аукцион)", "example": "2fb965f2-85e9-4213-90e7-f396e47219e7", "format": "uuid", "type": "string" }, "our_rate": { "$ref": "#/components/schemas/AuctionRateOfTaker" }, "participants_count": { "description": "Количество участников", "example": 2, "format": "int32", "type": "integer" }, "refuse_bet_prohibited": { "description": "Отмена ставки запрещена", "example": true, "type": "boolean" }, "response_prohibited": { "description": "Встречные предложения запрещены", "example": true, "type": "boolean" }, "server_date": { "description": "Серверное время. Для синхронизации Торгов (аукциона)", "example": "2019-06-04T18:24:45.7898742+00:00", "format": "date-time", "type": "string" }, "start_date": { "description": "Время начала Торгов (аукциона)", "example": "2019-03-11T10:05:03.7900000+00:00", "format": "date-time", "type": "string" }, "time_to_provide_documents": { "description": "Время на предоставление перевозчиком данных для заявки (в часах)", "format": "double", "type": "number" }, "win_date": { "description": "Время выигрыша ставки (только для победителя)", "format": "date-time", "type": "string" }, "winner_criterion": { "$ref": "#/components/schemas/WinnerCriteria" } }, "required": [ "auction_id", "currency", "finished", "load_id", "participants_count", "server_date", "start_date" ], "type": "object" }, "AuctionPaymentType": { "description": "Тип оплаты\r\n* `1` - Наличка\r\n* `22` - Любая\r\n* `23` - На карту\r\n* `24` - С НДС\r\n* `25` - Без НДС\r\n* Остальные зарезервированы", "enum": [ 1, 22, 23, 24, 25 ], "format": "int32", "type": "integer" }, "AuctionRateBetStatus": { "description": "Статус выставленной ставки\r\n\r\n* `0` - Ставка выставлена\r\n* `1` - Ставка выставлена и Торги (аукцион) завершены\r\n* `2` - Ставка не выставлена, поскольку Торги (аукцион) не найдены\r\n* `3` - Ставка не выставлена, поскольку она не лучшая\r\n* `4` - Ставка выставлена минимальная, но Торги (аукцион) не завершены\r\n* `5` - Ставка выставлена и Торги (аукцион) продлены\r\n* `6` - Ставка не выставлена, поскольку торги завершены", "enum": [ 0, 1, 2, 3, 4, 5, 6 ], "format": "int32", "type": "integer" }, "AuctionRateOfLoadOwner": { "description": "Для вывода грузовладельцу ставки в списке", "properties": { "added_at": { "description": "Дата добавления", "format": "date-time", "type": "string" }, "ati_id": { "description": "Фирма, поставившая ставку", "type": "string" }, "auction_rate_id": { "description": "Id ставки", "format": "uuid", "type": "string" }, "contact_id": { "description": "Контакт", "format": "int32", "type": "integer" }, "loading_date": { "description": "Ближайшая возможная для перевозчика дата загрузки. Используется только в Торгах с критерием победы по ставке и дате загрузки", "format": "date-time", "type": "string" }, "rate_with_nds": { "description": "Ставка c НДС на груз, выставленная перевозчиком", "format": "double", "type": "number" }, "rate_without_nds": { "description": "Ставка без НДС на груз, выставленная перевозчиком", "format": "double", "type": "number" }, "source": { "$ref": "#/components/schemas/RateSource" }, "state": { "$ref": "#/components/schemas/AuctionRateState" } }, "required": [ "added_at", "ati_id", "auction_rate_id", "contact_id", "state" ], "type": "object" }, "AuctionRateOfTaker": { "description": "Выставленная ставка", "properties": { "added_at": { "description": "Дата добавления", "format": "date-time", "type": "string" }, "auction_rate_id": { "description": "Id ставки", "format": "uuid", "type": "string" }, "contact_id": { "description": "Контакт", "format": "int32", "type": "integer" }, "loading_date": { "description": "Ближайшая возможная для перевозчика дата загрузки. Используется только в Торгах с критерием победы по ставке и дате загрузки", "format": "date-time", "type": "string" }, "rate_with_nds": { "description": "Ставка c НДС на груз, выставленная перевозчиком", "format": "double", "type": "number" }, "rate_without_nds": { "description": "Ставка без НДС на груз, выставленная перевозчиком", "format": "double", "type": "number" }, "state": { "$ref": "#/components/schemas/AuctionRateState" } }, "required": [ "added_at", "auction_rate_id", "contact_id", "state" ], "type": "object" }, "AuctionRateOfTakerDto": { "description": "Для внесения ставки грузоперевозчиком", "properties": { "auction_id": { "description": "Id аукциона", "format": "uuid", "type": "string" }, "loading_date": { "description": "Ближайшая возможная для перевозчика дата загрузки. Используется только в Торгах с критерием победы по ставке и дате загрузки", "format": "date-time", "type": "string" }, "payment_type": { "$ref": "#/components/schemas/AuctionPaymentType" }, "rate": { "description": "Ставка на груз, поставленная перевозчиком", "format": "double", "type": "number" } }, "required": [ "auction_id", "payment_type", "rate" ], "type": "object" }, "AuctionRateRefusingResult": { "description": "Результат отмены ставки аукциона\r\n\r\n* `-1` - Случилось что-то непонятное, но ставка не удалилась\r\n* `0` - Cтавка удалена\r\n* `1` - Ставка не найдена\r\n* `2` - Время на отмену ставки прошло\r\n* `3` - Аукцион не найден\r\n* `4` - Аукцион завершен\r\n* `5` - Ставка удалена уже есть другие ставки", "enum": [ 0, 1, 2, 3, 4, 5, -1 ], "format": "int32", "type": "integer" }, "AuctionRateState": { "description": "Статус ставки\r\n\r\n* `-8` - Грузоотправитель отклонил документ\r\n* `-7` - Победитель отклонил документ\r\n* `-6` - Победитель отменил сделку\r\n* `-5` - Грузовладелец отменил сделку\r\n* `-4` - Победитель отказался, теперь его нельзя выбрать больше в качестве победителя\r\n* `-3` - Бывший победитель\r\n* `-2` - Перевозчик отказался от участия\r\n* `0` - Непобедная ставка при завершении Торгов (аукциона)\r\n* `1` - Победная ставка", "enum": [ 0, 1, -8, -7, -6, -5, -4, -3, -2 ], "format": "int32", "type": "integer" }, "AuctionRateStatusOfTaker": { "description": "Статус ставки после выставления", "properties": { "auction": { "$ref": "#/components/schemas/AuctionOfTaker" }, "auction_end_date": { "description": "Параметр устарел, используйте auction.end_date. Дата окончания Торгов (аукциона).", "example": "2019-03-11T10:08:03.2530000+00:00", "format": "date-time", "type": "string" }, "result_status": { "$ref": "#/components/schemas/AuctionRateBetStatus" } }, "type": "object" }, "AuctionRestartParams": { "description": "Параметры перезапуска торгов", "properties": { "auction_finish_action": { "$ref": "#/components/schemas/AuctionFinishAction" }, "current_change_winner_count": { "description": "Оставшееся количество попыток выбора нового победителя", "format": "int32", "type": "integer" }, "current_restart_count": { "description": "Оставшееся количество попыток перезапуска торгов", "format": "int32", "type": "integer" }, "duration_after_restart": { "description": "Длительность торгов в минутах после перезапуска", "format": "int32", "type": "integer" }, "init_change_winner_count": { "description": "Начальное количество попыток выбора нового победителя", "format": "int32", "type": "integer" }, "init_restart_count": { "description": "Начальное количество попыток перезапуска торгов", "format": "int32", "type": "integer" }, "is_manually_restarted": { "description": "Параметр, показывающий, был ли последний перезапуск выбран вручную", "type": "boolean" }, "rate_increase": { "description": "Повышение ставки при перезапуске", "format": "double", "type": "number" }, "rate_increase_option": { "$ref": "#/components/schemas/RateIncreaseOption" } }, "type": "object" }, "AuctionState": { "description": "Статус аукциона\r\n\r\n* `-100` - Не удалось определить состояние аукциона\r\n* `-14` - Аукцион отменён вручную грузовладельцем\r\n* `-13` - Аукцион удалён, т.к. расторгнут заказ\r\n* `-12` - Аукцион без ставок завершён\r\n* `-11` - Аукцион удалён автоматически\r\n* `-10` - Аукцион удалён т.к. сделка завершена\r\n* `-9` - Аукцион удалён\r\n* `-8` - При включённом копировании грузов: ожидается действие от экспедитора в случае, когда заказ с победителем отменён, других участников нет\r\n* `-7` - При включённом копировании грузов: ожидается действие с торгами от экспедитора в случае, когда заказ с победителем отменён и есть потенциальный победитель\r\n* `-6` - При включённом копировании грузов: торги завершены, экспедитор не является победителем\r\n* `-5` - Одна ставка лучшая по цене, другая по дате\r\n* `-4` - Закончился, но победитель вовремя не взял груз и при этом есть еще возможные победители\r\n* `-3` - Закончился, но победитель вовремя не взял груз и при этом он единственный возможный победитель\r\n* `-2` - Закончился, ждем когда победитель возьмёт груз\r\n* `-1` - Закончился, ставок нет\r\n* `0` - Идет, ставок нет\r\n* `1` - Идёт (уже есть валидные ставки)", "enum": [ 0, 1, -100, -14, -13, -12, -11, -10, -9, -8, -7, -6, -5, -4, -3, -2, -1 ], "format": "int32", "type": "integer" }, "RateIncreaseOption": { "description": "Способ повышения ставки\r\n* `1` — Повышение ставки в валюте\r\n* `2` — Повышение ставки в процентах", "enum": [ 1, 2 ], "format": "int32", "type": "integer" }, "RateSource": { "description": "Система, на стороне которой сделана ставка", "enum": [ 0, 1 ], "format": "int32", "type": "integer" }, "WinnerCriteria": { "description": "Критерий победы в аукционе\r\n\r\n* `0` - Выбор победителя происходит автоматически по лучшей ставке\r\n* `1` - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную", "enum": [ 0, 1 ], "format": "int32", "type": "integer" }, "ErrorResponse": { "type": "object", "properties": { "error": { "type": "string", "description": "Код ошибки", "nullable": true, "example": "invalid_input_data" }, "reason": { "type": "string", "description": "Описание ошибки", "nullable": true, "example": "Неверные входные данные." } }, "additionalProperties": false, "description": "Стандартный ответ с описанием ошибки" }, "BoardExchangeDirection": { "description": "Направление обмена информацией на площадке (влияет на права доступа участников по умолчанию)\n \n* `exchange` — Обмен грузами/машинами\n* `input` — Грузы/машины для владельца площадки\n* `output` - Грузы/машины от владельца площадки\n \n - `0` — Информация от участников к владельцу\n \n - `1` — Информация от владельца к участникам\n \n - `2` — Обмен между всеми участниками\n ", "enum": [ "0", "1", "2" ], "type": "string", "x-enumNames": [ "Input", "Output", "Exchange" ] }, "BoardRequirementsDto": { "description": "Запрос на создание/изменение требований к площадке;\nдля использования в составе BoardSaveDto", "properties": { "requirement_document_types": { "description": "Список документов, требуемых к загрузке участниками площадки", "items": { "$ref": "#/components/schemas/RequirementDocumentTypeDto" }, "type": "array" }, "rules": { "description": "Правила площадки (можно использовать html-тэги \"b\", \"i\", \"span\", \"u\", \"ul\", \"li\", \"br\")", "type": "string" } }, "type": "object" }, "BoardType": { "description": "Тип содержимого на площадке\n* `loads` - Площадка с грузами\n* `trucks` - Площадка с машинами (зарезервировано, в данный момент такая возможность ещё не доступна)\n \n - `0` — Грузы\n \n - `1` — Машины\n ", "enum": [ "0", "1" ], "type": "string", "x-enumNames": [ "Loads", "Trucks" ] }, "ErrorModel": { "properties": { "error": { "description": "Код ошибки", "type": "string" }, "reason": { "description": "Текст ошибки", "type": "string" } }, "type": "object" }, "ExceptionResult": { "description": "Возвращаемое значение в случае ошибок\n ", "properties": { "Code": { "description": "В некоторых случаях (валидация) - ID ошибки, например ApplicationAlreadyCreated в случае \"вы уже подали заявку на\nэту площадку\"\n ", "type": "string" }, "Message": { "description": "Человекочитаемый текст ошибки\n ", "type": "string" } }, "type": "object" }, "ExtendedIntegratorBoardDigestView": { "allOf": [ { "$ref": "#/components/schemas/IntegratorBoardDigestView" }, { "properties": { "auctions_count": { "description": "Количество содержимого (грузов) с аукционами на площадке\nПример: `5`\n ", "format": "int32", "type": "integer" }, "can_add": { "description": "Есть ли право добавлять грузы\nПример: `false`\n ", "type": "boolean" }, "can_view": { "description": "Есть ли право просматривать грузы\nПример: `true`\n ", "type": "boolean" }, "content_count": { "description": "Количество грузов или машин на площадке\nПример: `34`\n ", "format": "int64", "type": "integer" }, "participants_count": { "description": "Количество участников площадки\nПример: `15`\n ", "format": "int64", "type": "integer" }, "tenders_count": { "description": "Количество тендеров на площадке\nПример: `2`\n ", "format": "int32", "type": "integer" } }, "required": [ "can_view", "can_add" ], "type": "object" } ] }, "IntegratorBoardCreateDto": { "properties": { "all_departments_allowed": { "description": "Площадка доступна всем подразделениям компании. Такую площадку могут видеть все сотрудники, независимо от их подразделения\nЕсли передано true, то DepartmentsIds должен быть null или пустым\nПример: true\n ", "type": "boolean" }, "board_exchange_direction": { "allOf": [ { "$ref": "#/components/schemas/BoardExchangeDirection" } ], "description": "Направление обмена информацией на площадке (влияет на права доступа участников по умолчанию)\n* `exchange` — Обмен грузами/машинами\n* `input` — Грузы/машины для владельца площадки\n* `output` - Грузы/машины от владельца площадки\n " }, "board_requirements": { "allOf": [ { "$ref": "#/components/schemas/BoardRequirementsDto" } ], "description": "Опциональный список требований к площадке.\nПоддерживаемые требования:\n - требуемые от участников файлы и сканы RequirementDocumentTypeDto\nПример: `\n[{\n \"type_id\": null,\n \"type_name\": \"Сертификат партнера нашей компании\",\n \"is_requirable\": true\n}]\n`\n " }, "board_type": { "allOf": [ { "$ref": "#/components/schemas/BoardType" } ], "description": "Тип площадки\n* `loads` - Площадка с грузами\n* `trucks` - Площадка с машинами (зарезервировано, в данный момент такая возможность ещё не доступна)\n " }, "color": { "description": "Цвет плашки площадки\nПример: `\"#d8cfd0\"`\n ", "type": "string" }, "departments_ids": { "description": "Перечень подразделений компании, которым доступна площадка.\nВ случае, если передан не пустой перечень значение AllDepartmentsAllowed должно быть false.\nОтветственный контакт ResponsibleContactId должен состоять (принадлежать) хотя бы одному из указанных подразделений\nПример: `[100302, 100303]`\n ", "items": { "format": "int32", "type": "integer" }, "type": "array" }, "description": { "description": "Описание площадки (можно использовать тэги \"b\", \"i\", \"span\", \"u\", \"ul\", \"li\", \"br\")\nПример: `\"Лучшая площадка из всех созданных\"`\n ", "type": "string" }, "name_for_users": { "description": "Публичное имя, видимое участникам площадки (до 50 символов)\nПример: `\"Приходите, покупайте\"`\n ", "type": "string" }, "private_name": { "description": "Имя, которое видит только владелец площадки (до 50 символов)\nПример: `\"Покупайте, приходите\"`\n ", "type": "string" }, "public": { "description": "Открытая площадка или закрытая. На открытую может подать заявку на вступление любой пользователь. На закрытую можно\nпопасть только по приглашению владельца.\nПример: `true`\n ", "type": "boolean" }, "responsible_contact_id": { "description": "ID контакта ответственного пользователя\nПример: `1`\n ", "format": "int32", "type": "integer" }, "subscribe_to_notifications": { "description": "Подписывать на уведомления новых участников.\nПример: `true`\n ", "type": "boolean" } }, "required": [ "board_exchange_direction", "board_type", "public", "all_departments_allowed" ], "type": "object" }, "IntegratorBoardDigestView": { "properties": { "all_departments_allowed": { "description": "Площадка доступна всем подразделениям компании. Такую площадку могут видеть все сотрудники, независимо от их подразделения\nПример: true\n ", "type": "boolean" }, "available_for_contact": { "description": "Площадка доступна для данного контакта\nПример: `true`\n ", "type": "boolean" }, "board_exchange_direction": { "allOf": [ { "$ref": "#/components/schemas/BoardExchangeDirection" } ], "description": "Направление обмена информацией на площадке (влияет на права доступа участников по умолчанию)\n* `exchange` — Обмен грузами/машинами\n* `input` — Грузы/машины для владельца площадки\n* `output` - Грузы/машины от владельца площадки\n " }, "board_type": { "allOf": [ { "$ref": "#/components/schemas/BoardType" } ], "description": "Тип площадки\n* `loads` - Площадка с грузами\n* `trucks` - Площадка с машинами (зарезервировано, в данный момент такая возможность ещё не доступна)\n " }, "color": { "description": "Цвет площадки\nПример: `\"#d8cfd0\"`\n ", "type": "string" }, "created_on": { "description": "Время создания площадки (timestamp)\nПример: `1556201954901`\n ", "format": "date-time", "type": "string" }, "departments_ids": { "description": "Перечень подразделений компании, которым доступна площадка\nПример: `[100302, 100303]`\n ", "items": { "format": "int32", "type": "integer" }, "type": "array" }, "id": { "description": "ID площадки (строка 24 символа)\nПример: `\"507f1f77bcf86cd799439011\"`\n ", "type": "string" }, "name": { "description": "Название площадки\nПример: `\"Образцово-показательная площадка\"`\n ", "type": "string" }, "owner_ati_id": { "description": "Код участника АТИ создавшего площадку\nПример: `\"1111111\"`\n ", "type": "string" }, "owner_firm": { "description": "Код участника АТИ создавшего площадку\nПример: `1111111`\n ", "format": "int32", "type": "integer" }, "updated_on": { "description": "Последнее время изменения площадки (Timestamp)\nПример: `1556201954901`\n ", "format": "date-time", "type": "string" }, "view_only_own": { "description": "Участник может видеть только свои грузы/машины\nПример: `true`\n ", "type": "boolean" } }, "required": [ "created_on", "view_only_own", "updated_on", "board_type", "board_exchange_direction", "owner_firm", "available_for_contact", "all_departments_allowed" ], "type": "object" }, "IntegratorInviteFirmDto": { "properties": { "ati_id": { "description": "код участника в АТИ\n ", "type": "string" }, "board_id": { "description": "ID площадки\n ", "type": "string" }, "contact_id": { "description": "ID контакта\n ", "format": "int32", "type": "integer" } }, "type": "object" }, "IntegratorInviteView": { "description": "Информация о приглашении на площадку\n ", "properties": { "board_info": { "allOf": [ { "$ref": "#/components/schemas/IntegratorBoardDigestView" } ], "description": "Информация о площадке, на которую создано приглашение\n " }, "participant": { "allOf": [ { "$ref": "#/components/schemas/IntegratorParticipantDigestView" } ], "description": "Параметры участия на площадке\n " } }, "type": "object" }, "IntegratorParticipantDigestView": { "description": "Детали участия пользователя на площадке\n ", "properties": { "ati_id": { "description": "код в АТИ участника\n ", "type": "string" }, "board_id": { "description": "ID площадки\n ", "type": "string" }, "can_add": { "description": "Может ли добавлять грузы/машины на площадку\n ", "type": "boolean" }, "created_on": { "description": "Дата вступления (приглашения) на площадку\n ", "format": "date-time", "type": "string" }, "responsible_contact_id": { "description": "ID контакта, ответственного за площадку\n ", "format": "int32", "type": "integer" }, "sender_ati_id": { "description": "код в АТИ пригласившего (владельца площадки)\n ", "type": "string" }, "type": { "allOf": [ { "$ref": "#/components/schemas/ParticipationType" } ], "description": "Тип участия\n " }, "type_changed": { "description": "Время последней смены типа участия\n ", "format": "date-time", "type": "string" }, "view_content": { "description": "Может ли видеть грузы/машины площадки\n ", "type": "boolean" }, "view_participants": { "description": "Может ли видеть других участников площадки\n ", "type": "boolean" } }, "required": [ "created_on", "type", "type_changed" ], "type": "object" }, "IntegratorParticipantModifyDto": { "properties": { "ati_id": { "description": "ID участника ATI\n ", "type": "string" }, "board_id": { "description": "ID площадки\n ", "type": "string" }, "can_add": { "description": "Может ли добавлять грузы/машины на площадку\n ", "type": "boolean" }, "type": { "allOf": [ { "$ref": "#/components/schemas/ParticipationType" } ], "description": "Тип участия на площадке\n \n* `user` - Полноценный участник площадки\n* `revoked` - Приглашение отозвано\n* `rejected` - Отказ от приглашения\n* `invited` - Участник приглашён на площадку\n* `invitedViewed` - Приглашение просмотрено\n* `rejectedViewed` - Отказ просмотрен\n* `left` - Участник покинул площадку\n* `deleted` - Участник удалён с площадки\n* `firmDeleted` - Участник удалён из АТИ\n* `owner` - Владелец площадки \n " }, "view_content": { "description": "Может ли видеть грузы/машины площадки\n ", "type": "boolean" }, "view_participants": { "description": "Может ли видеть других участников площадки\n ", "type": "boolean" } }, "type": "object" }, "IntegratorParticipantsListDto": { "properties": { "board_ids": { "description": "Отфильтровать по площадкам\n ", "items": { "type": "string" }, "type": "array" }, "limit": { "description": "Ограничение количества для постраничных запросов\n ", "format": "int32", "type": "integer" }, "offset": { "description": "Отступ для постраничных запросов\n ", "format": "int32", "type": "integer" }, "only_my": { "description": "Показывать только свои участия\n ", "type": "boolean" }, "type": { "allOf": [ { "$ref": "#/components/schemas/ParticipationType" } ], "description": "Отфильтровать по типу участия\n \n* `user` - Полноценный участник площадки\n* `revoked` - Приглашение отозвано\n* `rejected` - Отказ от приглашения\n* `invited` - Участник приглашён на площадку\n* `invitedViewed` - Приглашение просмотрено\n* `rejectedViewed` - Отказ просмотрен\n* `left` - Участник покинул площадку\n* `deleted` - Участник удалён с площадки\n* `firmDeleted` - Участник удалён из АТИ\n* `owner` - Владелец площадки \n " } }, "required": [ "only_my" ], "type": "object" }, "IntegratorSearchResultsViewOfIntegratorParticipantDigestView": { "description": "Страница с результатами поиска\n ", "properties": { "result": { "description": "Массив результатов\n ", "items": { "$ref": "#/components/schemas/IntegratorParticipantDigestView" }, "type": "array" }, "total_count": { "description": "Всего результатов, количество\n ", "format": "int64", "type": "integer" } }, "required": [ "total_count" ], "type": "object" }, "ParticipationType": { "description": "Тип участия пользователя на площадке\n\n* `1` - участник\n* `8192` - владелец\n - `1` — Полноценный участник площадки\n \n - `2`\n - `4` — Приглашение отозвано\n \n - `8`\n - `16`\n - `32` — Отказ от приглашения\n \n - `64`\n - `128` — Участник приглашён на площадку\n \n - `256` — Приглашение просмотрено\n \n - `512` — Отказ просмотрен\n \n - `1024` — Участник покинул площадку\n \n - `2048` — Участник удалён с площадки\n \n - `4096` — Участник удалён из АТИ\n \n - `8192` — Владелец площадки\n ", "enum": [ "1", "2", "4", "8", "16", "32", "64", "128", "256", "512", "1024", "2048", "4096", "8192" ], "type": "string", "x-enumFlags": true, "x-enumNames": [ "User", "TempRevoked", "Revoked", "TempDeleted", "TempRejected", "Rejected", "RevokedViewed", "Invited", "InvitedViewed", "RejectedViewed", "Left", "Deleted", "FirmDeleted", "Owner" ] }, "RequirementDocumentTypeDto": { "description": "Запрос на создание/изменение типа требуемого файла в площадке;\nдля использования в составе BoardRequirementsDto", "properties": { "base_type_id": { "allOf": [ { "$ref": "#/components/schemas/RequirementDocumentTypeId" } ], "description": "RequirementDocumentTypeId" }, "custom_type_name": { "description": "Пользовательское имя типа документа, только для пользовательских типов\n ", "type": "string" }, "is_requirable": { "description": "Данный тип файла обязателен к предоставлению", "type": "boolean" } }, "required": [ "is_requirable" ], "type": "object" }, "RequirementDocumentTypeId": { "description": "Id базового типа документа\n\n* `1` - Свидетельство о постановке на налоговый учет (ИНН)\n* `2` - Свидетельство о регистрации юрлица или ИП\n* `3` - Учредительные документы\n* `4` - Реквизиты\n* `5` - Прайс-лист\n* `6` - Коммерческое предложение\n - `1` — Свидетельство о постановке на налоговый учет (ИНН)\n - `2` — Свидетельство о регистрации юрлица или ИП\n - `3` — Учредительные документы\n - `4` — Реквизиты\n - `5` — Прайс-лист\n - `6` — Коммерческое предложение", "enum": [ "1", "2", "3", "4", "5", "6" ], "type": "string", "x-enumNames": [ "Inn", "RegistrationCertificate", "ConstituentDocuments", "Requisites", "PriceList", "CommercialOffer" ] }, "SingleErrorModel": { "allOf": [ { "$ref": "#/components/schemas/ErrorModel" }, { "properties": { "details": { "additionalProperties": {}, "description": "Детали ошибки при валидации запроса.\nПоле может отсутствовать в ответе, если для данного типа ошибки оно не предусмотрено", "type": "object" }, "errors_list": { "description": "Список ошибок.\nПоле может отсутствовать в ответе, если для данного типа ошибки оно не предусмотрено", "items": { "type": "string" }, "type": "array" } }, "type": "object" } ] }, "FinalExceptionView": { "type": "object", "additionalProperties": false, "properties": { "error_code": { "type": "string", "description": "Код ошибки" }, "reason": { "type": "string", "description": "Причина ошибки" } } }, "PhoneOwnerType": { "type": "integer", "description": "Тип сущности\n \n* `0` — Водитель\n* `1` — ТС", "x-enumNames": [ "Driver", "Truck" ], "enum": [ 0, 1 ] }, "PhoneBindingStatus": { "type": "integer", "description": "Статус привязки\n \n* `0` - Эксклюзивный доступ\n* `1` - Запрос на эксклюзивный доступ\n* `2` - Запрос отклонен владельцем номера телефона\n* `3` - Фирма \"уволила\" владельца номера\n* `4` - Владелец номера \"уволился\"\n* `5` - Запрос удален", "x-enumNames": [ "Employee", "Request", "Reject", "Fired", "Retired", "Deleted" ], "enum": [ 0, 1, 2, 3, 4, 5 ] }, "ScanType": { "type": "integer", "description": "Тип документа\n \n* `1` — Скан водительского удостоверения\n* `2` — Скан гражданского паспорта", "x-enumNames": [ "DriverLicense", "Passport" ], "enum": [ 1, 2 ] }, "DriversTrucksRelationDto": { "type": "object", "description": "Информация о связях", "additionalProperties": false, "properties": { "truck_id": { "type": "string", "description": "Id грузовика", "format": "guid", "nullable": true, "example": "75fdfa06-287b-47ff-a6e7-1d9edfa5ac29" }, "tractor_id": { "type": "string", "description": "Id тягача", "format": "guid", "nullable": true, "example": "75fdfa06-287b-47ff-a6e7-1d9edfa5ac29" }, "trailer_id": { "type": "string", "description": "Id прицепа", "format": "guid", "nullable": true, "example": "75fdfa06-287b-47ff-a6e7-1d9edfa5ac29" }, "semitrailer_id": { "type": "string", "description": "Id полуприцепа", "format": "guid", "nullable": true, "example": "75fdfa06-287b-47ff-a6e7-1d9edfa5ac29" }, "driver_ids": { "type": "array", "description": "Список Id водителей", "example": [ "c063e1c5-a58f-4f6b-b805-62d0715f4fba" ], "items": { "type": "string", "format": "guid" } } } }, "TruckBrandView": { "type": "object", "description": "Информация о модели ТС в Справочниках", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Id брэнда ТС", "format": "int32" }, "name": { "type": "string", "description": "Название брэнда ТС" }, "name_eng": { "type": "string", "description": "Английское название брэнда ТС" } } }, "TruckModelView": { "type": "object", "description": "Информация о модели ТС в Справочниках", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Id модели ТС", "format": "int32" }, "brand": { "description": "Брэнд ТС", "oneOf": [ { "$ref": "#/components/schemas/TruckBrandView" } ] }, "model": { "type": "string", "description": "Модель ТС" }, "kind": { "description": "Тип транспортного средства\n \n* `1` — Грузовик\n* `2` — Тягач\n* `4` — Полуприцеп\n* `8` — Прицеп", "oneOf": [ { "$ref": "#/components/schemas/TruckKinds" } ] } } }, "TruckKinds": { "type": "integer", "description": "Тип транспортного средства\n \n* `1` — Грузовик\n* `2` — Тягач\n* `4` — Полуприцеп\n* `8` — Прицеп", "x-enumNames": [ "Truck", "Tractor", "Semitrailer", "Trailer" ], "enum": [ 1, 2, 4, 8 ] }, "TruckOwnershipType": { "type": "integer", "description": "Тип владения ТС\n \n* `0` - Собственное\n* `1` - Привлеченное\n* `2` - Аренда\n* `3` - Лизинг\n* `4` - Совместная собственность супругов\n* `5` - Безвозмездное пользование", "x-enumNames": [ "Own", "Attracted", "Rent", "Leasing", "SpousesJointOwnership", "GratuitousUse" ], "enum": [ 0, 1, 2, 3, 4, 5 ] }, "ScanType2": { "type": "integer", "description": "Тип документа\n \n* `3` — Скан ПТС\n* `4` — Скан пластикового ПТС\n* `6` — Скан договора аренеды\n* `7` — Скан свидетельства о браке\n* `8` — Скан договора безвозмездного пользования", "x-enumNames": [ "TechPassport", "PlasticTechPassport", "RentContract", "Marriage", "GratuitousContract" ], "enum": [ 3, 4, 6, 7, 8 ] }, "SensorHostView": { "type": "object", "description": "Информация о сервере поставщика устройства мониторинга транспорта", "additionalProperties": false, "properties": { "sensor_host_id": { "type": "integer", "description": "Идентификатор сервера", "format": "int32" }, "url": { "type": "string", "description": "Адрес сервера" } } }, "SensorHostDto": { "type": "object", "description": "Информация о сервере поставщика устройства мониторинга транспорта", "additionalProperties": false, "required": [ "url" ], "properties": { "sensor_host_id": { "type": "integer", "description": "Идентификатор сервера", "format": "int32" }, "url": { "type": "string", "description": "Адрес сервера", "minLength": 1 } } }, "DayOfWeek": { "type": "integer", "description": "", "x-enumNames": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "enum": [ 0, 1, 2, 3, 4, 5, 6 ] }, "AddressType": { "type": "integer", "description": "Тип адреса\n \n* `1` — Склад\n* `2` — Офис\n* `3` — Магазин", "x-enumNames": [ "Stock", "Office", "Store" ], "enum": [ 1, 2, 3 ] }, "SMSStatus": { "type": "integer", "description": "Статус отправки СМС\n \n* `0` - Нет информации\n* `1` - Создано\n* `2` - Ошибка\n* `3` - Отправлено\n* `4` - Доставлено", "x-enumNames": [ "Empty", "Created", "Error", "Sent", "Delivered" ], "enum": [ 0, 1, 2, 3, 4 ] }, "Residency": { "type": "integer", "description": "Резидентство\n \n* `1` — Россия\n* `2` — Украина\n* `3` — Беларусь\n* `10` — Казахстан\n* `200` — Международное (другое)", "x-enumNames": [ "Russia", "Ukraine", "Belarus", "Kazakhstan", "International" ], "enum": [ 1, 2, 3, 10, 200 ] }, "TimeslotsBindingStatus": { "type": "integer", "description": "", "x-enumNames": [ "AwaitReaction", "Accepted", "Revoked", "Rejected" ], "enum": [ 0, 1, 2, 3 ] }, "AddressView": { "type": "object", "description": "Адрес", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "ID адреса", "format": "guid" }, "address": { "type": "string", "description": "Адрес" }, "address_city_id": { "type": "integer", "description": "ID города.\nЗначение из [словаря](https://ati.su/developers/api/dictionaries/geo/)", "format": "int32" }, "address_latitude": { "type": "number", "description": "Координаты адреса: широта", "format": "double" }, "address_longitude": { "type": "number", "description": "Координаты адреса: долгота", "format": "double" }, "note": { "type": "string", "description": "Примечание" }, "contact_persons": { "type": "array", "description": "Контакты адреса", "items": { "$ref": "#/components/schemas/ContactPersonView" } }, "schedule_summary": { "type": "string", "description": "Текстовое описание времени работы" }, "address_type": { "$ref": "#/components/schemas/AddressType" } } }, "ContactPersonView": { "type": "object", "description": "Контактное лицо", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "ID контакного лица", "format": "guid" }, "name": { "type": "string", "description": "ФИО" }, "phone": { "type": "string", "description": "Телефон" }, "extra_phone": { "type": "integer", "description": "Добавочный номер", "format": "int32", "nullable": true }, "email": { "type": "string", "description": "Электронная почта" } } }, "RawAddressType": { "type": "object", "additionalProperties": false, "properties": { "id": { "$ref": "#/components/schemas/AddressType" }, "name": { "type": "string" }, "name_eng": { "type": "string" } } }, "AddressUpsertDto": { "type": "object", "additionalProperties": false, "properties": { "address": { "type": "string", "description": "Адрес", "nullable": true }, "address_city_id": { "type": "integer", "description": "ID города.\nЗначение из [словаря](https://ati.su/developers/api/dictionaries/geo/)", "format": "int32" }, "address_latitude": { "type": "number", "description": "Координаты адреса: широта", "format": "double", "nullable": true }, "address_longitude": { "type": "number", "description": "Координаты адреса: долгота", "format": "double", "nullable": true }, "note": { "type": "string", "description": "Примечание", "nullable": true }, "schedule_summary": { "type": "string", "description": "Текстовое описание времени работы", "nullable": true }, "address_type": { "$ref": "#/components/schemas/AddressType" }, "contact_person_ids": { "type": "array", "description": "ID контактных лиц", "items": { "type": "string", "format": "guid" } } } }, "ContactPersonSaveDto": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "ФИО", "nullable": true }, "phone": { "type": "string", "description": "Телефон", "nullable": true }, "extra_phone": { "type": "integer", "description": "Добавочный номер", "format": "int32", "nullable": true }, "email": { "type": "string", "description": "Электронная почта", "nullable": true } } }, "DriverView4": { "type": "object", "additionalProperties": false, "properties": { "driver_id": { "type": "string", "description": "Id водителя", "format": "guid", "example": "c063e1c5-a58f-4f6b-b805-62d0715f4fba" }, "first_name": { "type": "string", "description": "Имя", "example": "Иван" }, "second_name": { "type": "string", "description": "Фамилия", "example": "Иванов" }, "patronymic": { "type": "string", "description": "Отчество", "example": "Иванович" }, "phone": { "description": "Информация о номерe телефона водителя", "oneOf": [ { "$ref": "#/components/schemas/PhoneView2" } ] }, "driver_license_number": { "type": "string", "description": "Номер водительского удостоверения", "example": "77 77 123456" }, "driver_license_when_issued": { "type": "string", "description": "Когда выдано водительское удостоверение", "format": "date-time", "nullable": true }, "passport_series": { "type": "string", "description": "Серия паспорта", "example": "4010" }, "passport_number": { "type": "string", "description": "Номер паспорта", "example": "123456" }, "passport_issued_by": { "type": "string", "description": "Кем выдан", "example": "УФМС России" }, "passport_when_issued": { "type": "string", "description": "Когда выдан", "format": "date-time", "example": "2018-01-01" }, "registration": { "type": "string", "description": "Прописка", "example": "гор. Санкт-Петербург" }, "is_attracted_driver": { "type": "boolean", "description": "Флаг привлеченного водителя (со стороны)" }, "related_id": { "type": "string", "description": "Идентификатор связанного ТС, которое пользователь задал в кабинете", "format": "guid", "nullable": true, "example": "75fdfa06-287b-47ff-a6e7-1d9edfa5ac29" }, "last_deal_related_id": { "type": "string", "description": "Идентификатор ТС, с которым был связан водитель во время выполнения последней сделки", "format": "guid", "nullable": true, "example": "75fdfa06-287b-47ff-a6e7-1d9edfa5ac29" }, "description": { "type": "string", "description": "Краткое описание водителя", "example": "Иванов Иван Иванович" }, "attracted_from": { "type": "string", "description": "Фирма от которой привлечен водитель.", "example": "ООО Название фирмы" }, "scans": { "type": "array", "description": "Сканы документов водителя", "items": { "$ref": "#/components/schemas/ScanViewOfScanType7" } }, "date_of_birth": { "type": "string", "description": "Дата рождения", "format": "date-time", "nullable": true }, "department_code_in_passport": { "type": "string", "description": "Код подразделения" }, "driver_inn": { "type": "string", "description": "ИНН водителя" }, "in_cargo_owner_black_list": { "type": "boolean", "description": "Есть в Черном списке у запрашиваемого грузовладельца" }, "external_id": { "type": "string", "description": "Идентификатор" } } }, "PhoneView2": { "type": "object", "additionalProperties": false, "properties": { "phone": { "type": "number", "description": "Номер телефона", "format": "decimal" }, "phone_string": { "type": "string", "description": "Номер телефона, как указан пользователем " }, "presence": { "description": "Статус приложения АТИ Водитель", "oneOf": [ { "$ref": "#/components/schemas/TrackerPresenceView2" } ] }, "binding": { "description": "Информация об актуальной привязке", "oneOf": [ { "$ref": "#/components/schemas/PhoneBindingView2" } ] }, "binding_type": { "description": "Тип привязки (Эксклюзивности) номера телефона\n \n* `0` - Номер не привязан\n* `1` - Номер привязан к водителю текущей фирмы\n* `2` - Номер привязан к ТС текущей фирмы\n* `3` - Номер привязан к водителю другой фирмы\n* `4` - Номер привязан к ТС другой фирмы", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PhoneBindingType" } ] } } }, "TrackerPresenceView2": { "type": "object", "additionalProperties": false, "properties": { "phone": { "type": "number", "description": "Номер телефона, приведенный к числовому формату", "format": "decimal" }, "initial_phone": { "type": "string", "description": "Номер телефона в том виде, в котором его указал пользователь " }, "last_active": { "type": "string", "description": "Время последней активности в приложении", "format": "date-time", "nullable": true }, "has_tracker": { "type": "boolean", "description": "Авторизация в приложении", "nullable": true }, "sms_invite_status": { "description": "Статус приглашения в приложение", "oneOf": [ { "$ref": "#/components/schemas/SmsInviteStatusView2" } ] } } }, "SmsInviteStatusView2": { "type": "object", "additionalProperties": false, "properties": { "invite_sent": { "type": "boolean", "description": "Было ли отправлено приглашение" }, "contact_name": { "type": "string", "description": "Имя пригласившего контакта" }, "firm_id": { "type": "integer", "description": "Id пригласившей фирмы", "format": "int32", "nullable": true }, "contact_id": { "type": "integer", "description": "Id пригласившего контакт", "format": "int32", "nullable": true }, "sms_status": { "description": "Статус отправки СМС\n \n* `0` - Нет информации\n* `1` - Создано\n* `2` - Ошибка\n* `3` - Отправлено\n* `4` - Доставлено", "oneOf": [ { "$ref": "#/components/schemas/SMSStatus" } ] }, "when": { "type": "string", "description": "Время отправки SMS", "format": "date-time", "nullable": true } } }, "PhoneBindingView2": { "type": "object", "description": "Информация о привязке (Эксклюзивности) номера телефона ", "additionalProperties": false, "properties": { "status": { "description": "Статус привязки\n \n* `0` - Эксклюзивный доступ\n* `1` - Запрос на эксклюзивный доступ\n* `2` - Запрос отклонен владельцем номера телефона\n* `3` - Фирма \"уволила\" владельца номера\n* `4` - Владелец номера \"уволился\"\n* `5` - Запрос удален", "oneOf": [ { "$ref": "#/components/schemas/PhoneBindingStatus" } ] }, "account_id": { "type": "string", "description": "Фирма, запрашивающая \"Эксклюзивный доступ\"" }, "firm_name": { "type": "string", "description": "Название фирмы, запрашивающей \"Эксклюзивный доступ\"" }, "owner_type": { "description": "Тип сущности, к которой привязан телефон\n \n* `0` — Водитель\n* `1` — ТС", "oneOf": [ { "$ref": "#/components/schemas/PhoneOwnerType" } ] } } }, "PhoneBindingType": { "type": "integer", "description": "Тип привязки (Эксклюзивности) номера телефона\n \n* `0` - Номер не привязан\n* `1` - Номер привязан к водителю текущей фирмы\n* `2` - Номер привязан к ТС текущей фирмы\n* `3` - Номер привязан к водителю другой фирмы\n* `4` - Номер привязан к ТС другой фирмы", "x-enumNames": [ "None", "Driver", "Truck", "AnotherFirmDriver", "AnotherFirmTruck" ], "enum": [ 0, 1, 2, 3, 4 ] }, "ScanViewOfScanType7": { "type": "object", "additionalProperties": false, "properties": { "scan_id": { "type": "string", "description": "Id скана", "format": "guid", "example": "1bb60c95-957b-473f-b664-4026533fa5a9" }, "scan_owner_id": { "type": "string", "format": "guid" }, "scan_file_id": { "type": "string" }, "scan_path": { "type": "string", "description": "Адрес расположения файла скана в хранилище", "example": "https://d.ati.su/api/next/filestorage/cf91cb04-80a1-4b97-8ea2-2f0ad3a4d579" }, "scan_name": { "type": "string", "description": "Имя файла скана", "example": "ВУ.pdf" }, "scan_type": { "$ref": "#/components/schemas/ScanType" } } }, "DriverDto2": { "type": "object", "description": "Данные водителя", "additionalProperties": false, "properties": { "first_name": { "type": "string", "description": "Имя", "example": "Иван" }, "second_name": { "type": "string", "description": "Фамилия", "example": "Иванов" }, "patronymic": { "type": "string", "description": "Отчество", "example": "Иванович" }, "phone_number": { "type": "string", "description": "Номер телефона", "example": "+7(910)333-33-33" }, "driver_license_number": { "type": "string", "description": "Номер водительского удостоверения", "example": "77 77 123456" }, "driver_license_when_issued": { "type": "string", "description": "Когда выдано водительское удостоверение", "format": "date-time", "nullable": true, "example": "2018-01-01" }, "passport_series": { "type": "string", "description": "Серия паспорта", "example": "4010" }, "passport_number": { "type": "string", "description": "Номер паспорта", "example": "123456" }, "passport_issued_by": { "type": "string", "description": "Кем выдан паспорт", "example": "УФМС России" }, "passport_when_issued": { "type": "string", "description": "Когда выдан паспорт", "format": "date-time", "example": "2018-01-01" }, "registration": { "type": "string", "description": "Адрес регистрации", "example": "гор. Санкт-Петербург" }, "is_attracted_driver": { "type": "boolean", "description": "Флаг привлеченного водителя" }, "attracted_from": { "type": "string", "description": "Фирма, от которой привлечен водитель", "example": "ООО Название фирмы" }, "date_of_birth": { "type": "string", "description": "Дата рождения", "format": "date-time", "nullable": true, "example": "1985-01-01" }, "department_code_in_passport": { "type": "string", "description": "Код подразделения" }, "driver_inn": { "type": "string", "description": "ИНН водителя" }, "external_id": { "type": "string", "description": "Идентификатор" } } }, "OrganizationView": { "type": "object", "description": "Организация", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "ID организации", "format": "guid" }, "name": { "type": "string", "description": "Название" }, "ownership": { "type": "integer", "description": "Организационно-правовая форма собственности.\nЗначение из [словаря](https://ati.su/developers/api/dictionaries/firms/#get-v1.0-dictionaries-ownerships)", "format": "int32" }, "residency": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Residency" } ] }, "inn": { "type": "string", "description": "Регистрационный номер (ИНН, ЕДРПОУ, УНП, БИН или их аналоги)", "nullable": true }, "phone": { "type": "string", "description": "Номер телефона организации", "nullable": true }, "extra_phone": { "type": "integer", "description": "Добавочный номер", "format": "int32", "nullable": true }, "docs_address": { "description": "Адрес местонахождения для документов", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganizationDocsAddressView2" } ] }, "addresses": { "type": "array", "description": "Адреса", "items": { "$ref": "#/components/schemas/AddressView" } }, "contact_persons": { "type": "array", "description": "Контакты организации", "items": { "$ref": "#/components/schemas/ContactPersonView" } }, "all_departments_allowed": { "type": "boolean", "description": "Организация доступна всем подразделениям" }, "department_ids": { "type": "array", "description": "Подразделения, которым доступна организация", "items": { "type": "integer", "format": "int32" } } } }, "OrganizationDocsAddressView2": { "type": "object", "description": "Адрес местонахождения для документов", "additionalProperties": false, "properties": { "postcode": { "type": "string", "description": "Почтовый индекс", "nullable": true }, "city_id": { "type": "integer", "description": "Id населенного пункта\\\nЗначение из [словаря](https://ati.su/developers/api/dictionaries/geo/)", "format": "int32", "nullable": true }, "street_name": { "type": "string", "description": "Улица, проспект, переулок, бульвар и пр.", "nullable": true }, "house_no": { "type": "string", "description": "Дом, строение, корпус, литера", "nullable": true }, "office_no": { "type": "string", "description": "Офис, помещение и пр.", "nullable": true } } }, "FilterOrganizationsDto": { "type": "object", "additionalProperties": false, "properties": { "departments": { "type": "array", "description": "Список подразделений, по которым необходимо отфильтровать организации", "items": { "type": "integer", "format": "int32" } } } }, "OrganizationEditDto": { "allOf": [ { "$ref": "#/components/schemas/OrganizationDto" }, { "type": "object", "additionalProperties": false, "properties": { "address_ids": { "type": "array", "description": "Адреса организации, id", "nullable": true, "items": { "type": "string", "format": "guid" } }, "contact_person_ids": { "type": "array", "description": "Контактные лица организации, id", "nullable": true, "items": { "type": "string", "format": "guid" } } } } ] }, "OrganizationDto": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "Название", "nullable": true }, "ownership": { "type": "integer", "description": "Организационно-правовая форма собственности.\nЗначение из [словаря](https://ati.su/developers/api/dictionaries/firms/#get-v1.0-dictionaries-ownerships)", "format": "int32" }, "all_departments_allowed": { "type": "boolean", "description": "Организация доступна всем подразделениям?\nЕсли нет, то в параметре department_ids необходимо указать, каким подразделениям доступна " }, "department_ids": { "type": "array", "description": "Подразделения, которым доступна организация", "nullable": true, "items": { "type": "integer", "format": "int32" } }, "residency": { "$ref": "#/components/schemas/Residency" }, "inn": { "type": "string", "description": "Регистрационный номер (ИНН, ЕДРПОУ, УНП, БИН или их аналоги).\nИспользуйте номер в соответствии со своим резидентством", "nullable": true }, "phone": { "type": "string", "description": "Номер телефона организации", "nullable": true }, "extra_phone": { "type": "integer", "description": "Добавочный номер", "format": "int32", "nullable": true }, "docs_address": { "description": "Адрес местонахождения для документов", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganizationDocsAddressDto" } ] } } }, "OrganizationDocsAddressDto": { "type": "object", "description": "Адрес местонахождения для документов", "additionalProperties": false, "properties": { "postcode": { "type": "string", "description": "Почтовый индекс" }, "city_id": { "type": "integer", "description": "Id населенного пункта\\\nЗначение из [словаря](https://ati.su/developers/api/dictionaries/geo/)", "format": "int32" }, "street_name": { "type": "string", "description": "Улица, проспект, переулок, бульвар и пр." }, "house_no": { "type": "string", "description": "Дом, строение, корпус, литера" }, "office_no": { "type": "string", "description": "Офис, помещение и пр." } } }, "ContainerDimensionView": { "type": "object", "description": "Информация о размерности контейнера ТС в Справочниках", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "Название размерности" } } }, "TruckView4": { "type": "object", "additionalProperties": false, "properties": { "truck_info_id": { "type": "string", "description": "Id транспортного средства", "format": "guid" }, "related_id": { "type": "string", "description": "Id связанного транспортного средства", "format": "guid", "nullable": true }, "is_attracted_truck": { "type": "boolean", "description": "Привлеченное ТС. Устарело, используйте ownership_type", "deprecated": true }, "ownership_type": { "description": "Тип владения ТС\n \n* `0` - Собственное\n* `1` - Привлеченное\n* `2` - Аренда\n* `3` - Лизинг\n* `4` - Совместная собственность супругов\n* `5` - Безвозмездное пользование", "oneOf": [ { "$ref": "#/components/schemas/TruckOwnershipType" } ] }, "type": { "description": "Тип транспортного средства\n \n* `1` — Грузовик\n* `2` — Тягач\n* `4` — Полуприцеп\n* `8` — Прицеп", "oneOf": [ { "$ref": "#/components/schemas/TruckKinds" } ] }, "car_type_id": { "type": "integer", "description": "Тип кузова\\\nЗначение из [словаря кузовов АТИ](https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-carTypes)", "format": "int32" }, "description": { "type": "string", "description": "Короткое описание" }, "brand_id": { "type": "integer", "description": "Марка\\\nЗначение из [словаря](https://ati.su/developers/api/dictionaries/catalogs/#get-v1.2-catalogs-dictionaries-truckbrands)", "format": "int32", "nullable": true }, "model": { "type": "string", "description": "Модель\\\nЗначение из [словаря](https://ati.su/developers/api/dictionaries/catalogs/#get-v1.2-catalogs-dictionaries-truckmodels)" }, "number": { "type": "string", "description": "Госномер" }, "capacity": { "type": "number", "description": "Грузоподъемность", "format": "decimal", "nullable": true }, "volume": { "type": "number", "description": "Объем", "format": "decimal", "nullable": true }, "length": { "type": "number", "description": "Длина", "format": "decimal", "nullable": true }, "width": { "type": "number", "description": "Ширина", "format": "decimal", "nullable": true }, "height": { "type": "number", "description": "Высота", "format": "decimal", "nullable": true }, "last_deal_related_id": { "type": "string", "description": "Id связанного во время последней сделки транспортного средства", "format": "guid", "nullable": true }, "manufacture_year": { "type": "integer", "description": "Год выпуска", "format": "int32", "nullable": true }, "hidden_in_firm_info": { "type": "boolean", "description": "Не отображать в карточке фирмы" }, "vin": { "type": "string", "description": "VIN" }, "vrc": { "type": "string", "description": "СТС" }, "body_number": { "type": "string", "description": "Номер кузова" }, "dimension": { "type": "integer", "description": "Размерность контейнера\\\nЗначение из [словаря](https://ati.su/developers/api/dictionaries/catalogs/#get-v1.2-catalogs-dictionaries-container_dimensions)", "format": "int32", "nullable": true }, "truck_passport_number": { "type": "string", "description": "Номер ПТС" }, "can_refrigerator": { "type": "boolean", "description": "Способность возить реф-контейнеры", "nullable": true }, "has_gen_set": { "type": "boolean", "description": "Есть GenSet", "nullable": true }, "truck_owner_name": { "type": "string", "description": "Имя владельца по СТС" }, "can_carry_heavy_container": { "type": "boolean", "description": "Способность перевозить тяжелые контейнеры\n ", "nullable": true }, "can_carry_tall_container": { "type": "boolean", "description": "Способность перевозить высокие контейнеры", "nullable": true }, "external_id": { "type": "string", "description": "Идентификатор" }, "scans": { "type": "array", "description": "Сканы документов ТС", "items": { "$ref": "#/components/schemas/ScanViewOfScanType8" } }, "photos": { "type": "array", "description": "Фото ТС", "items": { "$ref": "#/components/schemas/TruckPhotoView4" } }, "sensors": { "type": "array", "description": "Датчики мониторинга транспорта", "items": { "$ref": "#/components/schemas/SensorView3" } } } }, "ScanViewOfScanType8": { "type": "object", "additionalProperties": false, "properties": { "scan_id": { "type": "string", "description": "Id скана", "format": "guid", "example": "1bb60c95-957b-473f-b664-4026533fa5a9" }, "scan_owner_id": { "type": "string", "format": "guid" }, "scan_file_id": { "type": "string" }, "scan_path": { "type": "string", "description": "Адрес расположения файла скана в хранилище", "example": "https://d.ati.su/api/next/filestorage/cf91cb04-80a1-4b97-8ea2-2f0ad3a4d579" }, "scan_name": { "type": "string", "description": "Имя файла скана", "example": "ВУ.pdf" }, "scan_type": { "$ref": "#/components/schemas/ScanType2" } } }, "TruckPhotoView4": { "type": "object", "description": "Фото ТС", "additionalProperties": false, "properties": { "owner_id": { "type": "string", "format": "guid" }, "id": { "type": "string", "description": "Id фото", "format": "guid" }, "file_id": { "type": "string" }, "path": { "type": "string", "description": "Адрес расположения файла в хранилище" }, "name": { "type": "string", "description": "Имя файла" } } }, "SensorView3": { "type": "object", "description": "Датчик мониторинга транспортного средства", "additionalProperties": false, "properties": { "sensor_id": { "type": "integer", "description": "Идентификатор датчика", "format": "int32" }, "sensor_name": { "type": "string", "description": "Наименование датчика" }, "provider_id": { "type": "integer", "description": "Идентификатор поставщика датчиков мониторинга транспорта", "format": "int32" }, "provider_sensor_id": { "type": "string", "description": "Идентификатор датчика из внешней системы мониторинга" }, "is_active": { "type": "boolean", "description": "Статус активности датчика" }, "unactivate_date": { "type": "string", "description": "Дата окончания действия датчика", "format": "date-time", "nullable": true }, "host": { "description": "Информация о сервере поставщика устройства мониторинга транспорта", "oneOf": [ { "$ref": "#/components/schemas/SensorHostView" } ] } } }, "TruckDto2": { "type": "object", "additionalProperties": false, "properties": { "type": { "$ref": "#/components/schemas/TruckKinds" }, "car_type_id": { "type": "integer", "description": "Тип кузова\\\nЗначение из [словаря кузовов АТИ](https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-carTypes)", "format": "int32" }, "brand_id": { "type": "integer", "description": "Марка\\\nЗначение из [словаря](https://ati.su/developers/api/dictionaries/catalogs/#get-v1.2-catalogs-dictionaries-truckbrands)", "format": "int32", "nullable": true }, "model": { "type": "string", "description": "Модель\\\nЗначение из [словаря](https://ati.su/developers/api/dictionaries/catalogs/#get-v1.2-catalogs-dictionaries-truckmodels)" }, "number": { "type": "string", "description": "Госномер" }, "manufacture_year": { "type": "integer", "description": "Год выпуска", "format": "int32", "nullable": true }, "ownership_type": { "description": "Тип владения ТС.\\\n \n* `0` - Собственное\n* `1` - Привлеченное\n* `2` - Аренда\n* `3` - Лизинг\n* `4` - Совместная собственность супругов\n* `5` - Безвозмездное пользование", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TruckOwnershipType" } ] }, "phone_number": { "type": "string", "description": "Номер телефона" }, "bind_phone": { "type": "boolean", "description": "Эксклюзивный доступ к приложению Ати-Водитель", "nullable": true }, "capacity": { "type": "number", "description": "Грузоподъемность", "format": "decimal", "nullable": true }, "volume": { "type": "number", "description": "Объем", "format": "decimal", "nullable": true }, "length": { "type": "number", "description": "Длина", "format": "decimal", "nullable": true }, "width": { "type": "number", "description": "Ширина", "format": "decimal", "nullable": true }, "height": { "type": "number", "description": "Высота", "format": "decimal", "nullable": true }, "hidden_in_firm_info": { "type": "boolean", "description": "Не отображать в карточке фирмы." }, "vin": { "type": "string", "description": "VIN" }, "vrc": { "type": "string", "description": "СТС" }, "body_number": { "type": "string", "description": "Номер кузова" }, "can_refrigerator": { "type": "boolean", "description": "Способность возить реф-контейнеры", "nullable": true }, "has_gen_set": { "type": "boolean", "description": "Есть GenSet", "nullable": true }, "dimension": { "type": "integer", "description": "Размерность контейнера\\\nЗначение из [словаря](https://ati.su/developers/api/dictionaries/catalogs/#get-v1.2-catalogs-dictionaries-container_dimensions)", "format": "int32", "nullable": true }, "truck_owner_name": { "type": "string", "description": "Имя владельца по СТС" }, "can_carry_heavy_container": { "type": "boolean", "description": "Способность перевозить тяжелые контейнеры\n ", "nullable": true }, "can_carry_tall_container": { "type": "boolean", "description": "Способность перевозить высокие контейнеры", "nullable": true }, "truck_passport_number": { "type": "string", "description": "Номер ПТС" }, "external_id": { "type": "string", "description": "Идентификатор" }, "sensors": { "type": "array", "description": "Датчики мониторинга", "items": { "$ref": "#/components/schemas/SensorDto2" } } } }, "SensorDto2": { "type": "object", "description": "Датчик мониторинга транспортного средства", "additionalProperties": false, "required": [ "sensor_name", "provider_id", "host" ], "properties": { "sensor_id": { "type": "integer", "description": "Идентификатор датчика", "format": "int32" }, "sensor_name": { "type": "string", "description": "Наименование датчика", "minLength": 1 }, "provider_id": { "type": "integer", "description": "Идентификатор поставщика датчиков мониторинга транспорта", "format": "int32" }, "provider_sensor_id": { "type": "string", "description": "Идентификатор датчика из внешней системы мониторинга" }, "unactivate_date": { "type": "string", "description": "Дата окончания действия датчика", "format": "date-time", "nullable": true }, "host": { "description": "Информация о сервере поставщика устройства мониторинга транспорта", "oneOf": [ { "$ref": "#/components/schemas/SensorHostDto" } ] } } }, "scrolls__ErrorResponse": { "properties": { "error": { "type": "string" }, "reason": { "type": "string" } }, "type": "object" }, "FirmListElementPublicShort": { "properties": { "ati_id": { "description": "Идентификатор фирмы", "type": "string" }, "firm_name": { "description": "Название фирмы", "type": "string" }, "id": { "description": "Идентификатор элемента списка фирм", "format": "uuid", "type": "string" }, "list_id": { "description": "Идентификатор списка фирм", "format": "uuid", "type": "string" }, "owner_ati_id": { "description": "Идентификатор фирмы владельца списка", "type": "string" } }, "type": "object" }, "FirmListElementPublicBatchResultItem": { "properties": { "status": { "description": "Статус: \r\n0 - успешно; \r\n2 - у вас нет прав на редактирование этого персонального списка, владелец другой контакт вашей фирмы; \r\n4 - такой список не найден; \r\n6 - такой элемент уже есть в этом списке", "format": "int32", "type": "integer" }, "value": { "$ref": "#/components/schemas/FirmListElementPublicShort" } }, "type": "object" }, "FirmListElementPublicFirmListPublicBody": { "properties": { "ati_id": { "description": "Идентификатор фирмы", "type": "string" }, "contact_id": { "description": "Идентификатор контакта фирмы", "format": "int32", "type": "integer" }, "description": { "description": "Описание списка фирм", "type": "string" }, "emoji": { "description": "Эмодзи (html-entity)", "type": "string" }, "fixed": { "type": "boolean" }, "name": { "description": "Название списка фирм", "type": "string" }, "personal": { "description": "Персональный ли список фирм", "type": "boolean" }, "type": { "$ref": "#/components/schemas/FirmListType" } }, "type": "object" }, "FirmListElementPublicFirmListPublicShort": { "properties": { "ati_id": { "description": "Идентификатор фирмы", "type": "string" }, "contact_id": { "description": "Идентификатор контакта фирмы", "format": "int32", "type": "integer" }, "description": { "description": "Описание списка фирм", "type": "string" }, "elements": { "description": "Элементы списка", "items": { "$ref": "#/components/schemas/FirmListElementPublicShort" }, "type": "array" }, "emoji": { "description": "Эмодзи (html-entity)", "type": "string" }, "fixed": { "type": "boolean" }, "id": { "description": "Идентификатор списка фирм", "format": "uuid", "type": "string" }, "name": { "description": "Название списка фирм", "type": "string" }, "personal": { "description": "Персональный ли список фирм", "type": "boolean" }, "type": { "$ref": "#/components/schemas/FirmListType" } }, "type": "object" }, "FirmListType": { "description": "Тип списка фирм", "enum": [ 0, 1, 2 ], "format": "int32", "type": "integer" }, "GeoListElementPublic": { "properties": { "city_id": { "description": "Идентификатор города", "format": "int32", "type": "integer" }, "city_name": { "description": "Название города", "type": "string" }, "country_id": { "description": "Идентификатор страны", "format": "int32", "type": "integer" }, "country_name": { "description": "Название страны", "type": "string" }, "id": { "description": "Идентификатор элемента Гео списка", "format": "uuid", "type": "string" }, "list_id": { "description": "Идентификатор Гео списка", "format": "uuid", "type": "string" }, "owner_ati_id": { "type": "string" }, "region_id": { "description": "Идентификатор региона", "format": "int32", "type": "integer" }, "region_name": { "description": "Название региона", "type": "string" } }, "type": "object" }, "GeoListElementPublicBatchResultItem": { "properties": { "status": { "description": "Статус: \r\n0 - успешно; \r\n2 - у вас нет прав на редактирование этого персонального списка, владелец другой контакт вашей фирмы; \r\n4 - такой список не найден; \r\n6 - такой элемент уже есть в этом списке", "format": "int32", "type": "integer" }, "value": { "$ref": "#/components/schemas/GeoListElementPublic" } }, "type": "object" }, "GeoListElementPublicGeoListPublic": { "properties": { "ati_id": { "description": "Идентификатор фирмы", "type": "string" }, "contact_id": { "description": "Идентификатор контакта", "format": "int32", "type": "integer" }, "description": { "description": "Описание списка", "type": "string" }, "elements": { "description": "Элементы списка", "items": { "$ref": "#/components/schemas/GeoListElementPublic" }, "type": "array" }, "emoji": { "description": "Эмодзи (html-entity)", "type": "string" }, "fixed": { "type": "boolean" }, "id": { "description": "Идентификатор списка", "format": "uuid", "type": "string" }, "is_global": { "description": "Глобальный ли список", "type": "boolean" }, "name": { "description": "Название списка", "type": "string" }, "personal": { "description": "Персональный ли список", "type": "boolean" }, "type": { "description": "Тип списка", "format": "int32", "type": "integer" } }, "type": "object" }, "GuidBatchResultItem": { "properties": { "status": { "description": "Статус: \r\n0 - успешно; \r\n2 - у вас нет прав на редактирование этого персонального списка, владелец другой контакт вашей фирмы; \r\n4 - такой список не найден; \r\n6 - такой элемент уже есть в этом списке", "format": "int32", "type": "integer" }, "value": { "description": "Значение", "format": "uuid", "type": "string" } }, "type": "object" }, "AffiliatedFirmPublicAccountSummaryPublicFirmSummarySearchResultElement": { "type": "object", "properties": { "key": { "type": [ "null", "string" ], "description": "Ключ", "example": "string" }, "value": { "type": [ "null", "array" ], "items": { "description": "Публичная сводная информация по фирме.", "$ref": "#/components/schemas/AffiliatedFirmPublicAccountSummaryPublic" }, "description": "Значение", "example": [ { "ati_id": "string", "full_name": "string", "firm_type": "string", "firm_type_id": "string", "location": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" }, "address": "string", "position_in_city": 0, "position_in_country": 0, "firm_documents": [ { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } ], "web_site": "string", "info_reference": "string", "passport_reference": "string", "city": "string", "score": 0, "bad_partner_mentions_count": 0, "claims_count": 0, "recommendations_count": 0, "inn": "string", "ogrn": "string", "kpp": "string", "okpo": "string", "affiliated_firms": [ { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } ], "negative_points_sum": 0, "tf_firm_color": "string", "tf_account_color": "string", "tf_has_signals": false, "registration_date": "1970-01-01T00:00:00Z", "contact_info_changed": "1970-01-01T00:00:00Z", "last_month_active_days": 0, "verified_trucks": 0 } ] } }, "additionalProperties": false, "description": "Элемент результата поиска фирм по ключу.", "example": { "key": "string", "value": [ { "ati_id": "string", "full_name": "string", "firm_type": "string", "firm_type_id": "string", "location": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" }, "address": "string", "position_in_city": 0, "position_in_country": 0, "firm_documents": [ { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } ], "web_site": "string", "info_reference": "string", "passport_reference": "string", "city": "string", "score": 0, "bad_partner_mentions_count": 0, "claims_count": 0, "recommendations_count": 0, "inn": "string", "ogrn": "string", "kpp": "string", "okpo": "string", "affiliated_firms": [ { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } ], "negative_points_sum": 0, "tf_firm_color": "string", "tf_account_color": "string", "tf_has_signals": false, "registration_date": "1970-01-01T00:00:00Z", "contact_info_changed": "1970-01-01T00:00:00Z", "last_month_active_days": 0, "verified_trucks": 0 } ] } }, "sphinx-search-api__ErrorResponse": { "type": "object", "properties": { "error": { "type": [ "null", "string" ], "description": "Код ошибки", "example": "invalid_input_data" }, "reason": { "type": [ "null", "string" ], "description": "Описание ошибки", "example": "Неверные входные данные." } }, "additionalProperties": false, "description": "Стандартный ответ с описанием ошибки", "example": { "error": "invalid_input_data", "reason": "Неверные входные данные." } }, "SummaryWithContactsPublicFirmSummarySearchResultElement": { "type": "object", "properties": { "key": { "type": [ "null", "string" ], "description": "Ключ", "example": "string" }, "value": { "type": [ "null", "array" ], "items": { "description": "Краткая информация о фирме с данными по контактам.", "$ref": "#/components/schemas/SummaryWithContactsPublic" }, "description": "Значение", "example": [ { "contact_names": [ "string" ], "query_first_change_date": "1970-01-01T00:00:00Z", "ati_id": "string", "full_name": "string", "firm_type": "string", "firm_type_id": "string", "location": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" }, "address": "string", "position_in_city": 0, "position_in_country": 0, "firm_documents": [ { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } ], "web_site": "string", "info_reference": "string", "passport_reference": "string", "city": "string", "score": 0, "bad_partner_mentions_count": 0, "claims_count": 0, "recommendations_count": 0, "inn": "string", "ogrn": "string", "kpp": "string", "okpo": "string", "affiliated_firms": [ { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } ], "negative_points_sum": 0, "tf_firm_color": "string", "tf_account_color": "string", "tf_has_signals": false, "registration_date": "1970-01-01T00:00:00Z", "contact_info_changed": "1970-01-01T00:00:00Z", "last_month_active_days": 0, "verified_trucks": 0 } ] } }, "additionalProperties": false, "description": "Элемент результата поиска фирм по ключу.", "example": { "key": "string", "value": [ { "contact_names": [ "string" ], "query_first_change_date": "1970-01-01T00:00:00Z", "ati_id": "string", "full_name": "string", "firm_type": "string", "firm_type_id": "string", "location": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" }, "address": "string", "position_in_city": 0, "position_in_country": 0, "firm_documents": [ { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } ], "web_site": "string", "info_reference": "string", "passport_reference": "string", "city": "string", "score": 0, "bad_partner_mentions_count": 0, "claims_count": 0, "recommendations_count": 0, "inn": "string", "ogrn": "string", "kpp": "string", "okpo": "string", "affiliated_firms": [ { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } ], "negative_points_sum": 0, "tf_firm_color": "string", "tf_account_color": "string", "tf_has_signals": false, "registration_date": "1970-01-01T00:00:00Z", "contact_info_changed": "1970-01-01T00:00:00Z", "last_month_active_days": 0, "verified_trucks": 0 } ] } }, "SummaryWithContactsPublic": { "type": "object", "properties": { "contact_names": { "type": [ "null", "array" ], "items": { "type": "string" }, "description": "Имена контактов", "example": [ "string" ] }, "query_first_change_date": { "type": [ "null", "string" ], "description": "Даты первого добавления искомого параметра поиска (email, phone, inn)", "format": "date-time", "example": "1970-01-01T00:00:00Z" }, "ati_id": { "type": [ "null", "string" ], "description": "Код в АТИ.", "example": "string" }, "full_name": { "type": [ "null", "string" ], "description": "Полное имя фирмы: Брэнд (Название фирмы, ОПФ)", "example": "string" }, "firm_type": { "type": [ "null", "string" ], "description": "Профиль деятельности фирмы", "example": "string" }, "firm_type_id": { "type": [ "null", "string" ], "description": "Идентификатор профиля деятельности фирмы", "example": "string" }, "location": { "type": "null", "allOf": [ { "description": "Структура \"Город\"", "$ref": "#/components/schemas/City" } ], "description": "Информация о месторасположении фирмы", "example": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" } }, "address": { "type": [ "null", "string" ], "description": "Адрес фирмы", "example": "string" }, "position_in_city": { "type": [ "null", "integer" ], "description": "Место в рэйтинге по городу", "format": "int32", "example": 0 }, "position_in_country": { "type": [ "null", "integer" ], "description": "Место в рэйтинге по стране", "format": "int32", "example": 0 }, "firm_documents": { "type": [ "null", "array" ], "items": { "description": "Документ, связанный с фирмой.", "$ref": "#/components/schemas/FirmDocument" }, "description": "Документы фирмы", "example": [ { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } ] }, "web_site": { "type": [ "null", "string" ], "description": "Сайт фирмы", "example": "string" }, "info_reference": { "type": [ "null", "string" ], "description": "Ссылка на карточку фирмы", "example": "string" }, "passport_reference": { "type": [ "null", "string" ], "description": "Ссылка на паспорт фирмы", "example": "string" }, "city": { "type": [ "null", "string" ], "description": "Город, в котором расположена фирма", "example": "string" }, "score": { "type": "number", "description": "Количество звезд фирмы. Если число отрицательно, то это красные звезды", "format": "double", "example": 0 }, "bad_partner_mentions_count": { "type": "integer", "description": "Количество упоминаний на форуме недобросовестных партнеров", "format": "int32", "example": 0 }, "claims_count": { "type": "integer", "description": "Количество претензий от фирм", "format": "int32", "example": 0 }, "recommendations_count": { "type": "integer", "description": "Количество рекомендаций от фирм", "format": "int32", "example": 0 }, "inn": { "type": [ "null", "string" ], "description": "Инн", "example": "string" }, "ogrn": { "type": [ "null", "string" ], "description": "ОГРН", "example": "string" }, "kpp": { "type": [ "null", "string" ], "description": "Код причины постановки на учет фирмы", "example": "string" }, "okpo": { "type": [ "null", "string" ], "description": "Общероссийский классификатор предприятий и организаций", "example": "string" }, "affiliated_firms": { "type": [ "null", "array" ], "items": { "description": "Связанная фирма", "$ref": "#/components/schemas/AffiliatedFirmPublic" }, "description": "Список связанных фирм (Доступно только для платных пользователей)", "example": [ { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } ] }, "negative_points_sum": { "type": "number", "description": "Сумма отрицательных баллов", "format": "double", "example": 0 }, "tf_firm_color": { "type": [ "null", "string" ], "description": "Цвет фирмы в светофоре (Доступно только для платных пользователей)", "example": "string" }, "tf_account_color": { "type": [ "null", "string" ], "description": "Цвет аккаунта в светофоре (Доступно только для платных пользователей)", "example": "string" }, "tf_has_signals": { "type": "boolean", "description": "Флаг о существовании любой информации о фирме в светофоре", "example": false }, "registration_date": { "type": "string", "description": "Дата регистрации на сайте, которая AddDate из firms.", "format": "date-time", "example": "1970-01-01T00:00:00Z" }, "contact_info_changed": { "type": "string", "description": "Дата последних изменений в истории фирмы. (Доступно только для платных пользователей)", "format": "date-time", "example": "1970-01-01T00:00:00Z" }, "last_month_active_days": { "type": "integer", "description": "Число дней со входами на сайт за последние 30 дней (Доступно только для платных пользователей).", "format": "int32", "example": 0 }, "verified_trucks": { "type": "integer", "description": "Количество зарегистрированных ТС", "format": "int32", "example": 0 } }, "additionalProperties": false, "description": "Краткая информация о фирме с данными по контактам.", "example": { "contact_names": [ "string" ], "query_first_change_date": "1970-01-01T00:00:00Z", "ati_id": "string", "full_name": "string", "firm_type": "string", "firm_type_id": "string", "location": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" }, "address": "string", "position_in_city": 0, "position_in_country": 0, "firm_documents": [ { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } ], "web_site": "string", "info_reference": "string", "passport_reference": "string", "city": "string", "score": 0, "bad_partner_mentions_count": 0, "claims_count": 0, "recommendations_count": 0, "inn": "string", "ogrn": "string", "kpp": "string", "okpo": "string", "affiliated_firms": [ { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } ], "negative_points_sum": 0, "tf_firm_color": "string", "tf_account_color": "string", "tf_has_signals": false, "registration_date": "1970-01-01T00:00:00Z", "contact_info_changed": "1970-01-01T00:00:00Z", "last_month_active_days": 0, "verified_trucks": 0 } }, "AffiliatedFirmPublicAccountSummaryPublic": { "type": "object", "properties": { "ati_id": { "type": [ "null", "string" ], "description": "Код в АТИ.", "example": "string" }, "full_name": { "type": [ "null", "string" ], "description": "Полное имя фирмы: Брэнд (Название фирмы, ОПФ)", "example": "string" }, "firm_type": { "type": [ "null", "string" ], "description": "Профиль деятельности фирмы", "example": "string" }, "firm_type_id": { "type": [ "null", "string" ], "description": "Идентификатор профиля деятельности фирмы", "example": "string" }, "location": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/City" } ], "description": "Информация о месторасположении фирмы", "example": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" } }, "address": { "type": [ "null", "string" ], "description": "Адрес фирмы", "example": "string" }, "position_in_city": { "type": [ "null", "integer" ], "description": "Место в рэйтинге по городу", "format": "int32", "example": 0 }, "position_in_country": { "type": [ "null", "integer" ], "description": "Место в рэйтинге по стране", "format": "int32", "example": 0 }, "firm_documents": { "type": [ "null", "array" ], "items": { "description": "Документ, связанный с фирмой.", "$ref": "#/components/schemas/FirmDocument" }, "description": "Документы фирмы", "example": [ { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } ] }, "web_site": { "type": [ "null", "string" ], "description": "Сайт фирмы", "example": "string" }, "info_reference": { "type": [ "null", "string" ], "description": "Ссылка на карточку фирмы", "example": "string" }, "passport_reference": { "type": [ "null", "string" ], "description": "Ссылка на паспорт фирмы", "example": "string" }, "city": { "type": [ "null", "string" ], "description": "Город, в котором расположена фирма", "example": "string" }, "score": { "type": "number", "description": "Количество звезд фирмы. Если число отрицательно, то это красные звезды", "format": "double", "example": 0 }, "bad_partner_mentions_count": { "type": "integer", "description": "Количество упоминаний на форуме недобросовестных партнеров", "format": "int32", "example": 0 }, "claims_count": { "type": "integer", "description": "Количество претензий от фирм", "format": "int32", "example": 0 }, "recommendations_count": { "type": "integer", "description": "Количество рекомендаций от фирм", "format": "int32", "example": 0 }, "inn": { "type": [ "null", "string" ], "description": "Инн", "example": "string" }, "ogrn": { "type": [ "null", "string" ], "description": "ОГРН", "example": "string" }, "kpp": { "type": [ "null", "string" ], "description": "Код причины постановки на учет фирмы", "example": "string" }, "okpo": { "type": [ "null", "string" ], "description": "Общероссийский классификатор предприятий и организаций", "example": "string" }, "affiliated_firms": { "type": [ "null", "array" ], "items": { "description": "Связанная фирма", "$ref": "#/components/schemas/AffiliatedFirmPublic" }, "description": "Список связанных фирм (Доступно только для платных пользователей)", "example": [ { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } ] }, "negative_points_sum": { "type": "number", "description": "Сумма отрицательных баллов", "format": "double", "example": 0 }, "tf_firm_color": { "type": [ "null", "string" ], "description": "Цвет фирмы в светофоре (Доступно только для платных пользователей)", "example": "string" }, "tf_account_color": { "type": [ "null", "string" ], "description": "Цвет аккаунта в светофоре (Доступно только для платных пользователей)", "example": "string" }, "tf_has_signals": { "type": "boolean", "description": "Флаг о существовании любой информации о фирме в светофоре", "example": false }, "registration_date": { "type": "string", "description": "Дата регистрации на сайте, которая AddDate из firms.", "format": "date-time", "example": "1970-01-01T00:00:00Z" }, "contact_info_changed": { "type": "string", "description": "Дата последних изменений в истории фирмы. (Доступно только для платных пользователей)", "format": "date-time", "example": "1970-01-01T00:00:00Z" }, "last_month_active_days": { "type": "integer", "description": "Число дней со входами на сайт за последние 30 дней (Доступно только для платных пользователей).", "format": "int32", "example": 0 }, "verified_trucks": { "type": "integer", "description": "Количество зарегистрированных ТС", "format": "int32", "example": 0 } }, "additionalProperties": false, "description": "Публичная сводная информация по фирме.", "example": { "ati_id": "string", "full_name": "string", "firm_type": "string", "firm_type_id": "string", "location": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" }, "address": "string", "position_in_city": 0, "position_in_country": 0, "firm_documents": [ { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } ], "web_site": "string", "info_reference": "string", "passport_reference": "string", "city": "string", "score": 0, "bad_partner_mentions_count": 0, "claims_count": 0, "recommendations_count": 0, "inn": "string", "ogrn": "string", "kpp": "string", "okpo": "string", "affiliated_firms": [ { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } ], "negative_points_sum": 0, "tf_firm_color": "string", "tf_account_color": "string", "tf_has_signals": false, "registration_date": "1970-01-01T00:00:00Z", "contact_info_changed": "1970-01-01T00:00:00Z", "last_month_active_days": 0, "verified_trucks": 0 } }, "City": { "type": "object", "properties": { "city_id": { "type": "integer", "description": "Идентификатор города", "format": "int32", "example": 0 }, "region_id": { "type": [ "null", "integer" ], "description": "Идентификатор региона", "format": "int32", "example": 0 }, "country_id": { "type": [ "null", "integer" ], "description": "Идентификатор страны", "format": "int32", "example": 0 }, "full_name": { "type": [ "null", "string" ], "description": "Составное название состоящее из названий города, региона и страны разделенные через запятую.", "example": "string" }, "short_name": { "type": [ "null", "string" ], "description": "Составное название состоящее из названия города,\nназвания региона (если город не является областным центром)\nи буквенного кода страны (если страна отличается от России).", "example": "string" }, "is_regional_center": { "type": "boolean", "description": "Флаг - является ли город региональным центром", "example": false }, "city_size": { "type": "integer", "description": "Размер города по числу жителей.", "format": "int32", "example": 0 }, "fias_id": { "type": [ "null", "string" ], "description": "Идентификатор населенного пункта", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "attributes": { "enum": [ "0", "4" ], "allOf": [ { "description": "- 0 = None (Отсутствует)\n- 4 = RegionalCenter (Региональный центр)", "$ref": "#/components/schemas/CityAttributes" } ], "description": "Атрибуты города", "example": 0 }, "city_name": { "type": [ "null", "string" ], "description": "Название города", "example": "string" }, "region_name": { "type": [ "null", "string" ], "description": "Название региона", "example": "string" }, "country_name": { "type": [ "null", "string" ], "description": "Название страны", "example": "string" }, "country_code_name": { "type": [ "null", "string" ], "description": "Буквенный код страны (например, RUS)", "example": "string" } }, "additionalProperties": false, "description": "Структура \"Город\"", "example": { "city_id": 0, "region_id": 0, "country_id": 0, "full_name": "string", "short_name": "string", "is_regional_center": false, "city_size": 0, "fias_id": "00000000-0000-0000-0000-000000000000", "attributes": 0, "city_name": "string", "region_name": "string", "country_name": "string", "country_code_name": "string" } }, "FirmDocument": { "type": "object", "properties": { "link": { "type": [ "null", "string" ], "description": "Ссылка на документ.", "example": "string" }, "description": { "type": [ "null", "string" ], "description": "Автогенерируемое описание документа.", "example": "string" }, "creation_date": { "type": "string", "description": "Дата создания документа.", "format": "date-time", "example": "1970-01-01T00:00:00Z" } }, "additionalProperties": false, "description": "Документ, связанный с фирмой.", "example": { "link": "string", "description": "string", "creation_date": "1970-01-01T00:00:00Z" } }, "AffiliatedFirmPublic": { "type": "object", "properties": { "firm_name": { "type": [ "null", "string" ], "description": "Название фирмы", "example": "string" }, "inn": { "type": [ "null", "string" ], "description": "ИНН", "example": "string" }, "tf_firm_color": { "type": [ "null", "string" ], "description": "Цвет фирмы в светофоре", "example": "string" }, "tf_has_signals": { "type": "boolean", "description": "Флаг о существовании любой информации о фирме в светофоре", "example": false } }, "additionalProperties": false, "description": "Связанная фирма", "example": { "firm_name": "string", "inn": "string", "tf_firm_color": "string", "tf_has_signals": false } }, "CityAttributes": { "enum": [ 0, 4 ], "type": "integer", "oneOf": [ { "const": "0", "title": "None", "description": "Отсутствует" }, { "const": "4", "title": "RegionalCenter", "description": "Региональный центр" } ], "description": "- 0 = None (Отсутствует)\n- 4 = RegionalCenter (Региональный центр)", "x-ms-enum-flags": { "isFlags": false } }, "IntegrationClaimAddRequestDto": { "type": "object", "properties": { "claim_type": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/IntegrationClaimTypeDto" } ], "description": "DTO типа претензии", "example": { "type_id": 0, "user_type": 0 } }, "owner_firm": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/IntegrationClaimAddOwnerFirmDto" } ], "description": "Фирма истец", "example": { "inn": "string" } }, "currency_id": { "type": "integer", "description": "ID валюты выставляемой претензии", "format": "int32", "example": 0 }, "total_sum": { "type": "number", "description": "Сумма разногласий", "format": "double", "example": 0 }, "fail_to_pay_date": { "type": [ "null", "string" ], "description": "Дата наступления просрочки", "format": "date-time", "example": "1970-01-01T00:00:00Z" }, "substantiation": { "type": [ "null", "string" ], "description": "Обоснование суммы претензии", "example": "string" }, "defendant_firm": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/IntegrationClaimAddDefendantFirmDto" } ], "description": "Фирма ответчик", "example": { "ati_id": "string", "inn": "string", "city_name": "string", "ownership_id": 0, "firm_name": "string" } }, "document_files": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/IntegrationClaimDocumentRequestDto" }, "description": "Прикрепленные документы претензии", "example": [ { "file_key": "string" } ] } }, "additionalProperties": false, "description": "Тело запроса на добавление претензии для внешних интеграторов.", "example": { "claim_type": { "type_id": 0, "user_type": 0 }, "owner_firm": { "inn": "string" }, "currency_id": 0, "total_sum": 0, "fail_to_pay_date": "1970-01-01T00:00:00Z", "substantiation": "string", "defendant_firm": { "ati_id": "string", "inn": "string", "city_name": "string", "ownership_id": 0, "firm_name": "string" }, "document_files": [ { "file_key": "string" } ] } }, "IntegrationClaimAddResultDto": { "type": "object", "properties": { "id": { "type": [ "null", "string" ], "description": "Идентификатор новой претензии", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "claim_level": { "enum": [ "0", "1" ], "allOf": [ { "$ref": "#/components/schemas/ClaimLevel" } ], "description": "Уровень претензии (лайт / полная)", "example": 0 } }, "additionalProperties": false, "description": "Плоский результат добавления претензии для внешних интеграторов (все поля на одном уровне, без наследования).", "example": { "id": "00000000-0000-0000-0000-000000000000", "claim_level": 0 } }, "IntegrationClaimDefendantFirmsDto": { "type": "object", "properties": { "defendant_firms": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/IntegrationClaimDefendantFirmDto" }, "description": "Список связанных фирм ответчика", "example": [ { "name": "string", "inn": "string" } ] } }, "additionalProperties": false, "description": "Список связанных фирм ответчика для внешних интеграторов.", "example": { "defendant_firms": [ { "name": "string", "inn": "string" } ] } }, "IntegrationClaimDocumentUploadResultDto": { "type": "object", "properties": { "file_key": { "type": [ "null", "string" ], "description": "Ключ файла в плюшкине", "example": "string" } }, "additionalProperties": false, "description": "Результат загрузки файла в плюшкин для внешних интеграторов.", "example": { "file_key": "string" } }, "IntegrationClaimTypeDto": { "type": "object", "properties": { "type_id": { "type": "integer", "description": "Идентификатор типа претензии", "format": "int32", "example": 0 }, "user_type": { "enum": [ "0", "1", "2" ], "allOf": [ { "$ref": "#/components/schemas/ClaimForType" } ], "description": "Идентификатор типа на кого выставлена претензия", "example": 0 } }, "additionalProperties": false, "example": { "type_id": 0, "user_type": 0 } }, "IntegrationClaimAddOwnerFirmDto": { "type": "object", "properties": { "inn": { "type": [ "null", "string" ], "description": "ИНН фирмы истца", "example": "string" } }, "additionalProperties": false, "example": { "inn": "string" } }, "IntegrationClaimAddDefendantFirmDto": { "type": "object", "properties": { "ati_id": { "type": [ "null", "string" ], "description": "ATI ID фирмы ответчика", "example": "string" }, "inn": { "type": [ "null", "string" ], "description": "ИНН фирмы ответчика", "example": "string" }, "city_name": { "type": [ "null", "string" ], "description": "Наименование города", "example": "string" }, "ownership_id": { "type": [ "null", "integer" ], "description": "Идентификатор формы собственности", "format": "int32", "example": 0 }, "firm_name": { "type": [ "null", "string" ], "description": "Наименование фирмы ответчика", "example": "string" } }, "additionalProperties": false, "example": { "ati_id": "string", "inn": "string", "city_name": "string", "ownership_id": 0, "firm_name": "string" } }, "IntegrationClaimDocumentRequestDto": { "required": [ "file_key" ], "type": "object", "properties": { "file_key": { "minLength": 1, "type": "string", "description": "Ключ загруженного файла", "example": "string" } }, "additionalProperties": false, "example": { "file_key": "string" } }, "ClaimLevel": { "enum": [ 0, 1 ], "type": "integer", "oneOf": [ { "const": "0", "title": "ClaimLite", "description": "Претензия-Лайт" }, { "const": "1", "title": "Claim", "description": "Претензия-Про" } ], "description": "Уровень Претензии\n- 0 = ClaimLite (Претензия-Лайт)\n- 1 = Claim (Претензия-Про)", "x-ms-enum-flags": { "isFlags": false } }, "IntegrationClaimDefendantFirmDto": { "type": "object", "properties": { "name": { "type": [ "null", "string" ], "description": "Наименование связанной фирмы с формой собственности", "example": "string" }, "inn": { "type": [ "null", "string" ], "description": "ИНН связанной фирмы", "example": "string" } }, "additionalProperties": false, "description": "Связанная фирма ответчика (контракт для внешних интеграторов).", "example": { "name": "string", "inn": "string" } }, "ClaimForType": { "enum": [ 0, 1, 2 ], "type": "integer", "oneOf": [ { "const": "0", "title": "None" }, { "const": "1", "title": "Customer", "description": "Претензия как к заказчику" }, { "const": "2", "title": "Executor", "description": "Претензии как к исполнителю" } ], "description": "Тип, определяющий на кого выставлена претензия\n- 0 = None\n- 1 = Customer (Претензия как к заказчику)\n- 2 = Executor (Претензии как к исполнителю)", "x-ms-enum-flags": { "isFlags": true } }, "DictionaryItemWithAttributeDictionary": { "type": "object", "properties": { "dictionary_item_id": { "type": "integer", "description": "Идентификатор элемента словаря" }, "attributes_dictionary": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Атрибуты элемента в человекочитаемом виде" } } }, "CarType": { "type": "object", "description": "Тип кузова.", "properties": { "Id": { "type": "integer", "description": "Числовой идентификатор записи справочника.", "format": "int64", "example": 1 }, "Id2": { "type": "string", "description": "Идентификатор записи справочника в виде guid.", "format": "guid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "Name": { "type": "string", "description": "Название записи справочника на русском.", "example": "Тент." }, "Attribs": { "type": "integer", "description": "Служебная битовая маска свойств кузова", "format": "int32", "example": 4 }, "Position": { "type": "integer", "description": "Порядок кузова в списке", "format": "int32", "example": 20 }, "TypeId": { "type": "integer", "description": "Порядковый номер кузова в справочнике. В грузах кузов задаётся полем Id — битом маски", "format": "int32", "example": 200 }, "StringifiedTypeId": { "type": "string", "description": "Идентификатор кузова строкой", "example": "1" }, "NameEng": { "type": "string", "description": "Название на английском", "example": "tent truck" }, "ShortName": { "type": "string", "description": "Короткое название", "example": "тент." }, "ShortNameEng": { "type": "string", "description": "Короткое название на английском", "example": "tent" } } }, "CargoType": { "type": "object", "description": "Наименование груза.", "properties": { "Id": { "type": "integer", "description": "Числовой идентификатор записи справочника.", "format": "int64", "example": 1 }, "Id2": { "type": "string", "description": "Идентификатор записи справочника в виде guid.", "format": "guid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "Name": { "type": "string", "description": "Название записи справочника на русском.", "example": "Тент." }, "NameEng": { "type": "string", "description": "Название на английском", "example": "Alcoholic drinks" } } }, "ati.search-loadsAndDictionaries__City": { "type": "object", "description": "Город из справочника.", "properties": { "Id2": { "type": "string", "description": "Идентификатор города в виде guid", "format": "guid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "CityId": { "type": "integer", "description": "Идентификатор города", "format": "int32", "example": 1 }, "RegionId": { "type": "integer", "description": "Идентификатор региона. dict: GET /v1.0/dictionaries/regions → Id", "format": "int32", "nullable": true, "example": 153 }, "CountryId": { "type": "integer", "description": "Идентификатор страны. dict: GET /v1.0/dictionaries/countries → Id", "format": "int32", "nullable": true, "example": 1 }, "FullName": { "type": "string", "description": "Город, регион и страна через запятую", "example": "Санкт-Петербург, Санкт-Петербург (регион), Россия" }, "ShortName": { "type": "string", "description": "Составное название, состоящее из названия города,\nназвания региона (если город не является областным центром) и\nбуквенного кода страны (если страна отличается от России)", "example": "Санкт-Петербург" }, "FullNameEng": { "type": "string", "description": "Город, регион и страна через запятую на английском", "example": "Saint Petersburg, Saint Petersburg (region), Russia" }, "ShortNameEng": { "type": "string", "description": "Составное название, состоящее из названия города,\nназвания региона (если город не является областным центром) и\nбуквенного кода страны (если страна отличается от России), на английском", "example": "Saint Petersburg" }, "IsRegionalCenter": { "type": "boolean", "description": "Является ли город региональным центром", "example": true }, "CitySize": { "type": "integer", "description": "Категория города по числу жителей:\n \n* `0` - не определена\n* `1` - до 10 000\n* `2` - от 10 000 до 50 000\n* `3` - от 50 000 до 100 000\n* `4` - от 100 000 до 500 000\n* `5` - от 500 000 до 1 000 000\n* `6` - свыше 1 000 000", "format": "int32", "example": 6 }, "FiasId": { "type": "string", "description": "Идентификатор города в базе ФИАС", "format": "guid", "nullable": true, "example": "c2deb16a-0330-4f05-821f-1d09c93331e6" }, "Longitude": { "type": "number", "description": "Долгота города", "format": "double", "nullable": true, "example": 30.316229 }, "Latitude": { "type": "number", "description": "Широта города", "format": "double", "nullable": true, "example": 59.938732 }, "CityName": { "type": "string", "description": "Название города", "example": "Санкт-Петербург" }, "RegionName": { "type": "string", "description": "Название региона", "example": "Санкт-Петербург (регион)" }, "CountryName": { "type": "string", "description": "Название страны", "example": "Россия" }, "CityNameEng": { "type": "string", "description": "Название города на английском", "example": "Saint Petersburg" }, "RegionNameEng": { "type": "string", "description": "Название региона на английском", "example": "Saint Petersburg (region)" }, "CountryNameEng": { "type": "string", "description": "Название страны на английском", "example": "Russia" }, "CountryCodeName": { "type": "string", "description": "Трёхбуквенный код страны, как InterShortName в справочнике стран", "example": "RUS" } } }, "FinalExceptionModelOfCityNotFoundException": { "type": "object", "description": "Ошибка вместо результата: машинный ключ и пояснение для пользователя.", "properties": { "Reason": { "type": "string", "description": "Причина ошибки", "example": "Город не найден" }, "Error": { "type": "string", "description": "Ключ ошибки", "example": "city_not_found_error" } } }, "CityWithDistance": { "type": "object", "description": "Город с расстоянием до исходной точки.", "properties": { "Id2": { "type": "string", "description": "Идентификатор города в виде guid", "format": "guid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "CityId": { "type": "integer", "description": "Идентификатор города", "format": "int32", "example": 1 }, "Name": { "type": "string", "description": "Название города", "example": "Санкт-Петербург" }, "Distance": { "type": "number", "description": "Расстояние до исходной точки в километрах", "format": "double", "example": 35.4 } } }, "FinalExceptionModelOfRequestValidationException": { "type": "object", "description": "Ошибка вместо результата: машинный ключ и пояснение для пользователя.", "properties": { "Reason": { "type": "string", "description": "Причина ошибки", "example": "Ошибка валидации: Массив ids не должен быть пуст" }, "Error": { "type": "string", "description": "Ключ ошибки", "example": "validation_error" } } }, "StrippedCurrencyTypeModel": { "type": "object", "description": "Валюта в кратком виде.", "properties": { "Name": { "type": "string", "description": "Название валюты на русском", "example": "руб" }, "NameEng": { "type": "string", "description": "Название валюты на английском", "example": "rub" }, "Id": { "type": "integer", "description": "Идентификатор валюты", "format": "int64", "example": 1 }, "Id2": { "type": "string", "description": "Идентификатор валюты в виде guid", "format": "guid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "Modifier": { "type": "integer", "description": "Множитель единицы валюты: 1 для РУБ, 1000 для ТЫС.РУБ", "format": "int32", "example": 1 }, "CurrencyIdPerKm": { "type": "integer", "description": "Идентификатор этой же валюты в пересчёте за километр: у РУБ это РУБ/КМ", "format": "int32", "nullable": true, "example": 8 }, "CurrencyIdPerTon": { "type": "integer", "description": "Идентификатор этой же валюты в пересчёте за тонну: у РУБ это РУБ/Т", "format": "int32", "nullable": true, "example": 13 }, "Iso4217Code": { "type": "string", "description": "Буквенный код валюты по ISO 4217", "example": "RUB" }, "Iso4217DigitalCode": { "type": "integer", "description": "Числовой код валюты по ISO 4217", "format": "int32", "example": 643 } } }, "LoadingType": { "type": "object", "description": "Вариант загрузки или разгрузки.", "properties": { "Id": { "type": "integer", "description": "Числовой идентификатор записи справочника.", "format": "int64", "example": 1 }, "Id2": { "type": "string", "description": "Идентификатор записи справочника в виде guid.", "format": "guid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "Name": { "type": "string", "description": "Название записи справочника на русском.", "example": "Тент." }, "NameEng": { "type": "string", "description": "Название на английском", "example": "rear" }, "ShortName": { "type": "string", "description": "Короткое название", "example": "задн." }, "ShortNameEng": { "type": "string", "description": "Короткое название на английском", "example": "rear" } } }, "MoneyType": { "type": "object", "description": "Вариант оплаты.", "properties": { "Id": { "type": "integer", "description": "Числовой идентификатор записи справочника.", "format": "int64", "example": 1 }, "Id2": { "type": "string", "description": "Идентификатор записи справочника в виде guid.", "format": "guid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "Name": { "type": "string", "description": "Название записи справочника на русском.", "example": "Тент." }, "NameEng": { "type": "string", "description": "Название на английском", "example": "cash" } } }, "Ownership": { "type": "object", "description": "Организационно-правовая форма.", "properties": { "Id": { "type": "integer", "description": "Числовой идентификатор записи справочника.", "format": "int64", "example": 1 }, "Id2": { "type": "string", "description": "Идентификатор записи справочника в виде guid.", "format": "guid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "Name": { "type": "string", "description": "Название записи справочника на русском.", "example": "Тент." }, "FullName": { "type": "string", "description": "Полное название", "example": "Акционерное общество" } } }, "PackType": { "type": "object", "description": "Тип упаковки.", "properties": { "Id": { "type": "integer", "description": "Числовой идентификатор записи справочника.", "format": "int64", "example": 1 }, "Id2": { "type": "string", "description": "Идентификатор записи справочника в виде guid.", "format": "guid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "Name": { "type": "string", "description": "Название записи справочника на русском.", "example": "Тент." }, "NameEng": { "type": "string", "description": "Название на английском", "example": "boxes" }, "ShortName": { "type": "string", "description": "Короткое название", "example": "кор" } } }, "Region": { "type": "object", "description": "Регион.", "properties": { "Id": { "type": "integer", "description": "Числовой идентификатор записи справочника.", "format": "int64", "example": 1 }, "Id2": { "type": "string", "description": "Идентификатор записи справочника в виде guid.", "format": "guid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "Name": { "type": "string", "description": "Название записи справочника на русском.", "example": "Тент." }, "NameEng": { "type": "string", "description": "Название на английском", "example": "Leningrad oblast" }, "RegionClearName": { "type": "string", "description": "Название региона без типа: например, «Московская» для Московской области", "example": "Ленинградская" }, "RegionTypeAbbr": { "type": "string", "description": "Сокращённый тип региона: например, «обл.»", "example": "обл." }, "CountryId": { "type": "integer", "description": "Идентификатор страны. dict: GET /v1.0/dictionaries/countries → Id", "format": "int32", "example": 1 }, "RegionCode": { "type": "string", "description": "Код региона. Есть только у субъектов России", "example": "47" } } }, "StreetType": { "type": "object", "description": "Тип улицы.", "properties": { "Id": { "type": "integer", "description": "Числовой идентификатор записи справочника.", "format": "int64", "example": 1 }, "Id2": { "type": "string", "description": "Идентификатор записи справочника в виде guid.", "format": "guid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "Name": { "type": "string", "description": "Название записи справочника на русском.", "example": "Тент." }, "ShortName": { "type": "string", "description": "Короткое название", "example": "ул." } } }, "GroupOperationStatusView": { "type": "object", "description": "Статус групповой операции по грузу с описанием отказа.", "properties": { "Status": { "type": "integer", "description": "Статус операции.\n \n* `0` - Успех\n* `1` - Груз не найден\n* `2` - Груз обновляли или восстанавливали слишком недавно\n* `3` - Нет доступа; для обновления груза сюда же попадает повтор раньше разрешённого интервала\n* `5` - Найден дубликат среди опубликованных грузов\n* `7` - Груз не прошёл проверку полей\n* `8` - Внутренняя ошибка при обработке груза\n* `9` - Отзыв не найден\n* `10` - Не хватает средств на платное размещение\n* `11` - Кошелёк для платного размещения заблокирован\n* `-1` - Незапланированная ошибка", "format": "int32", "example": 0 }, "Message": { "type": "string", "description": "Пояснение к статусу для показа пользователю", "example": "Успешная операция" }, "Error": { "type": "string", "description": "Ключ ошибки. Только при Status, отличном от 0", "nullable": true, "example": "load_not_found_error" }, "Reason": { "type": "string", "description": "Причина ошибки для показа пользователю. Только при Status, отличном от 0", "nullable": true, "example": "Груз не найден" }, "Paid": { "type": "boolean", "description": "Груз восстановлен с платным размещением на площадках. Только у такого восстановления", "nullable": true, "example": true }, "PlacementPrice": { "type": "number", "description": "Списанная стоимость платного размещения. Только при Paid = true", "format": "decimal", "nullable": true, "example": 150 } } }, "LoadView": { "type": "object", "description": "Груз в ответе: поля публикации и вычисляемые сервисом.", "required": [ "ContactId1", "Loading", "Unloading", "Cargo", "Transport", "Payment" ], "properties": { "LoadMeta": { "description": "Метаданные публикации: по их идентификатору можно получить все грузы, размещённые одной публикацией", "oneOf": [ { "$ref": "#/components/schemas/LoadMetaView" } ] }, "ContactId1": { "type": "integer", "description": "Идентификатор первого выбранного контакта. dict: GET https://api.ati.su/firms/v1.0/contacts → id.\nСписок всех контактов и их идентификаторы можно получить с помощью [API для работы с фирмами](https://ati.su/developers/api/firms/).\nКонтакт должен быть виден для остальных участников АТИ", "format": "int32", "example": 1234567 }, "ContactId2": { "type": "integer", "description": "Идентификатор второго выбранного контакта, если не выбрано, то null.\nКонтакт должен быть виден для остальных участников АТИ", "format": "int32", "nullable": true, "example": 1234568 }, "Note": { "type": "string", "description": "Примечание к грузу.\nОграничение по длине: 1000 символов", "default": "", "example": "Погрузка с 9 до 18, пропуск заказывать заранее" }, "FirstDate": { "type": "string", "description": "Дата, начиная с которой груз актуален, в формате UTC.\nМинимальное значение равно текущей дате.\nПри значении параметра DateType равным 0, допустимое значение поля - текущая дата.\nПри значении параметра DateType равным 1, допустимое значение поля - от текущей даты до 2 месяцев вперед.\nПри значении параметра DateType равным 2, допустимое значение поля - текущая дата.\nПри значении параметра DateType равным 3, FirstDate должен принимать значение текущей даты или отсутствовать", "format": "date-time", "example": "2026-09-08T00:00:00.000Z" }, "LastDate": { "type": "string", "description": "Дата, после которой груз не актуален, в формате UTC.\nМинимальное значение равно значению параметра FirstDate.\nПри значении параметра DateType равным 0, допустимое значение поля - от текущей даты до 1 дня вперед.\nПри значении параметра DateType равным 1, допустимое значение поля - от даты в параметре FirstDate до 9 дней вперед.\nПри значении параметра DateType равным 2, сервис вычисляет поле как FirstDate + 2 месяца, передаваемое значение игнорируется.\nПри значении параметра DateType равным 3, LastDate автоматически устанавливается на значение + 2 дня от текущей даты, передаваемое значение игнорируется", "format": "date-time", "example": "2026-09-10T00:00:00.000Z" }, "DateType": { "type": "integer", "description": "Тип готовности груза к перевозке, по умолчанию `0`\n \n* `0` - Готов к загрузке\n* `1` - в период с FirstDate по LastDate\n* `2` - постоянно\n* `3` - груза нет, запрос ставки", "format": "int32", "example": 1 }, "PeriodicityId": { "type": "integer", "description": "Периодичность загрузки.\nЕсли параметр DateType не равен 2, PeriodicityId равен 0.\nИначе PeriodicityId может принимать следующие значения:\n \n* `1` - ежедневно\n* `100` - по рабочим дням", "format": "int32", "example": 0 }, "OrderNumber": { "type": "string", "description": "Номер заказа.\nОграничение по длине: 250 символов", "default": "", "example": "ЗК-2026-0917" }, "Krugoreis": { "type": "boolean", "description": "Включён ли кругорейс", "example": false }, "Loading": { "description": "Точка погрузки", "oneOf": [ { "$ref": "#/components/schemas/LoadPointView" } ] }, "ExtraPoints": { "type": "array", "description": "Дополнительные пункты маршрута между погрузкой и выгрузкой.\nМаксимум 15 штук. Может иметь значение `null`", "example": [], "items": { "$ref": "#/components/schemas/LoadExtraPointView" } }, "Unloading": { "description": "Точка выгрузки", "oneOf": [ { "$ref": "#/components/schemas/LoadPointView" } ] }, "Cargo": { "description": "Что везём: наименование, вес, объём, упаковка", "oneOf": [ { "$ref": "#/components/schemas/LoadCargoView" } ] }, "Transport": { "description": "Требования к транспорту: кузов, варианты загрузки и выгрузки", "oneOf": [ { "$ref": "#/components/schemas/LoadTransportView" } ] }, "Payment": { "description": "Условия оплаты и ставка", "oneOf": [ { "$ref": "#/components/schemas/LoadPaymentView" } ] }, "InviteSettings": { "description": "Настройки автоприглашений", "oneOf": [ { "$ref": "#/components/schemas/LoadInviteSettingsView" } ] }, "PriorityView": { "description": "Приоритетный показ", "oneOf": [ { "$ref": "#/components/schemas/LoadPriorityViewView" } ] }, "Stealth": { "description": "Настройки показа груза", "oneOf": [ { "$ref": "#/components/schemas/LoadStealthView" } ] }, "LoadFiles": { "type": "array", "description": "Файлы к грузу.\nПеред добавлением груза с файлом, файл предварительно необходимо загрузить в АТИ-Доки (см. [API для хранения файлов](https://ati.su/developers/api/filestorage/))", "example": [], "items": { "$ref": "#/components/schemas/LoadFileView" } }, "Deal": { "description": "Сделка, в рамках которой размещён груз", "oneOf": [ { "$ref": "#/components/schemas/DealItemView" } ] }, "Boards": { "type": "array", "description": "Список площадок", "example": [], "items": { "$ref": "#/components/schemas/LoadBoardView" } }, "UnloadFirstDate": { "type": "string", "description": "Дата начала разгрузки, в формате UTC.\nМожет иметь значение `null`.\nМинимальное значение равно текущей дате.\nНе указывается при значении параметра DateType равным `3`", "format": "date-time", "nullable": true, "example": "2026-09-11T00:00:00.000Z" }, "UnloadLastDate": { "type": "string", "description": "Дата окончания разгрузки, в формате UTC.\nМожет иметь значение `null`.\nЕсли нет даты начала разгрузки UnloadFirstDate, должна отсутствовать дата окончания разгрузки UnloadLastDate.\nНе указывается при значении параметра DateType равным `3`", "format": "date-time", "nullable": true, "example": "2026-09-12T00:00:00.000Z" }, "ArchiveDate": { "type": "string", "description": "Дата и время переноса в архив", "format": "date-time", "nullable": true, "example": "2026-09-07T10:15:30.000Z" }, "ArchiveReason": { "description": "Причина переноса в архив", "nullable": true, "example": "Manual", "oneOf": [ { "$ref": "#/components/schemas/ArchiveReason" } ] }, "TruePrice": { "type": "integer", "description": "Озвученная ставка", "format": "int32", "example": 85000 }, "TrueCurrencyId": { "type": "integer", "description": "Идентификатор валюты озвученной ставки. dict: GET /v1.0/dictionaries/currencyTypes → Id", "format": "int32", "example": 1 }, "ResponseCount": { "type": "integer", "description": "Количество отзывов о грузе (без встречных предложений)", "format": "int32", "example": 3 }, "OfferCount": { "type": "integer", "description": "Количество встречных предложений (остальные отзывы не учитываются)", "format": "int32", "example": 2 }, "CanBeDeleted": { "type": "boolean", "description": "Можно ли снять груз с публикации", "example": true }, "HasPermissionsToLoad": { "type": "boolean", "description": "Есть ли у текущего контакта доступ к грузу: контакт указан в грузе или имеет доступ к его подразделению", "example": true }, "CanBeEdited": { "type": "boolean", "description": "Можно ли редактировать груз", "example": true }, "CanBeRenewed": { "type": "boolean", "description": "Можно ли обновить груз", "example": true }, "CanBeRestored": { "type": "boolean", "description": "Можно ли восстановить груз из архива", "example": false }, "EditRestriction": { "description": "Причина отказа в редактировании груза, `0` — доступ есть. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ", "example": 0, "oneOf": [ { "$ref": "#/components/schemas/LoadAccessDeniedReason" } ] }, "DeleteRestriction": { "description": "Причина отказа в снятии груза с публикации, `0` — доступ есть. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ", "example": 0, "oneOf": [ { "$ref": "#/components/schemas/LoadAccessDeniedReason" } ] }, "RestoreRestriction": { "description": "Причина отказа в восстановлении груза из архива, `0` — доступ есть. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ", "example": 0, "oneOf": [ { "$ref": "#/components/schemas/LoadAccessDeniedReason" } ] }, "RenewRestriction": { "type": "string", "description": "Причина отказа в обновлении груза. Пустая строка, если обновление доступно", "example": "Груз можно обновить не ранее чем через 40 минут" }, "Id": { "type": "string", "description": "Идентификатор груза", "format": "guid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "LoadNumber": { "type": "string", "description": "Номер груза", "example": "12345678" }, "UpdatedAt": { "type": "string", "description": "Дата последнего изменения груза в UTC", "format": "date-time", "example": "2026-09-07T10:15:30.000Z" }, "AddedAt": { "type": "string", "description": "Дата публикации груза в UTC", "format": "date-time", "example": "2026-09-05T08:00:00.000Z" }, "RefreshedAt": { "type": "string", "description": "Дата последнего обновления груза в выдаче, в UTC", "format": "date-time", "example": "2026-09-07T09:00:00+00:00" }, "Distance": { "type": "integer", "description": "Расстояние по дорогам в километрах", "format": "int32", "example": 712 }, "PlatonRoadsLength": { "type": "integer", "description": "Протяжённость участков маршрута, за которые взимается плата по системе «Платон», в километрах", "format": "int32", "example": 540 }, "TollRoadsLength": { "type": "integer", "description": "Протяжённость платных дорог на маршруте в километрах", "format": "int32", "example": 120 }, "TravelTime": { "type": "string", "description": "Расчётное время в пути в формате `[d.]hh:mm:ss`", "example": "10:30:00" }, "Zimnik": { "type": "boolean", "description": "Учитывать ли зимники при построении маршрута", "example": false }, "Ferries": { "type": "boolean", "description": "Учитывать ли паромные переправы при построении маршрута", "example": false }, "FirmId": { "type": "string", "description": "Идентификатор фирмы", "example": "1234567" }, "AuctionId": { "type": "string", "description": "Идентификатор аукциона по грузу", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } }, "FinalExceptionModelOfContactNotFoundException": { "type": "object", "description": "Ошибка вместо результата: машинный ключ и пояснение для пользователя.", "properties": { "Reason": { "type": "string", "description": "Причина ошибки", "example": "Контакт не существует" }, "Error": { "type": "string", "description": "Ключ ошибки", "example": "contact_not_found_error" } } }, "InsertLoadDto": { "type": "object", "description": "Груз для публикации.", "required": [ "ContactId1", "Loading", "Unloading", "Cargo", "Transport", "Payment" ], "properties": { "LoadMeta": { "description": "Метаданные публикации: по их идентификатору можно получить все грузы, размещённые одной публикацией", "oneOf": [ { "$ref": "#/components/schemas/LoadMetaView" } ] }, "ContactId1": { "type": "integer", "description": "Идентификатор первого выбранного контакта. dict: GET https://api.ati.su/firms/v1.0/contacts → id.\nСписок всех контактов и их идентификаторы можно получить с помощью [API для работы с фирмами](https://ati.su/developers/api/firms/).\nКонтакт должен быть виден для остальных участников АТИ", "format": "int32", "example": 1234567 }, "ContactId2": { "type": "integer", "description": "Идентификатор второго выбранного контакта, если не выбрано, то null.\nКонтакт должен быть виден для остальных участников АТИ", "format": "int32", "nullable": true, "example": 1234568 }, "Note": { "type": "string", "description": "Примечание к грузу.\nОграничение по длине: 1000 символов", "default": "", "example": "Погрузка с 9 до 18, пропуск заказывать заранее" }, "FirstDate": { "type": "string", "description": "Дата, начиная с которой груз актуален, в формате UTC.\nМинимальное значение равно текущей дате.\nПри значении параметра DateType равным 0, допустимое значение поля - текущая дата.\nПри значении параметра DateType равным 1, допустимое значение поля - от текущей даты до 2 месяцев вперед.\nПри значении параметра DateType равным 2, допустимое значение поля - текущая дата.\nПри значении параметра DateType равным 3, FirstDate должен принимать значение текущей даты или отсутствовать", "format": "date-time", "example": "2026-09-08T00:00:00.000Z" }, "LastDate": { "type": "string", "description": "Дата, после которой груз не актуален, в формате UTC.\nМинимальное значение равно значению параметра FirstDate.\nПри значении параметра DateType равным 0, допустимое значение поля - от текущей даты до 1 дня вперед.\nПри значении параметра DateType равным 1, допустимое значение поля - от даты в параметре FirstDate до 9 дней вперед.\nПри значении параметра DateType равным 2, сервис вычисляет поле как FirstDate + 2 месяца, передаваемое значение игнорируется.\nПри значении параметра DateType равным 3, LastDate автоматически устанавливается на значение + 2 дня от текущей даты, передаваемое значение игнорируется", "format": "date-time", "example": "2026-09-10T00:00:00.000Z" }, "DateType": { "type": "integer", "description": "Тип готовности груза к перевозке, по умолчанию `0`\n \n* `0` - Готов к загрузке\n* `1` - в период с FirstDate по LastDate\n* `2` - постоянно\n* `3` - груза нет, запрос ставки", "format": "int32", "example": 1 }, "PeriodicityId": { "type": "integer", "description": "Периодичность загрузки.\nЕсли параметр DateType не равен 2, PeriodicityId равен 0.\nИначе PeriodicityId может принимать следующие значения:\n \n* `1` - ежедневно\n* `100` - по рабочим дням", "format": "int32", "example": 0 }, "OrderNumber": { "type": "string", "description": "Номер заказа.\nОграничение по длине: 250 символов", "default": "", "example": "ЗК-2026-0917" }, "Krugoreis": { "type": "boolean", "description": "Включён ли кругорейс", "example": false }, "Loading": { "description": "Точка погрузки", "oneOf": [ { "$ref": "#/components/schemas/LoadPointView" } ] }, "ExtraPoints": { "type": "array", "description": "Дополнительные пункты маршрута между погрузкой и выгрузкой.\nМаксимум 15 штук. Может иметь значение `null`", "example": [], "items": { "$ref": "#/components/schemas/LoadExtraPointView" } }, "Unloading": { "description": "Точка выгрузки", "oneOf": [ { "$ref": "#/components/schemas/LoadPointView" } ] }, "Cargo": { "description": "Что везём: наименование, вес, объём, упаковка", "oneOf": [ { "$ref": "#/components/schemas/LoadCargoView" } ] }, "Transport": { "description": "Требования к транспорту: кузов, варианты загрузки и выгрузки", "oneOf": [ { "$ref": "#/components/schemas/LoadTransportView" } ] }, "Payment": { "description": "Условия оплаты и ставка", "oneOf": [ { "$ref": "#/components/schemas/LoadPaymentView" } ] }, "InviteSettings": { "description": "Настройки автоприглашений", "oneOf": [ { "$ref": "#/components/schemas/LoadInviteSettingsView" } ] }, "PriorityView": { "description": "Приоритетный показ", "oneOf": [ { "$ref": "#/components/schemas/BaseLoadPriorityViewView" } ] }, "Stealth": { "description": "Настройки показа груза", "oneOf": [ { "$ref": "#/components/schemas/LoadStealthView" } ] }, "LoadFiles": { "type": "array", "description": "Файлы к грузу.\nПеред добавлением груза с файлом, файл предварительно необходимо загрузить в АТИ-Доки (см. [API для хранения файлов](https://ati.su/developers/api/filestorage/))", "example": [], "items": { "$ref": "#/components/schemas/LoadFileView" } }, "Deal": { "description": "Сделка, в рамках которой размещён груз", "oneOf": [ { "$ref": "#/components/schemas/BaseDealItemView" } ] }, "Boards": { "type": "array", "description": "Площадки публикации. Если не переданы, груз публикуется на общей площадке", "example": [], "items": { "$ref": "#/components/schemas/BaseLoadBoardView" } }, "UnloadFirstDate": { "type": "string", "description": "Дата начала разгрузки, в формате UTC.\nМожет иметь значение `null`.\nМинимальное значение равно текущей дате.\nНе указывается при значении параметра DateType равным `3`", "format": "date-time", "nullable": true, "example": "2026-09-11T00:00:00.000Z" }, "UnloadLastDate": { "type": "string", "description": "Дата окончания разгрузки, в формате UTC.\nМожет иметь значение `null`.\nЕсли нет даты начала разгрузки UnloadFirstDate, должна отсутствовать дата окончания разгрузки UnloadLastDate.\nНе указывается при значении параметра DateType равным `3`", "format": "date-time", "nullable": true, "example": "2026-09-12T00:00:00.000Z" } } }, "JsonValidationErrorView": { "type": "object", "description": "Тело запроса не разобрано или не прошло проверку полей.", "properties": { "Error": { "type": "string", "description": "Ключ ошибки: `json_validation_error` — поля не прошли проверку, `deserialization_error` — тело не разобрано", "example": "json_validation_error" }, "Reason": { "type": "string", "description": "Причина ошибки для показа пользователю", "example": "Ошибка валидации json" }, "ErrorsList": { "type": "array", "description": "Ошибки по полям. Только при `json_validation_error`", "nullable": true, "example": [], "items": { "$ref": "#/components/schemas/ValidationErrorItemView" } } } }, "FinalExceptionModelOfPaidPlacementLowBalanceException": { "type": "object", "description": "Ошибка вместо результата: машинный ключ и пояснение для пользователя.", "properties": { "Reason": { "type": "string", "description": "Причина ошибки", "example": "Недостаточно средств для платного размещения груза" }, "Error": { "type": "string", "description": "Ключ ошибки", "example": "low_balance_error" } } }, "LoadAccessDeniedErrorView": { "type": "object", "description": "Отказ в доступе к операции с грузом: ключ ошибки, пояснение и код причины.", "properties": { "Error": { "type": "string", "description": "Ключ ошибки", "example": "access_denied_error" }, "Reason": { "type": "string", "description": "Причина ошибки для показа пользователю", "example": "У вашего контакта недостаточно прав для работы с данным грузом" }, "AccessDeniedReason": { "description": "Код причины отказа. dict: GET /v1.0/dictionaries/load_access_denied_reasons → ключ", "example": 5, "oneOf": [ { "$ref": "#/components/schemas/LoadAccessDeniedReason" } ] }, "ExceededLimit": { "description": "Какой лимит грузов исчерпан, если причина отказа — превышение лимита: `0` — общая площадка, `1` — персональные площадки. В остальных случаях `null`", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/LoadLimitType" } ] } } }, "LoadConflictErrorView": { "type": "object", "description": "Отказ из-за дубликата: среди опубликованных грузов фирмы уже есть такой же.", "properties": { "Error": { "type": "string", "description": "Ключ ошибки", "example": "load_conflict_error" }, "Reason": { "type": "string", "description": "Причина ошибки для показа пользователю", "example": "Найден дубликат в грузах" }, "ConflictLoadId": { "type": "string", "description": "Идентификатор опубликованного груза, с которым найден дубликат", "format": "guid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } }, "FinalExceptionModelOfDailyLoadsCreationLimitReachedException": { "type": "object", "description": "Ошибка вместо результата: машинный ключ и пояснение для пользователя.", "properties": { "Reason": { "type": "string", "description": "Причина ошибки", "example": "Достигнут ежедневный лимит на публикацию грузов" }, "Error": { "type": "string", "description": "Ключ ошибки", "example": "daily_cargos_creation_limit_reached" } } }, "Comment": { "type": "object", "description": "Комментарий фирмы к грузу.", "properties": { "CommentId": { "type": "string", "description": "Идентификатор комментария", "format": "guid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "LoadId": { "type": "string", "description": "Идентификатор груза, к которому оставлен комментарий", "format": "guid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "Message": { "type": "string", "description": "Текст комментария", "example": "Договорились на понедельник" }, "ContactId": { "type": "integer", "description": "Идентификатор контакта фирмы, оставившего комментарий", "format": "int32", "example": 0 }, "CommentDateTime": { "type": "string", "description": "Время, когда комментарий был оставлен. Дата в UTC", "format": "date-time", "example": "2026-09-07T10:15:30.000Z" } } }, "CounterOfferUpsertDto": { "type": "object", "description": "Встречное предложение на груз.", "properties": { "CounterOfferSource": { "description": "Откуда пришло встречное предложение", "example": 2, "oneOf": [ { "$ref": "#/components/schemas/CounterOfferSource" } ] }, "LoadId": { "type": "string", "description": "Идентификатор груза, на который оставлен отзыв.\nЗаполняется сервисом из адреса запроса, переданное значение игнорируется", "format": "guid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "FirmId": { "type": "integer", "description": "Идентификатор фирмы, оставившей отзыв.\nЗаполняется сервисом из токена, переданное значение игнорируется", "format": "int32", "example": 7654321 }, "ContactId": { "type": "integer", "description": "Идентификатор контакта, сделавшего встречное предложение", "format": "int32", "example": 0 }, "Price": { "type": "number", "description": "Предложенная ставка наличными. Параметр должен быть равен одной из ставок груза: RateSum, SumWithNDS или SumWithoutNDS, если у груза, которому выставляется встречное предложение, параметр FixedRate равен True И параметр Torg равен False. Значение 0 допустимо, если ставка задана в NdsPrice или NotNdsPrice; хотя бы одна из трёх ставок больше 0. Не более 10 символов.", "format": "decimal", "example": 85000 }, "CurrencyId": { "type": "integer", "description": "Валюта встречного предложения. Параметр должен быть равен валюте, указанной в грузе, если параметр FixedRate равен True и параметр Torg равен False.\ndict: GET /v1.0/dictionaries/currencyTypes → Id.\ndocs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes", "format": "int32", "example": 1 }, "NdsPrice": { "type": "number", "description": "Предложенная ставка по безналичному расчёту с НДС", "format": "decimal", "example": 102000 }, "NdsCurrencyId": { "type": "integer", "description": "Валюта ставки встречного предложения по безналичному расчёту с НДС. Параметр должен быть равен валюте, указанной в грузе, если параметр FixedRate равен True и параметр Torg равен False.\ndict: GET /v1.0/dictionaries/currencyTypes → Id.\ndocs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes", "format": "int32", "example": 1 }, "NotNdsPrice": { "type": "number", "description": "Предложенная ставка по безналичному расчёту без НДС", "format": "decimal", "example": 85000 }, "NotNdsCurrencyId": { "type": "integer", "description": "Идентификатор валюты ставки по безналичному расчёту без НДС. Параметр должен быть равен валюте, указанной в грузе, если параметр FixedRate равен True и параметр Torg равен False.\ndict: GET /v1.0/dictionaries/currencyTypes → Id.\ndocs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes", "format": "int32", "example": 1 }, "Note": { "type": "string", "description": "Примечание к встречному предложению.\nМаксимальная длина - 512 символов", "example": "Готовы забрать завтра утром" }, "PayAttributes": { "type": "integer", "description": "Атрибуты оплаты, по умолчанию - 0.\nБитовая сумма следующих параметров:\n \n* `1` - возможна оплата наличными\n* `2` - возможна оплата по безналичному расчёту\n* `4` - блиц\n* `8` - оплата с НДС\n* `16` - возможна предоплата\n* `32` - оплата на выгрузке\n* `64` - оплата через N банковских дней (см. PayAfterMaxBankDays)", "format": "int32", "example": 10 }, "PrepayPercent": { "type": "integer", "description": "Процент предоплаты.\nДолжен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 16 - возможна предоплата. Допустимое значение от 0 до 100", "format": "int32", "example": 30 }, "PayAfterMaxBankDays": { "type": "integer", "description": "Оплата через ... банковских дней.\nДолжен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 64 - включёна оплата через некоторое количество банковских дней. Допустимое значение от 0 до 99", "format": "int32", "example": 5 }, "LoadingDate": { "type": "string", "description": "Дата, на которую перевозчик готов забрать груз", "format": "date-time", "nullable": true, "example": "2026-09-08T00:00:00.000Z" }, "NdsPercent": { "type": "integer", "description": "Процент НДС в ставке", "format": "int32", "nullable": true, "example": 20 } } }, "NewLoadResponseViewStandart": { "type": "object", "description": "Отзыв на груз в новой структуре.", "properties": { "ResponseId": { "type": "string", "description": "Идентификатор отзыва", "format": "guid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "LoadId": { "type": "string", "description": "Идентификатор груза, на который оставлен отзыв", "format": "guid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "LoadNumber": { "type": "string", "description": "Номер груза", "example": "12345678" }, "LoadFirmId": { "type": "integer", "description": "Идентификатор фирмы, которой принадлежит груз", "format": "int32", "example": 1234567 }, "FirmId": { "type": "integer", "description": "Идентификатор фирмы, оставившей отзыв", "format": "int32", "example": 7654321 }, "FirmName": { "type": "string", "description": "Название фирмы, оставившей отзыв", "example": "ООО «Перевозчик»" }, "ContactId": { "type": "integer", "description": "Идентификатор контакта, оставившего отзыв. `-1` — контакт скрыт: чужой отзыв на чужом грузе", "format": "int32", "example": 0 }, "AddedAt": { "type": "string", "description": "Дата добавления отзыва", "format": "date-time", "example": "2026-09-07T10:15:30.000Z" }, "UpdatedAt": { "type": "string", "description": "Дата изменения отзыва", "format": "date-time", "example": "2026-09-07T11:20:00.000Z" }, "Price": { "type": "number", "description": "Ставка встречного предложения наличными", "format": "decimal", "example": 85000 }, "CurrencyId": { "type": "integer", "description": "Валюта встречного предложения.\ndict: GET /v1.0/dictionaries/currencyTypes → Id.\ndocs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes", "format": "int32", "example": 1 }, "NdsPrice": { "type": "number", "description": "Предложенная ставка по безналичному расчёту с НДС", "format": "decimal", "example": 102000 }, "NdsCurrencyId": { "type": "integer", "description": "Валюта ставки встречного предложения по безналичному расчёту с НДС.\ndict: GET /v1.0/dictionaries/currencyTypes → Id.\ndocs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes", "format": "int32", "example": 1 }, "NotNdsPrice": { "type": "number", "description": "Предложенная ставка по безналичному расчёту без НДС", "format": "decimal", "example": 85000 }, "NotNdsCurrencyId": { "type": "integer", "description": "Идентификатор валюты ставки по безналичному расчёту без НДС. dict: GET /v1.0/dictionaries/currencyTypes → Id", "format": "int32", "example": 1 }, "NdsPercent": { "type": "integer", "description": "Процент НДС в ставке", "format": "int32", "nullable": true, "example": 20 }, "CounterOfferSource": { "description": "Откуда пришло встречное предложение", "example": 2, "oneOf": [ { "$ref": "#/components/schemas/CounterOfferSource" } ] }, "Note": { "type": "string", "description": "Примечание к встречному предложению.\n`null` — отзыв не является встречным предложением, пустая строка — примечание чужого отзыва скрыто", "example": "Готовы забрать завтра утром" }, "PayAttributes": { "type": "integer", "description": "Атрибуты оплаты.\nБитовая сумма следующих параметров:\n \n* `1` - возможна оплата наличными\n* `2` - возможна оплата по безналичному расчёту\n* `4` - блиц\n* `8` - оплата с НДС\n* `16` - возможна предоплата\n* `32` - оплата на выгрузке\n* `64` - оплата через N банковских дней (см. PayAfterMaxBankDays)", "format": "int32", "example": 91 }, "PrepayPercent": { "type": "integer", "description": "Процент предоплаты.\nДолжен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 16 - возможна предоплата. Допустимое значение от 0 до 100", "format": "int32", "example": 30 }, "PayAfterMaxBankDays": { "type": "integer", "description": "Оплата через ... банковских дней.\nДолжен быть равен 0 или отсутствовать, если PayAttributes не содержит флаг 64 - включёна оплата через некоторое количество банковских дней. Допустимое значение от 0 до 99", "format": "int32", "example": 5 }, "LoadingDate": { "type": "string", "description": "Дата, на которую перевозчик готов забрать груз", "format": "date-time", "nullable": true, "example": "2026-09-08T00:00:00.000Z" }, "IsOutdated": { "type": "boolean", "description": "Отзыв помечен просроченным: груз после него отредактировали или сняли с публикации", "example": false }, "IsLoadPublished": { "type": "boolean", "description": "Относится ли отзыв к опубликованному грузу, а не к архивному", "example": true }, "IsNoLoad": { "type": "boolean", "description": "Отзыв означает жалобу «груза нет»", "example": false }, "AnnouncedCurrencyId": { "type": "integer", "description": "Валюта \"Озвученной ставки\".\ndict: GET /v1.0/dictionaries/currencyTypes → Id.\ndocs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes", "format": "int32", "example": 1 }, "AnnouncedRate": { "type": "integer", "description": "Озвученная ставка", "format": "int32", "example": 90000 }, "FirmInfo": { "description": "Фирма, оставившая отзыв. Контакт скрыт у чужого отзыва на чужом грузе", "oneOf": [ { "$ref": "#/components/schemas/LoadResponseFirminfo" } ] } } }, "FinalExceptionModelOfAccessDeniedException": { "type": "object", "description": "Ошибка вместо результата: машинный ключ и пояснение для пользователя.", "properties": { "Reason": { "type": "string", "description": "Причина ошибки", "example": "Отказано в доступе: У вашей фирмы нет доступа к работе с отзывами" }, "Error": { "type": "string", "description": "Ключ ошибки", "example": "access_denied_error" } } }, "FinalExceptionModelOfLoadNotFoundException": { "type": "object", "description": "Ошибка вместо результата: машинный ключ и пояснение для пользователя.", "properties": { "Reason": { "type": "string", "description": "Причина ошибки", "example": "Груз не найден" }, "Error": { "type": "string", "description": "Ключ ошибки", "example": "load_not_found_error" } } }, "NewResponseOperationStatusView": { "type": "object", "description": "Результат операции над отзывами со списком отзывов.", "properties": { "Status": { "type": "integer", "description": "Статус операции.\n \n* `0` - Успех\n* `1` - Груз не найден\n* `2` - Груз обновляли или восстанавливали слишком недавно\n* `3` - Нет доступа; для обновления груза сюда же попадает повтор раньше разрешённого интервала\n* `5` - Найден дубликат среди опубликованных грузов\n* `7` - Груз не прошёл проверку полей\n* `8` - Внутренняя ошибка при обработке груза\n* `9` - Отзыв не найден\n* `10` - Не хватает средств на платное размещение\n* `11` - Кошелёк для платного размещения заблокирован\n* `-1` - Незапланированная ошибка", "format": "int32", "example": 0 }, "Message": { "type": "string", "description": "Пояснение к статусу для показа пользователю", "example": "Успешная операция" }, "Result": { "type": "array", "description": "Отзывы на груз всех типов. Только при Status, равном 0", "nullable": true, "example": [], "items": { "$ref": "#/components/schemas/NewLoadResponseViewStandart" } }, "Error": { "type": "string", "description": "Ключ ошибки. Только при Status, отличном от 0", "nullable": true, "example": "load_not_found_error" }, "Reason": { "type": "string", "description": "Причина ошибки. Только при Status, отличном от 0", "nullable": true, "example": "Груз не найден" } } }, "DeleteNewResponseOperationStatusView": { "type": "object", "description": "Результат удаления отзыва.", "properties": { "Status": { "type": "integer", "description": "Статус операции\n \n* `0` - Успех\n* `-1` - Незапланированная ошибка", "format": "int32", "example": 0 }, "Message": { "type": "string", "description": "Сообщение о результате", "example": "Успех" }, "Error": { "type": "string", "description": "Ключ ошибки, если Status не равен 0", "example": "response_not_found_error" }, "Reason": { "type": "string", "description": "Причина ошибки, если Status не равен 0", "example": "Отзыв не найден" } } }, "FinalExceptionModelOfResponseNotFoundException": { "type": "object", "description": "Ошибка вместо результата: машинный ключ и пояснение для пользователя.", "properties": { "Reason": { "type": "string", "description": "Причина ошибки", "example": "Отзыв не найден" }, "Error": { "type": "string", "description": "Ключ ошибки", "example": "response_not_found_error" } } }, "OperationStatus": { "type": "object", "description": "Статус операции по грузу или отзыву.", "properties": { "Status": { "type": "integer", "description": "Статус операции.\n \n* `0` - Успех\n* `1` - Груз не найден\n* `2` - Груз обновляли или восстанавливали слишком недавно\n* `3` - Нет доступа; для обновления груза сюда же попадает повтор раньше разрешённого интервала\n* `5` - Найден дубликат среди опубликованных грузов\n* `7` - Груз не прошёл проверку полей\n* `8` - Внутренняя ошибка при обработке груза\n* `9` - Отзыв не найден\n* `10` - Не хватает средств на платное размещение\n* `11` - Кошелёк для платного размещения заблокирован\n* `-1` - Незапланированная ошибка", "format": "int32", "example": 0 }, "Message": { "type": "string", "description": "Пояснение к статусу для показа пользователю", "example": "Успешная операция" } } }, "FinalExceptionModelOfBoardsAccessDeniedException": { "type": "object", "description": "Ошибка вместо результата: машинный ключ и пояснение для пользователя.", "properties": { "Reason": { "type": "string", "description": "Причина ошибки", "example": "Следующие площадки не существуют или вы не имеете доступа к ним: 5f1e2d3c4b5a69788796a5b4" }, "Error": { "type": "string", "description": "Ключ ошибки", "example": "boards_access_denied_error" } } }, "EditLoadDto": { "type": "object", "description": "Груз для редактирования.", "required": [ "ContactId1", "Loading", "Unloading", "Cargo", "Transport", "Payment" ], "properties": { "LoadMeta": { "description": "Метаданные публикации: по их идентификатору можно получить все грузы, размещённые одной публикацией", "oneOf": [ { "$ref": "#/components/schemas/LoadMetaView" } ] }, "ContactId1": { "type": "integer", "description": "Идентификатор первого выбранного контакта. dict: GET https://api.ati.su/firms/v1.0/contacts → id.\nСписок всех контактов и их идентификаторы можно получить с помощью [API для работы с фирмами](https://ati.su/developers/api/firms/).\nКонтакт должен быть виден для остальных участников АТИ", "format": "int32", "example": 1234567 }, "ContactId2": { "type": "integer", "description": "Идентификатор второго выбранного контакта, если не выбрано, то null.\nКонтакт должен быть виден для остальных участников АТИ", "format": "int32", "nullable": true, "example": 1234568 }, "Note": { "type": "string", "description": "Примечание к грузу.\nОграничение по длине: 1000 символов", "default": "", "example": "Погрузка с 9 до 18, пропуск заказывать заранее" }, "FirstDate": { "type": "string", "description": "Дата, начиная с которой груз актуален, в формате UTC.\nМинимальное значение равно текущей дате.\nПри значении параметра DateType равным 0, допустимое значение поля - текущая дата.\nПри значении параметра DateType равным 1, допустимое значение поля - от текущей даты до 2 месяцев вперед.\nПри значении параметра DateType равным 2, допустимое значение поля - текущая дата.\nПри значении параметра DateType равным 3, FirstDate должен принимать значение текущей даты или отсутствовать", "format": "date-time", "example": "2026-09-08T00:00:00.000Z" }, "LastDate": { "type": "string", "description": "Дата, после которой груз не актуален, в формате UTC.\nМинимальное значение равно значению параметра FirstDate.\nПри значении параметра DateType равным 0, допустимое значение поля - от текущей даты до 1 дня вперед.\nПри значении параметра DateType равным 1, допустимое значение поля - от даты в параметре FirstDate до 9 дней вперед.\nПри значении параметра DateType равным 2, сервис вычисляет поле как FirstDate + 2 месяца, передаваемое значение игнорируется.\nПри значении параметра DateType равным 3, LastDate автоматически устанавливается на значение + 2 дня от текущей даты, передаваемое значение игнорируется", "format": "date-time", "example": "2026-09-10T00:00:00.000Z" }, "DateType": { "type": "integer", "description": "Тип готовности груза к перевозке, по умолчанию `0`\n \n* `0` - Готов к загрузке\n* `1` - в период с FirstDate по LastDate\n* `2` - постоянно\n* `3` - груза нет, запрос ставки", "format": "int32", "example": 1 }, "PeriodicityId": { "type": "integer", "description": "Периодичность загрузки.\nЕсли параметр DateType не равен 2, PeriodicityId равен 0.\nИначе PeriodicityId может принимать следующие значения:\n \n* `1` - ежедневно\n* `100` - по рабочим дням", "format": "int32", "example": 0 }, "OrderNumber": { "type": "string", "description": "Номер заказа.\nОграничение по длине: 250 символов", "default": "", "example": "ЗК-2026-0917" }, "Krugoreis": { "type": "boolean", "description": "Включён ли кругорейс", "example": false }, "Loading": { "description": "Точка погрузки", "oneOf": [ { "$ref": "#/components/schemas/LoadPointView" } ] }, "ExtraPoints": { "type": "array", "description": "Дополнительные пункты маршрута между погрузкой и выгрузкой.\nМаксимум 15 штук. Может иметь значение `null`", "example": [], "items": { "$ref": "#/components/schemas/LoadExtraPointView" } }, "Unloading": { "description": "Точка выгрузки", "oneOf": [ { "$ref": "#/components/schemas/LoadPointView" } ] }, "Cargo": { "description": "Что везём: наименование, вес, объём, упаковка", "oneOf": [ { "$ref": "#/components/schemas/LoadCargoView" } ] }, "Transport": { "description": "Требования к транспорту: кузов, варианты загрузки и выгрузки", "oneOf": [ { "$ref": "#/components/schemas/LoadTransportView" } ] }, "Payment": { "description": "Условия оплаты и ставка", "oneOf": [ { "$ref": "#/components/schemas/LoadPaymentView" } ] }, "InviteSettings": { "description": "Настройки автоприглашений", "oneOf": [ { "$ref": "#/components/schemas/LoadInviteSettingsView" } ] }, "PriorityView": { "description": "Приоритетный показ", "oneOf": [ { "$ref": "#/components/schemas/BaseLoadPriorityViewView" } ] }, "Stealth": { "description": "Настройки показа груза", "oneOf": [ { "$ref": "#/components/schemas/LoadStealthView" } ] }, "LoadFiles": { "type": "array", "description": "Файлы к грузу.\nПеред добавлением груза с файлом, файл предварительно необходимо загрузить в АТИ-Доки (см. [API для хранения файлов](https://ati.su/developers/api/filestorage/))", "example": [], "items": { "$ref": "#/components/schemas/LoadFileView" } }, "Deal": { "description": "Сделка, в рамках которой размещён груз", "oneOf": [ { "$ref": "#/components/schemas/BaseDealItemView" } ] }, "Boards": { "type": "array", "description": "Площадки публикации. Если не переданы, груз публикуется на общей площадке", "example": [], "items": { "$ref": "#/components/schemas/BaseLoadBoardView" } }, "UnloadFirstDate": { "type": "string", "description": "Дата начала разгрузки, в формате UTC.\nМожет иметь значение `null`.\nМинимальное значение равно текущей дате.\nНе указывается при значении параметра DateType равным `3`", "format": "date-time", "nullable": true, "example": "2026-09-11T00:00:00.000Z" }, "UnloadLastDate": { "type": "string", "description": "Дата окончания разгрузки, в формате UTC.\nМожет иметь значение `null`.\nЕсли нет даты начала разгрузки UnloadFirstDate, должна отсутствовать дата окончания разгрузки UnloadLastDate.\nНе указывается при значении параметра DateType равным `3`", "format": "date-time", "nullable": true, "example": "2026-09-12T00:00:00.000Z" } } }, "AtiDocsCreateLoadDocumentResponse": { "type": "object", "description": "Документ, созданный в ATI.Docs.", "properties": { "Id": { "type": "string", "description": "Идентификатор созданного документа", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "Url": { "type": "string", "description": "Ссылка на документ в АТИ-Доках", "example": "https://d.ati.su/documents/3fa85f64-5717-4562-b3fc-2c963f66afa6" } } }, "LoadPriorityView": { "type": "object", "description": "Параметры приоритетного показа в запросе.", "properties": { "DailyLimit": { "type": "number", "description": "Суточный лимит списания по услуге в атисах\n \n* Должен иметь длину не более 5 символов\n* Не более 2 символов после запятой\n* Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)\n* Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0", "format": "decimal", "example": 500 }, "IsForPayedOnly": { "type": "boolean", "description": "Показывать груз в приоритете только платным пользователям", "example": false }, "OrderLimit": { "type": "number", "description": "Лимит списания на груз в атисах\n \n* Должен иметь длину не более 5 символов\n* Не более 2 символов после запятой\n* Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)\n* Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0", "format": "decimal", "example": 100 }, "ViewRate": { "type": "number", "description": "Ставка за просмотр в атисах\n \n* Кратна 0,5\n* Не меньше минимальной ставки сервиса и не больше баланса фирмы\n* Должна иметь длину не более 5 символов", "format": "decimal", "example": 1.5 }, "MoneySpentPerDay": { "type": "number", "description": "Сколько списано с баланса за груз в текущие сутки. Только для чтения", "format": "decimal", "example": 12 }, "MoneySpentPerOrder": { "type": "number", "description": "Сколько списано с баланса за груз за всё время. Только для чтения", "format": "decimal", "example": 45 } } }, "LoadMetaView": { "type": "object", "description": "Метаданные публикации.", "properties": { "LoadMetaId": { "type": "string", "description": "Идентификатор метаданных", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "MetaData": { "type": "string", "description": "Метаданные.\nМаксимальная длина 1024 символа", "example": "import-2026-09" } } }, "LoadPointView": { "type": "object", "description": "Точка погрузки или выгрузки.", "required": [ "CityId" ], "properties": { "CityId": { "type": "integer", "description": "Идентификатор города загрузки/разгрузки. dict: GET /v1.0/dictionaries/cities → CityId.\ndocs: https://ati.su/developers/api/dictionaries/geo/", "format": "int32", "example": 1 }, "Latitude": { "type": "number", "description": "Широта города загрузки/разгрузки.\nПараметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:\n \n1. указан город Москва;\n2. указан город Санкт-Петербург;\n3. города загрузки и разгрузки совпадают.\n \nЕсли параметр Longitude задан, то необходимо указать и этот параметр.\nДопустимое значение от -90 до 90.", "format": "decimal", "nullable": true, "example": 59.939095 }, "Longitude": { "type": "number", "description": "Долгота города загрузки/разгрузки.\nПараметр должен быть указан, если не указана улица (параметр Street равен null или имеет длину менее 5 символов) и выполняется хотя бы одно из трех условий:\n \n1. указан город Москва;\n2. указан город Санкт-Петербург;\n3. города загрузки и разгрузки совпадают.\n \nЕсли параметр Latitude задан, то необходимо указать и этот параметр.\nДопустимое значение от -180 до 180.", "format": "decimal", "nullable": true, "example": 30.315868 }, "Street": { "type": "string", "description": "Улица или район города загрузки/разгрузки.\nПараметр должен быть указан и иметь длину не менее 5 символов, если не указаны координаты (параметры Longitude и Latitude равны null) и выполняется хотя бы одно из трех условий:\n \n1. указан город Москва;\n2. указан город Санкт-Петербург;\n3. города загрузки и разгрузки совпадают.\n \nЕсли улица указана, её длина от 5 до 200 символов.", "default": "", "example": "ул. Салова, 57" }, "OrganizationId": { "type": "string", "description": "Идентификатор организации из каталога организаций фирмы. Указывается только вместе с AddressId", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "AddressId": { "type": "string", "description": "Идентификатор адреса организации из каталога организаций фирмы. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "TimeStart": { "type": "string", "description": "Время начала загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная.\nНе указывается при значении параметра DateType равным 3.\nНе указывается при значении IsRoundTheClock: true", "format": "date-time", "nullable": true, "example": "2026-09-08T09:00:00.000Z" }, "TimeEnd": { "type": "string", "description": "Время завершения загрузки/разгрузки. В запросе учитываются только часы и минуты, в ответе дата служебная.\nНе указывается при значении параметра DateType равным 3.\nНе указывается при значении IsRoundTheClock: true", "format": "date-time", "nullable": true, "example": "2026-09-08T18:00:00.000Z" }, "IsRoundTheClock": { "type": "boolean", "description": "Круглосуточная загрузка/разгрузка.\nПо умолчанию - false.\nНе указывается при значении параметра DateType равным 3.", "example": false }, "LargeCities": { "type": "array", "description": "Идентификаторы ближайших крупных городов. dict: GET /v1.0/dictionaries/cities → CityId.\ndocs: https://ati.su/developers/api/dictionaries/geo/.\nМаксимальное количество - 10 штук", "example": [ 1 ], "items": { "type": "integer", "format": "int32" } }, "LoadingCargos": { "type": "array", "description": "Позиции груза, которые берут или оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется", "example": [], "items": { "$ref": "#/components/schemas/LoadingCargoView" } } } }, "LoadExtraPointView": { "type": "object", "description": "Дополнительный пункт маршрута.", "required": [ "CityId", "PointType" ], "properties": { "CityId": { "type": "integer", "description": "Идентификатор города. dict: GET /v1.0/dictionaries/cities → CityId.\ndocs: https://ati.su/developers/api/dictionaries/geo/", "format": "int32", "example": 1 }, "PointType": { "type": "integer", "description": "Тип точки:\n \n* `1` - загрузка\n* `2` - разгрузка\n* `3` - таможня\n* `8` - проехать через", "format": "int32", "example": 2 }, "Latitude": { "type": "number", "description": "Широта точки. Допустимое значение от -90 до 90; указывается вместе с долготой", "format": "decimal", "nullable": true, "example": 59.939095 }, "Longitude": { "type": "number", "description": "Долгота точки. Допустимое значение от -180 до 180; указывается вместе с широтой", "format": "decimal", "nullable": true, "example": 30.315868 }, "Street": { "type": "string", "description": "Улица или район. Максимальная длина 200 символов", "example": "пр. Ленина, 10" }, "OrganizationId": { "type": "string", "description": "Организация, принимающая или отгружающая груз в этой точке. Указывается только вместе с AddressId", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "AddressId": { "type": "string", "description": "Адрес точки. Указывается только вместе с OrganizationId; адрес должен принадлежать этой организации", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "OrdinalId": { "type": "integer", "description": "Порядок точки на маршруте. Если у всех точек 0, сервис нумерует их по порядку списка", "format": "int32", "example": 1 }, "IsRoundTheClock": { "type": "boolean", "description": "Загрузка/разгрузка круглосуточно. Только в ответе: при публикации и редактировании значение игнорируется", "example": false }, "LoadingDateStart": { "type": "string", "description": "Дата начала периода загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется", "format": "date-time", "nullable": true, "example": "2026-09-09T00:00:00.000Z" }, "LoadingDateEnd": { "type": "string", "description": "Дата окончания периода загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется", "format": "date-time", "nullable": true, "example": "2026-09-09T00:00:00.000Z" }, "LoadingTimeStart": { "type": "string", "description": "Время начала загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется", "nullable": true, "example": "09:00:00" }, "LoadingTimeEnd": { "type": "string", "description": "Время окончания загрузки/разгрузки. Только в ответе: при публикации и редактировании значение игнорируется", "nullable": true, "example": "18:00:00" }, "LoadingCargos": { "type": "array", "description": "Позиции груза, которые берут в этой точке. Только в ответе: при публикации и редактировании значение игнорируется", "example": [], "items": { "$ref": "#/components/schemas/LoadingCargoView" } }, "UnloadingCargos": { "type": "array", "description": "Позиции груза, которые оставляют в этой точке. Только в ответе: при публикации и редактировании значение игнорируется", "example": [], "items": { "$ref": "#/components/schemas/UnloadingCargoView" } } } }, "LoadCargoView": { "type": "object", "description": "Описание груза: что и сколько везём.", "required": [ "CargoTypeId", "DogruzType" ], "properties": { "Weight": { "type": "number", "description": "Вес груза в тоннах.\nОбязательный параметр, если не задан параметр Volume.\nДопустимое значение 0 либо от 0,001 до 9999, не более 3 знаков после запятой", "format": "double", "example": 20 }, "Volume": { "type": "number", "description": "Объём груза в кубических метрах.\nОбязательный параметр, если не задан параметр Weight. Максимальная длина - 4 символа", "format": "double", "example": 82 }, "ADR": { "type": "integer", "description": "Класс опасности груза по ADR.\nДопустимое значение от 0 до 9, по умолчанию 0. Для CargoTypeId = 53 обязателен ненулевой", "format": "int32", "example": 0 }, "CargoTypeId": { "type": "integer", "description": "Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id.\ndocs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-cargoTypes", "format": "int32", "example": 59 }, "CargoType": { "type": "string", "description": "Наименование груза текстом.\nОбязательный параметр: при `CargoTypeId` = `59` («другое») это и есть наименование груза.\nМаксимальная длина названия - 200 символов.\nВ этом поле запрещено указывать контактную информацию", "default": "", "example": "Стройматериалы" }, "PackType": { "type": "integer", "description": "Идентификатор типа упаковки (навалом, коробки, россыпью), `0` — упаковка не указана. dict: GET /v1.0/dictionaries/packTypes → Id.\ndocs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-packTypes", "format": "int32", "example": 1 }, "PalletCount": { "type": "integer", "description": "Количество упаковок для груза.\nДопустимое значение от 0 до 9999. По умолчанию - 0", "format": "int32", "example": 33 }, "BeltCount": { "type": "integer", "description": "Количество ремней для груза.\nДопустимое значение от 0 до 9999. По умолчанию - 0", "format": "int32", "example": 0 }, "DogruzType": { "type": "integer", "description": "Вариант перевозки:\n \n* `1` - только отдельной машиной\n* `2` - отдельной или догрузом\n* `3` - только догрузом", "format": "int32", "example": 1 }, "SborGruz": { "type": "boolean", "description": "Сборный груз", "example": false }, "Size": { "description": "Параметры размера груза", "oneOf": [ { "$ref": "#/components/schemas/LoadSizeView" } ] } } }, "LoadTransportView": { "type": "object", "description": "Требования к транспорту.", "required": [ "CarType" ], "properties": { "CarType": { "type": "integer", "description": "Битовая маска типов кузова: идентификаторы из справочника — степени двойки, несколько кузовов складываются (1 + 4 = 5). dict: GET /v1.0/dictionaries/carTypes → Id.\ndocs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-carTypes", "format": "int64", "example": 5 }, "CarTypeString": { "type": "string", "description": "Та же битовая маска типов кузова строкой. Только в ответе: в запросе значение игнорируется", "example": "5" }, "LoadingType": { "type": "integer", "description": "Битовая маска вариантов загрузки: идентификаторы из справочника складываются (1 + 2 = 3), 0 — любой. dict: GET /v1.0/dictionaries/loadingTypes → Id.\ndocs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-loadingTypes", "format": "int32", "example": 3 }, "LoadingLogicalOperator": { "type": "string", "description": "Тип условия загрузки:\n \n* `OR` - необходимо, чтобы присутствовал один из способов загрузки\n* `AND` - необходимо, чтобы присутствовали все выбранные типы загрузки", "default": "OR", "example": "OR" }, "UnloadingType": { "type": "integer", "description": "Битовая маска вариантов разгрузки: идентификаторы из справочника складываются (1 + 2 = 3), 0 — любой. dict: GET /v1.0/dictionaries/unloadingTypes → Id.\ndocs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-unloadingTypes", "format": "int32", "example": 3 }, "UnloadingLogicalOperator": { "type": "string", "description": "Тип условия разгрузки:\n \n* `OR` - необходимо, чтобы присутствовал один из способов разгрузки\n* `AND` - необходимо, чтобы присутствовали все выбранные типы разгрузки", "default": "OR", "example": "OR" }, "TrucksQuantity": { "type": "integer", "description": "Количество машин.\nДопустимое значение от 1 до 99. По умолчанию - 1", "format": "int32", "example": 1 }, "TemperatureFrom": { "type": "integer", "description": "Минимальная температура для груза, если выбран тип кузова \"Рефрижератор\", \"Рефрижератор с перегородкой\", \"Рефрижератор-мультирежимный\".\nДопустимое значение от -99 до 999. С другими кузовами должно быть пустым или равным 0", "format": "int32", "nullable": true, "example": -18 }, "TemperatureTo": { "type": "integer", "description": "Максимальная температура для груза, если выбран тип кузова \"Рефрижератор\", \"Рефрижератор с перегородкой\", \"Рефрижератор-мультирежимный\".\nДопустимое значение от -99 до 999. С другими кузовами должно быть пустым или равным 0", "format": "int32", "nullable": true, "example": 4 }, "Stsepka": { "type": "boolean", "description": "Нужна ли сцепка для груза", "example": false }, "Pnevmohod": { "type": "boolean", "description": "Нужен ли пневмоход для груза", "example": false }, "Koniki": { "type": "boolean", "description": "Нужны ли коники для груза", "example": false }, "TIR": { "type": "boolean", "description": "Документы на транспорт, необходимые для провоза этого груза: документы TIR", "example": false }, "CMR": { "type": "boolean", "description": "Документы на транспорт, необходимые для провоза этого груза: документы CMR", "example": false }, "T1": { "type": "boolean", "description": "Документы на транспорт, необходимые для провоза этого груза: документы T1", "example": false }, "SanPassport": { "type": "boolean", "description": "Документы на транспорт, необходимые для провоза этого груза: медкнижка", "example": false }, "IsTracking": { "type": "boolean", "description": "Трекинг через АТИ Водитель", "example": false }, "RequiredCapacity": { "type": "number", "description": "Требуемая грузоподъемность в тоннах.\nДопустимое значение от 0,01 до 9999, не более 3 знаков после запятой", "format": "double", "nullable": true, "example": 20 } } }, "LoadPaymentView": { "type": "object", "description": "Условия оплаты и ставка.", "properties": { "CurrencyId": { "type": "integer", "description": "Идентификатор валюты. dict: GET /v1.0/dictionaries/currencyTypes → Id.\nПо умолчанию - 1. Должен принимать значение 0, если параметр FixedRate равен false.\ndocs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes", "format": "int32", "example": 1 }, "MoneyType": { "type": "integer", "description": "Идентификатор варианта оплаты. dict: GET /v1.0/dictionaries/moneyTypes → Id.\nПо умолчанию - `22`. Должен принимать значение `22`, если параметр `FixedRate` равен `false`.\ndocs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-moneyTypes", "format": "int32", "example": 22 }, "RateSum": { "type": "number", "description": "Ставка для груза.\nОбязательный параметр, если параметр FixedRate равен true и не заданы параметры SumWithNDS или SumWithoutNDS.\nЗначение не меньше 0, максимальная длина 10 символов", "format": "decimal", "example": 85000 }, "SumWithNDS": { "type": "number", "description": "Ставка по безналичному расчёту с НДС.\nОбязательный параметр, если параметр FixedRate равен true и не заданы параметры RateSum или SumWithoutNDS.\nЗначение не меньше 0, максимальная длина 10 символов. Если заданы обе безналичные ставки, SumWithNDS должна быть не меньше SumWithoutNDS.\nЕсли параметр FixedRate равен false, то параметр SumWithNDS должен отсутствовать или быть равным 0", "format": "decimal", "example": 102000 }, "SumWithoutNDS": { "type": "number", "description": "Ставка по безналичному расчёту без НДС.\nОбязательный параметр, если параметр FixedRate равен true и не заданы параметры SumWithNDS или RateSum.\nЗначение не меньше 0, максимальная длина 10 символов.\nЕсли параметр FixedRate равен false, то параметр SumWithoutNDS должен отсутствовать или быть равным 0", "format": "decimal", "example": 85000 }, "PrepayPercent": { "type": "integer", "description": "Процент предоплаты.\nДопустимое значение от 0 до 100. Должен отсутствовать или принимать значение 0, если параметр PrepayPercentEnabled равен false", "format": "int32", "example": 30 }, "PrepayPercentEnabled": { "type": "boolean", "description": "Есть ли предоплата", "example": true }, "PayDays": { "type": "integer", "description": "Через сколько банковских дней оплата.\nДопустимое значение от 0 до 99. Должен отсутствовать или принимать значение 0, если параметр PayDaysEnabled равен false", "format": "int32", "example": 5 }, "PayDaysEnabled": { "type": "boolean", "description": "Включена ли оплата через банковские дни.\nПо умолчанию - false. Не может быть установлен в true, если параметр OnUnloading тоже установлен в true", "example": true }, "FixedRate": { "type": "boolean", "description": "true, если ставка задана, false если запрос ставки.\nПо умолчанию - true. При значении параметра DateType равным 3, должен иметь значение false. Если указано значение True, значение хотя бы одного из полей RateSum, SumWithNDS, SumWithoutNDS должно быть больше или равно 1", "example": true }, "Torg": { "type": "boolean", "description": "Возможен ли торг.\nПо умолчанию - false. Должен быть false, если параметр FixedRate равен false; при торгах с публикацией ставки — true", "example": false }, "DirectContract": { "type": "boolean", "description": "Прямой договор", "example": false }, "InFuel": { "type": "boolean", "description": "Предоплата топливом.\nДолжен быть false, если параметр PrepayPercentEnabled равен false", "example": false }, "OnUnloading": { "type": "boolean", "description": "Оплата на выгрузке", "example": false }, "HideResponses": { "type": "boolean", "description": "Скрыть встречные предложения", "example": false }, "AcceptPaymentTypes": { "type": "integer", "description": "Битовая маска форм оплаты, которые вы готовы принять при запросе ставки: флаги складываются\n \n* `1` - наличные\n* `2` - безналичный расчёт с НДС\n* `4` - безналичный расчёт без НДС\n \nПример: `7` — все три формы. При запросе ставки значение `0` сервис заменяет на `7`; при фиксированной ставке поле не используется", "format": "int32", "example": 0 } } }, "LoadInviteSettingsView": { "type": "object", "description": "Настройки автоприглашений по встречным предложениям.", "properties": { "InviteDelayInSeconds": { "type": "integer", "description": "Время в секундах сбора встречных предложений: через него сервис создаёт приглашение по лучшему предложению.\nОбязателен и больше 0, если объект настроек передан", "format": "int32", "example": 600 }, "InviteDurationInSeconds": { "type": "integer", "description": "Время в секундах действия приглашения.\nОбязателен и больше 0, если объект настроек передан", "format": "int32", "example": 3600 }, "MaxPercentDeviation": { "type": "integer", "description": "На сколько процентов встречное предложение может превышать вашу ставку, чтобы приглашение всё-таки ушло", "format": "int32", "nullable": true, "example": 10 }, "NeedArchiveOnInvite": { "type": "boolean", "description": "Архивировать груз при срабатывании автоматического приглашения", "example": false } } }, "LoadPriorityViewView": { "type": "object", "description": "Параметры приоритетного показа в ответе.", "required": [ "ViewRate" ], "properties": { "DailyLimit": { "type": "number", "description": "Суточный лимит списания по услуге в атисах\n \n* Должен иметь длину не более 5 символов\n* Не более 2 символов после запятой\n* Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)\n* Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0", "format": "decimal", "example": 500 }, "IsForPayedOnly": { "type": "boolean", "description": "Показывать груз в приоритете только платным пользователям", "example": false }, "OrderLimit": { "type": "number", "description": "Лимит списания на груз в атисах\n \n* Должен иметь длину не более 5 символов\n* Не более 2 символов после запятой\n* Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)\n* Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0", "format": "decimal", "example": 100 }, "ViewRate": { "type": "number", "description": "Ставка за просмотр в атисах\n \n* Кратна 0,5\n* Не меньше минимальной ставки сервиса и не больше баланса фирмы\n* Должна иметь длину не более 5 символов", "format": "decimal", "example": 1.5 }, "MoneySpentPerDay": { "type": "number", "description": "Сколько списано с баланса за груз в текущие сутки. Только для чтения", "format": "decimal", "example": 12 }, "MoneySpentPerOrder": { "type": "number", "description": "Сколько списано с баланса за груз за всё время. Только для чтения", "format": "decimal", "example": 45 } } }, "LoadStealthView": { "type": "object", "description": "Ограничения показа груза платной услугой «Стелс»: списания идут с баланса фирмы. Если объект передан, нужен хотя бы один параметр.", "properties": { "ListIdToHide": { "type": "string", "description": "Идентификатор списка фирм, которым груз не показывается. dict: GET https://api.ati.su/scrolls/v1/firms → id.\ndocs: https://ati.su/developers/api/catalogs/firm-lists/", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "FirmRegDateToHide": { "type": "string", "description": "Фирмам, зарегистрированным позже этой даты, груз не показывается", "format": "date-time", "nullable": true, "example": "2024-01-01T00:00:00.000Z" }, "ScoreToHide": { "type": "number", "description": "Минимальное число звёзд фирмы: фирмам с меньшим числом груз не показывается.\nЦелое от 1 до 5; при включённом бронировании на общей площадке — от 2 до 5", "format": "double", "nullable": true, "example": 3 } } }, "LoadFileView": { "type": "object", "description": "Файл, приложенный к грузу. У всех файлов груза идентификаторы задаются одинаково: либо только Id, либо только FileId.", "properties": { "Id": { "type": "string", "description": "Устаревший идентификатор файла, используйте FileId", "format": "guid", "deprecated": true, "x-deprecatedMessage": "Используйте FileId", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "FileId": { "type": "string", "description": "Идентификатор файла, который вернул API хранения файлов при загрузке. dict: POST https://api.ati.su/v1.0/filestorage/files → id.\ndocs: https://ati.su/developers/api/filestorage/", "example": "a1b2c3d4e5f6a7b8c9d0e1f2" }, "FileType": { "type": "integer", "description": "Тип загруженного файла. Всегда `1` — документ", "format": "int32", "example": 1 }, "Attributes": { "type": "integer", "description": "Устаревшее поле, всегда `0`", "format": "int32", "example": 0 }, "Name": { "type": "string", "description": "Имя файла. Только в ответе: приходит из хранилища файлов, в запросе значение игнорируется", "example": "Договор.pdf" }, "Link": { "type": "string", "description": "Ссылка, по которой можно скачать файл. Сервис собирает её из идентификатора файла в хранилище", "example": "https://api.ati.su/gw/plyushkin/v1/a1b2c3d4e5f6a7b8c9d0e1f2" }, "Size": { "type": "integer", "description": "Устаревшее поле, всегда `-1`", "format": "int32", "example": -1 } } }, "DealItemView": { "type": "object", "description": "Сделка по грузу в ответе.", "properties": { "Auction": { "description": "Параметры аукциона", "oneOf": [ { "$ref": "#/components/schemas/AuctionView" } ] } } }, "LoadBoardView": { "type": "object", "description": "Площадка, на которой опубликован груз.", "properties": { "BoardId": { "type": "string", "description": "Идентификатор площадки из 24 символов. Значение общей площадки — a0a0a0a0a0a0a0a0a0a0a0a0", "example": "a0a0a0a0a0a0a0a0a0a0a0a0" }, "PublicationTime": { "type": "string", "description": "Время публикации на площадке.\nУчитывается, если `PublicationOption` равно `6`", "format": "date-time", "nullable": true, "example": "2026-09-08T12:00:00.000Z" }, "IsReservationEnabled": { "type": "boolean", "description": "Разрешено ли бронирование груза на общей площадке.\nУчитывается только для Общей площадки, только при включённом Stealth", "example": false }, "PublicationOption": { "type": "integer", "description": "Параметры публикации груза:\n \n* `0` - сразу\n* `1` - через 15 минут\n* `2` - через 30 минут\n* `3` - через час\n* `4` - через 3 часа\n* `5` - через 6 часов\n* `6` - указать точное время", "format": "int32", "example": 0 }, "IsPublished": { "type": "boolean", "description": "Показывает, что груз уже опубликован на странице", "example": true }, "IsCommonBoard": { "type": "boolean", "description": "Является ли площадка общей", "example": true } } }, "ArchiveReason": { "type": "string", "description": "Причина, по которой груз оказался в архиве.\n \n* `VerticesLoadDelete` - Снят при сквозной передаче груза\n* `StealthStatisticError` - Снят из-за ошибки при подсчёте статистики Стелса\n* `CheckDuplicateComplaints` - Снят при проверке дублирующих жалоб\n* `DeleteContact` - Удалён контакт\n* `DeleteFirm` - Удалена фирма\n* `CleanOldLoadsJob` - Истёк срок актуальности\n* `Unknown` - Причина не определена\n* `System` - Снят системой\n* `Manual` - Снят с публикации владельцем\n* `Complaints` - Снят по жалобам\n* `UnwantedContent` - Снят за недопустимое содержимое\n* `DeleteCsvLoad` - Удалён вместе с CSV-загрузкой\n* `MergeLoadsAfterEdit` - Объединён с другим грузом после редактирования\n* `ContactDoesNotHaveAccessToVirtualPayments` - Снят: у контакта нет права оплачивать услугу со счёта фирмы", "x-enumNames": [ "Unknown", "System", "Manual", "Complaints", "UnwantedContent", "DeleteCsvLoad", "MergeLoadsAfterEdit", "ContactDoesNotHaveAccessToVirtualPayments", "VerticesLoadDelete", "StealthStatisticError", "CheckDuplicateComplaints", "DeleteContact", "DeleteFirm", "CleanOldLoadsJob" ], "enum": [ "Unknown", "System", "Manual", "Complaints", "UnwantedContent", "DeleteCsvLoad", "MergeLoadsAfterEdit", "ContactDoesNotHaveAccessToVirtualPayments", "VerticesLoadDelete", "StealthStatisticError", "CheckDuplicateComplaints", "DeleteContact", "DeleteFirm", "CleanOldLoadsJob" ] }, "LoadAccessDeniedReason": { "type": "integer", "description": "Причина отказа в доступе к грузу.\n \n* `0` - Вы имеете доступ к работе с грузом\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* `13` - У вашего контакта нет доступа к одной или нескольким персональным площадкам, указанным в грузе\n* `14` - У вашего контакта нет доступа к подразделению груза\n* `15` - Ваш контакт должен быть указан первым в грузе\n* `16` - Груз не опубликован ни на одной площадке", "x-enumNames": [ "None", "FirmDoesNotHaveAccess", "LoadReserved", "ActualLoadsLimitExceeded", "LoginAsCommonUser", "ContactDoesNotHaveAccessToCurrentLoad", "LoadHasAuctionFinished", "DealsServiceUnavailable", "PassThroughCopy", "ContactDoesNotHaveAccessToLoadCreation", "ContactDoesNotHaveAccessToVirtualPayments", "ContactCantWorkWithCommonBoards", "ContactCantWorkWithPersonalBoards", "ContactDoesntHaveAccessToAllBoards", "ContactDoesntHaveAccessToLoadDepartment", "ContactMustBeSelectedFirst", "LoadIsNotPublishedOnBoards" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] }, "BaseLoadPriorityViewView": { "type": "object", "description": "Общие параметры приоритетного показа.", "required": [ "ViewRate" ], "properties": { "DailyLimit": { "type": "number", "description": "Суточный лимит списания по услуге в атисах\n \n* Должен иметь длину не более 5 символов\n* Не более 2 символов после запятой\n* Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)\n* Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0", "format": "decimal", "example": 500 }, "IsForPayedOnly": { "type": "boolean", "description": "Показывать груз в приоритете только платным пользователям", "example": false }, "OrderLimit": { "type": "number", "description": "Лимит списания на груз в атисах\n \n* Должен иметь длину не более 5 символов\n* Не более 2 символов после запятой\n* Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)\n* Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0", "format": "decimal", "example": 100 }, "ViewRate": { "type": "number", "description": "Ставка за просмотр в атисах\n \n* Кратна 0,5\n* Не меньше минимальной ставки сервиса и не больше баланса фирмы\n* Должна иметь длину не более 5 символов", "format": "decimal", "example": 1.5 } } }, "BaseDealItemView": { "type": "object", "description": "Сделка по грузу.", "properties": { "Auction": { "description": "Параметры аукциона", "oneOf": [ { "$ref": "#/components/schemas/BaseAuctionView" } ] } } }, "BaseLoadBoardView": { "type": "object", "description": "Площадка для публикации груза.", "properties": { "BoardId": { "type": "string", "description": "Идентификатор площадки из 24 символов. Значение общей площадки — a0a0a0a0a0a0a0a0a0a0a0a0", "example": "a0a0a0a0a0a0a0a0a0a0a0a0" }, "PublicationTime": { "type": "string", "description": "Время публикации на площадке.\nУчитывается, если `PublicationOption` равно `6`", "format": "date-time", "nullable": true, "example": "2026-09-08T12:00:00.000Z" }, "IsReservationEnabled": { "type": "boolean", "description": "Разрешено ли бронирование груза на общей площадке.\nУчитывается только для Общей площадки, только при включённом Stealth", "example": false }, "PublicationOption": { "type": "integer", "description": "Параметры публикации груза:\n \n* `0` - сразу\n* `1` - через 15 минут\n* `2` - через 30 минут\n* `3` - через час\n* `4` - через 3 часа\n* `5` - через 6 часов\n* `6` - указать точное время", "format": "int32", "example": 0 } } }, "ValidationErrorItemView": { "type": "object", "description": "Ошибка проверки одного поля запроса.", "properties": { "property": { "type": "string", "description": "Поле, не прошедшее проверку; вложенные поля через точку", "example": "Cargo.Weight" }, "reason": { "type": "string", "description": "Причина ошибки для показа пользователю", "example": "Максимальная длина для параметра вес - 4 символа" }, "error": { "type": "string", "description": "Ключ нарушенного правила", "example": "length_out_of_range" }, "context": { "description": "Параметры нарушенного правила, если у него есть границы: например, Min и Max", "nullable": true, "example": { "Min": 0, "Max": 4 } } } }, "LoadLimitType": { "type": "integer", "description": "Лимит грузов, который исчерпан.\n \n* `0` - Лимит грузов на общей площадке\n* `1` - Лимит грузов на персональных площадках", "x-enumNames": [ "OnCommonBoard", "OnUserBoard" ], "enum": [ 0, 1 ] }, "CounterOfferSource": { "type": "integer", "description": "Откуда пришло встречное предложение.\n \n* `0` - Неизвестный источник\n* `1` - Встречное предложение из мобильного приложения\n* `2` - Встречное предложение оставил интегратор по Id груза\n* `3` - Встречное предложение оставил интегратор из перехвата грузов\n* `4` - Встречное предложение оставили с поиска грузов\n* `5` - Встречное предложение оставили из перехвата машин\n* `6` - Сквозное встречное предложение, добавлено автоматически", "x-enumNames": [ "Site", "Mobile", "Integrator", "CarrierInterception", "Search", "TruckInterception", "PassThrough" ], "enum": [ 0, 1, 2, 3, 4, 5, 6 ] }, "LoadResponseFirminfo": { "type": "object", "description": "Фирма, оставившая отзыв.", "properties": { "TotalScore": { "type": "number", "description": "Рейтинг фирмы в звёздах", "format": "double", "example": 4.5 }, "Status": { "description": "Статус фирмы в АТИ", "example": 1, "oneOf": [ { "$ref": "#/components/schemas/ati.search-loadsAndDictionaries__FirmStatus" } ] }, "FullFirmName": { "type": "string", "description": "Полное название фирмы", "example": "ООО «Перевозчик»" }, "Contact": { "description": "Контакт фирмы, оставившей отзыв. `null` — чужой отзыв на чужом грузе.\nЕсли контакт скрыт настройками фирмы, приходит общий контакт фирмы с идентификатором 0", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/LoadResponseContactInfo" } ] }, "Inn": { "type": "string", "description": "ИНН фирмы", "example": "7801234567" } } }, "LoadingCargoView": { "type": "object", "description": "Позиция груза, которую берут в точке.", "properties": { "CargoId": { "type": "integer", "description": "Идентификатор позиции груза в точке маршрута", "format": "int32", "example": 1 }, "NameId": { "type": "integer", "description": "Идентификатор наименования груза. dict: GET /v1.0/dictionaries/cargoTypes → Id", "format": "int32", "example": 1 }, "Name": { "type": "string", "description": "Название груза", "example": "Продукты питания" }, "PackagingType": { "type": "integer", "description": "Идентификатор типа упаковки. dict: GET /v1.0/dictionaries/packTypes → Id", "format": "int32", "nullable": true, "example": 1 }, "PackagingQuantity": { "type": "integer", "description": "Количество мест упаковки", "format": "int32", "nullable": true, "example": 20 }, "Weight": { "type": "number", "description": "Вес в тоннах", "format": "double", "nullable": true, "example": 20 }, "Volume": { "type": "number", "description": "Объём в кубических метрах", "format": "double", "nullable": true, "example": 82 }, "Sizes": { "description": "Габариты", "oneOf": [ { "$ref": "#/components/schemas/LoadSize" } ] } } }, "UnloadingCargoView": { "type": "object", "description": "Позиция груза, которую оставляют в точке.", "properties": { "CargoId": { "type": "integer", "description": "Идентификатор позиции груза (CargoId из точки загрузки)", "format": "int32", "example": 1 }, "Weight": { "type": "number", "description": "Вес в тоннах", "format": "double", "nullable": true, "example": 10 }, "Volume": { "type": "number", "description": "Объём в кубических метрах", "format": "double", "nullable": true, "example": 40 }, "PackagingQuantity": { "type": "integer", "description": "Количество выгружаемых мест", "format": "int32", "nullable": true, "example": 10 }, "IsDefinedByTtn": { "type": "boolean", "description": "Выгружаемая часть груза будет определена в ТТН", "example": false } } }, "LoadSizeView": { "type": "object", "description": "Габариты груза.", "properties": { "Length": { "type": "number", "description": "Длина груза в метрах.\nДопустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0", "format": "double", "example": 13.6 }, "Width": { "type": "number", "description": "Ширина груза в метрах.\nДопустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0", "format": "double", "example": 2.45 }, "Height": { "type": "number", "description": "Высота груза в метрах.\nДопустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0", "format": "double", "example": 2.7 }, "Diameter": { "type": "number", "description": "Диаметр груза в метрах.\nДопустимое значение от 0 до 50, не более 2 знаков после запятой. Максимальная длина - 5 символов. По умолчанию - 0", "format": "double", "example": 1.2 }, "LengthHighlight": { "type": "boolean", "description": "Подсвечивать длину как нестандартную", "example": false }, "WidthHighlight": { "type": "boolean", "description": "Выделение красным цветом ширины груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)", "example": false }, "HeightHighlight": { "type": "boolean", "description": "Выделение красным цветом высоты груза (для привлечения внимания перевозчика в случае нестандартных размеров груза)", "example": false } } }, "AuctionView": { "type": "object", "description": "Торги по грузу в ответе.", "required": [ "StartRate", "Currency", "Step", "PaymentType", "TimeToProvideDocuments" ], "properties": { "StartRate": { "type": "number", "description": "Начальная ставка аукциона.\nПараметр должен принимать значение от 1 до 9999999999 (включительно) и содержать не более 10 символов.", "format": "decimal", "example": 50000 }, "Currency": { "type": "integer", "description": "Валюта аукциона. dict: GET /v1.0/dictionaries/currencyTypes → Id.\ndocs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes", "format": "int32", "example": 1 }, "Step": { "type": "number", "description": "Минимальное изменение ставки по аукциону.\nПараметр должен принимать значение от 1 до 9999999999 (включительно), содержать не более 10 символов и не должен превышать половину начальной ставки startRate.", "format": "decimal", "example": 500 }, "PaymentType": { "description": "Тип оплаты в торгах: допустимы только `24` и `25`", "example": 24, "oneOf": [ { "$ref": "#/components/schemas/ati.search-loadsAndDictionaries__AuctionPaymentType" } ] }, "AcceptSecondPayType": { "type": "boolean", "description": "Принимать ставки и со вторым типом оплаты: без НДС при PaymentType = 24, с НДС при PaymentType = 25", "example": false }, "StartDate": { "type": "string", "description": "Время начала аукциона в UTC. Должно быть позже времени начала публикации груза на площадке.", "format": "date-time", "example": "2026-09-08T09:00:00.000Z" }, "EndDate": { "type": "string", "description": "Время окончания аукциона. Необязательное поле, если есть значение в поле Duration", "format": "date-time", "nullable": true, "example": "2026-09-08T12:00:00.000Z" }, "EndDateBoundary": { "type": "string", "description": "Время окончания аукциона \"завершить не позже\". Если указанное время, меньше значения Duration - аукцион заканчивается по времени \"завершить не позже\", если нет автопродления. Время устанавливается в формате UTC.", "format": "date-time", "nullable": true, "example": "2026-09-09T09:00:00.000Z" }, "Nds": { "type": "number", "description": "% НДС, от 1 до 99. Если выбрана опция \"Принимать ставки без НДС\", этот параметр определяет величину процента НДС.", "format": "decimal", "nullable": true, "example": 20 }, "TimeToProvideDocuments": { "type": "number", "description": "Время на отправку заявки перевозчиком (в часах). Время на отправку заявки перевозчику должно быть не больше 24 часов, и не должно превышать 4 символов в длину.", "format": "decimal", "example": 4 }, "AutoRenew": { "type": "boolean", "description": "Нужно ли продлевать торги, если ставка пришла незадолго до окончания", "example": true }, "RenewTime": { "type": "integer", "description": "Время в минутах, на которое сдвигается окончание аукциона при включённом AutoRenew", "format": "int32", "nullable": true, "example": 5 }, "MaxRenewTime": { "type": "integer", "description": "Максимально допустимое время в минутах, на которое можно сдвинуть окончание аукциона при включённом AutoRenew.\nУказывать, если AutoRenew = true. Параметр должен принимать значение от 1 до 999999 (включительно) и содержать не более 6 символов.", "format": "int32", "nullable": true, "example": 30 }, "RaiseBid": { "type": "boolean", "description": "Повысить ставку на Шаг, если нет предложений", "example": false }, "MaxRate": { "type": "number", "description": "Максимально допустимая ставка по аукциону.\nОбязателен при RaiseBid = true. Не меньше суммы StartRate и Step, не больше 9999999999, не более 10 символов.", "format": "decimal", "nullable": true, "example": 60000 }, "RaiseBidInterval": { "type": "integer", "description": "Период увеличения ставки в минутах при отсутствии предложений.\nОбязателен при RaiseBid = true: от 1 минуты и меньше Duration. При StartSinceFirstBet = true верхнее ограничение не действует.", "format": "int32", "nullable": true, "example": 30 }, "ResponseInMinutes": { "type": "integer", "description": "Через сколько минут после начала торгов принимать встречные предложения:\n \n* `0` - сразу\n* `N` - через N минут; допустимо любое значение от 0 и меньше Duration\n* `null` - не принимать\n \nЕсли AcceptCounterOffersOnlyBeforeFirstBet = true, то встречные предложения будут приниматься только до 1-й ставки", "format": "int32", "nullable": true, "example": 15 }, "Duration": { "type": "integer", "description": "Длительность торгов в минутах: целое число больше 0.\nОкончание торгов не может быть позже времени актуальности груза LastDate.\nЕсли не указана, вычисляется как разница EndDate и StartDate, при этом StartSinceFirstBet игнорируется", "format": "int32", "example": 180 }, "StartSinceFirstBet": { "type": "boolean", "description": "Флаг, определяющий, что обратный отсчёт до окончания аукциона начинается только после первой ставки.", "example": false }, "AuctionRestartParameters": { "description": "Параметры перезапуска аукциона.\nЕсли объект не передан, действуют значения по умолчанию: до 3 автоматических перевыборов победителя, после исчерпания груз публикуется со ставкой", "oneOf": [ { "$ref": "#/components/schemas/AuctionRestartParametersView" } ] }, "AcceptCounterOffersOnlyBeforeFirstBet": { "type": "boolean", "description": "Принимать встречные предложения только до первой ставки", "example": false }, "WinnerCriterion": { "description": "Критерий выбора победителя торгов", "example": 0, "oneOf": [ { "$ref": "#/components/schemas/ati.search-loadsAndDictionaries__WinnerCriteria" } ] }, "Source": { "description": "Площадка, на которой идут торги. Значение выставляет система: передавайте `0` или не передавайте поле", "example": 0, "oneOf": [ { "$ref": "#/components/schemas/AuctionSource" } ] }, "AuctionId": { "type": "string", "description": "Идентификатор аукциона", "format": "guid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "LoadId": { "type": "string", "description": "Идентификатор груза, для которого активен аукцион", "format": "guid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "ActiveDealId": { "type": "string", "description": "Идентификатор сделки, привязанной к аукциону", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "State": { "description": "Статус аукциона", "example": 1, "oneOf": [ { "$ref": "#/components/schemas/ati.search-loadsAndDictionaries__AuctionState" } ] }, "Finished": { "type": "boolean", "description": "Завершён ли аукцион", "example": false }, "WinDate": { "type": "string", "description": "Время, когда одна из ставок в AuctionRates стала победной", "format": "date-time", "nullable": true, "example": "2026-09-08T12:05:00.000Z" }, "AuctionRates": { "type": "array", "description": "Список ставок по аукциону", "example": [], "items": { "$ref": "#/components/schemas/AuctionRateView" } } } }, "BaseAuctionView": { "type": "object", "description": "Параметры торгов по грузу.", "required": [ "StartRate", "Currency", "Step", "PaymentType", "TimeToProvideDocuments" ], "properties": { "StartRate": { "type": "number", "description": "Начальная ставка аукциона.\nПараметр должен принимать значение от 1 до 9999999999 (включительно) и содержать не более 10 символов.", "format": "decimal", "example": 50000 }, "Currency": { "type": "integer", "description": "Валюта аукциона. dict: GET /v1.0/dictionaries/currencyTypes → Id.\ndocs: https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes", "format": "int32", "example": 1 }, "Step": { "type": "number", "description": "Минимальное изменение ставки по аукциону.\nПараметр должен принимать значение от 1 до 9999999999 (включительно), содержать не более 10 символов и не должен превышать половину начальной ставки startRate.", "format": "decimal", "example": 500 }, "PaymentType": { "description": "Тип оплаты в торгах: допустимы только `24` и `25`", "example": 24, "oneOf": [ { "$ref": "#/components/schemas/ati.search-loadsAndDictionaries__AuctionPaymentType" } ] }, "AcceptSecondPayType": { "type": "boolean", "description": "Принимать ставки и со вторым типом оплаты: без НДС при PaymentType = 24, с НДС при PaymentType = 25", "example": false }, "StartDate": { "type": "string", "description": "Время начала аукциона в UTC. Должно быть позже времени начала публикации груза на площадке.", "format": "date-time", "example": "2026-09-08T09:00:00.000Z" }, "EndDate": { "type": "string", "description": "Время окончания аукциона. Необязательное поле, если есть значение в поле Duration", "format": "date-time", "nullable": true, "example": "2026-09-08T12:00:00.000Z" }, "EndDateBoundary": { "type": "string", "description": "Время окончания аукциона \"завершить не позже\". Если указанное время, меньше значения Duration - аукцион заканчивается по времени \"завершить не позже\", если нет автопродления. Время устанавливается в формате UTC.", "format": "date-time", "nullable": true, "example": "2026-09-09T09:00:00.000Z" }, "Nds": { "type": "number", "description": "% НДС, от 1 до 99. Если выбрана опция \"Принимать ставки без НДС\", этот параметр определяет величину процента НДС.", "format": "decimal", "nullable": true, "example": 20 }, "TimeToProvideDocuments": { "type": "number", "description": "Время на отправку заявки перевозчиком (в часах). Время на отправку заявки перевозчику должно быть не больше 24 часов, и не должно превышать 4 символов в длину.", "format": "decimal", "example": 4 }, "AutoRenew": { "type": "boolean", "description": "Нужно ли продлевать торги, если ставка пришла незадолго до окончания", "example": true }, "RenewTime": { "type": "integer", "description": "Время в минутах, на которое сдвигается окончание аукциона при включённом AutoRenew", "format": "int32", "nullable": true, "example": 5 }, "MaxRenewTime": { "type": "integer", "description": "Максимально допустимое время в минутах, на которое можно сдвинуть окончание аукциона при включённом AutoRenew.\nУказывать, если AutoRenew = true. Параметр должен принимать значение от 1 до 999999 (включительно) и содержать не более 6 символов.", "format": "int32", "nullable": true, "example": 30 }, "RaiseBid": { "type": "boolean", "description": "Повысить ставку на Шаг, если нет предложений", "example": false }, "MaxRate": { "type": "number", "description": "Максимально допустимая ставка по аукциону.\nОбязателен при RaiseBid = true. Не меньше суммы StartRate и Step, не больше 9999999999, не более 10 символов.", "format": "decimal", "nullable": true, "example": 60000 }, "RaiseBidInterval": { "type": "integer", "description": "Период увеличения ставки в минутах при отсутствии предложений.\nОбязателен при RaiseBid = true: от 1 минуты и меньше Duration. При StartSinceFirstBet = true верхнее ограничение не действует.", "format": "int32", "nullable": true, "example": 30 }, "ResponseInMinutes": { "type": "integer", "description": "Через сколько минут после начала торгов принимать встречные предложения:\n \n* `0` - сразу\n* `N` - через N минут; допустимо любое значение от 0 и меньше Duration\n* `null` - не принимать\n \nЕсли AcceptCounterOffersOnlyBeforeFirstBet = true, то встречные предложения будут приниматься только до 1-й ставки", "format": "int32", "nullable": true, "example": 15 }, "Duration": { "type": "integer", "description": "Длительность торгов в минутах: целое число больше 0.\nОкончание торгов не может быть позже времени актуальности груза LastDate.\nЕсли не указана, вычисляется как разница EndDate и StartDate, при этом StartSinceFirstBet игнорируется", "format": "int32", "example": 180 }, "StartSinceFirstBet": { "type": "boolean", "description": "Флаг, определяющий, что обратный отсчёт до окончания аукциона начинается только после первой ставки.", "example": false }, "AuctionRestartParameters": { "description": "Параметры перезапуска аукциона.\nЕсли объект не передан, действуют значения по умолчанию: до 3 автоматических перевыборов победителя, после исчерпания груз публикуется со ставкой", "oneOf": [ { "$ref": "#/components/schemas/AuctionRestartParametersView" } ] }, "AcceptCounterOffersOnlyBeforeFirstBet": { "type": "boolean", "description": "Принимать встречные предложения только до первой ставки", "example": false }, "WinnerCriterion": { "description": "Критерий выбора победителя торгов", "example": 0, "oneOf": [ { "$ref": "#/components/schemas/ati.search-loadsAndDictionaries__WinnerCriteria" } ] }, "Source": { "description": "Площадка, на которой идут торги. Значение выставляет система: передавайте `0` или не передавайте поле", "example": 0, "oneOf": [ { "$ref": "#/components/schemas/AuctionSource" } ] } } }, "ati.search-loadsAndDictionaries__FirmStatus": { "type": "integer", "description": "Статус фирмы по цвету звёзд.\n \n* `0` - Серый\n* `1` - Зелёный\n* `2` - Жёлтый\n* `3` - Красный\n* `4` - Партнёр АТИ\n* `5` - Сотрудник АТИ\n* `6` - Гос. органы\n* `7` - ОДКС", "x-enumNames": [ "Gray", "Green", "Yellow", "Red", "AtiPartner", "AtiEmployee", "GosOrgan", "Odks" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ] }, "LoadResponseContactInfo": { "type": "object", "description": "Контакт фирмы, оставившей отзыв.", "properties": { "Id": { "type": "integer", "description": "Идентификатор контакта в фирме", "format": "int32", "example": 1 }, "Name": { "type": "string", "description": "Имя контакта", "example": "Иван Петров" }, "Telephone": { "type": "string", "description": "Телефон", "example": "+7 812 123-45-67" }, "Email": { "type": "string", "description": "Электронная почта", "example": "ivan@example.com" }, "Icq": { "type": "string", "description": "Аккаунт ICQ", "example": "123456789" }, "Mobile": { "type": "string", "description": "Мобильный телефон", "example": "+7 911 123-45-67" }, "MobileOperator": { "type": "string", "description": "Мобильный оператор", "example": "МТС" }, "SkypeName": { "type": "string", "description": "Аккаунт Skype", "example": "ivan.petrov" }, "CityId": { "type": "integer", "description": "Идентификатор города контакта. dict: GET /v1.0/dictionaries/cities → CityId.\ndocs: https://ati.su/developers/api/dictionaries/geo/", "format": "int32", "nullable": true, "example": 1 }, "Location": { "description": "Информация о местоположении фирмы", "oneOf": [ { "$ref": "#/components/schemas/FirmServiceCity" } ] } } }, "LoadSize": { "type": "object", "description": "Габариты позиции груза.", "properties": { "Length": { "type": "number", "description": "Длина в метрах", "format": "double", "example": 13.6 }, "Width": { "type": "number", "description": "Ширина в метрах", "format": "double", "example": 2.45 }, "Height": { "type": "number", "description": "Высота в метрах", "format": "double", "example": 2.7 }, "Diameter": { "type": "number", "description": "Диаметр в метрах, если груз круглого сечения", "format": "double", "example": 1.2 }, "LengthHighlight": { "type": "boolean", "description": "Подсвечивать длину как нестандартную", "example": false }, "WidthHighlight": { "type": "boolean", "description": "Подсвечивать ли ширину в интерфейсе", "example": false }, "HeightHighlight": { "type": "boolean", "description": "Подсвечивать ли высоту в интерфейсе", "example": false } } }, "ati.search-loadsAndDictionaries__AuctionPaymentType": { "type": "integer", "description": "Тип оплаты.\n \n* `1` - Наличные\n* `22` - Любая\n* `23` - На карту\n* `24` - Безналичный расчёт с НДС\n* `25` - Безналичный расчёт без НДС", "x-enumNames": [ "Cash", "Any", "OnCard", "CashlessWithNds", "CashlessWithoutNds" ], "enum": [ 1, 22, 23, 24, 25 ] }, "AuctionRestartParametersView": { "type": "object", "description": "Параметры перезапуска торгов.", "properties": { "AuctionFinishAction": { "description": "Действие после исчерпания перезапусков", "example": 3, "oneOf": [ { "$ref": "#/components/schemas/ati.search-loadsAndDictionaries__AuctionFinishAction" } ] }, "InitRestartCount": { "type": "integer", "description": "Количество перезапусков Торгов, от 0 до 3 включительно.\nЕсли параметр не передать, по умолчанию 0", "format": "int32", "example": 1 }, "InitChangeWinnerCount": { "type": "integer", "description": "Сколько раз выбирать следующего победителя с лучшей ставкой, если предыдущий отказался, от 0 до 3 включительно.\nВ переданном объекте параметров по умолчанию 0; если сам объект не передан, действует значение 3", "format": "int32", "example": 1 }, "DurationAfterRestart": { "type": "integer", "description": "Длительность торгов в минутах после перезапуска.\nНеобязательное поле, если его не передавать, то торги будут перезапущены с изначальной длительностью (поле Duration в структуре Аукцион). Однако если в структуре Аукцион заполнено поле EndDateBoundary и поле InitRestartCount имеет значение больше 0, то DurationAfterRestart становится обязательным", "format": "int32", "nullable": true, "example": 120 }, "RateIncrease": { "type": "number", "description": "Повышение ставки при перезапуске", "format": "decimal", "nullable": true, "example": 500 }, "RateIncreaseOption": { "type": "integer", "description": "Единица повышения ставки при перезапуске:\n \n* `1` - в валюте\n* `2` - в процентах", "format": "int32", "nullable": true, "example": 1 } } }, "ati.search-loadsAndDictionaries__WinnerCriteria": { "type": "integer", "description": "Критерий победы в аукционе.\n \n* `0` - Выбор победителя происходит автоматически по лучшей ставке\n* `1` - Выбор победителя происходит по ставке и дате загрузки. Если нет лучшей ставки с лучшей датой - требуется выбор победителя вручную", "x-enumNames": [ "Rate", "RateAndLoadingDate" ], "enum": [ 0, 1 ] }, "AuctionSource": { "type": "integer", "description": "Площадка, на которой идут торги по грузу.\n \n* `0` - Торги в АТИ\n* `2` - Торги в Atrucks", "x-enumNames": [ "Ati", "Atrucks" ], "enum": [ 0, 2 ] }, "ati.search-loadsAndDictionaries__AuctionState": { "type": "integer", "description": "Статус аукциона.\n \n* `-100` - Не удалось определить состояние аукциона\n* `-14` - Аукцион отменен руками грузовладельца\n* `-13` - Аукцион удален, т.к. расторгнут заказ\n* `-12` - Аукцион без ставок завершен\n* `-11` - Аукцион удален автоматически\n* `-10` - Аукцион удален т.к. сделка завершена\n* `-9` - Аукцион удален\n* `-8` - При включенном копировании грузов: ожидается действие от экспедитора в случае, когда заказ с победителем отменен, других участников нет\n* `-7` - При включенном копировании грузов:ожидается действие с торгами от экспедитора в случае, когда заказ с победителем отменен и есть потенциальный победитель\n* `-6` - При включенном копировании грузов: торги завершены, экспедитор не является победителем\n* `-5` - Одна ставка лучшая по цене, другая по дате\n* `-4` - Закончился, но победитель вовремя не взял груз и при этом есть еще возможные победители\n* `-3` - Закончился, но победитель вовремя не взял груз и при этом он единственный возможный победитель\n* `-2` - Закончился, ждем когда победитель возьмет груз\n* `-1` - Закончился, ставок нет\n* `0` - Идет, ставок нет\n* `1` - Идет (уже есть валидные ставки)", "x-enumNames": [ "OnAndNoRates", "OnAndHasRates", "UnknownState", "DeclinedByOwner", "DeletedByDeclinedOrder", "DeletedWithoutRates", "DeletedByAutoDecline", "DeletedByDealFinished", "Deleted", "FinishedWithoutOtherBetsAndNeedChooseAction", "FinishedWithOtherBetsAndNeedChooseAction", "FinishedWithWinnerFromOtherAuction", "FinishedWithIncomparableRates", "FinishedAndNoDocsButHasOtherPossibleWinners", "FinishedAndNoDocsFromSingleWinner", "FinishedAndAwaitingDocs", "FinishedAndNoRates" ], "enum": [ 0, 1, -100, -14, -13, -12, -11, -10, -9, -8, -7, -6, -5, -4, -3, -2, -1 ] }, "AuctionRateView": { "type": "object", "description": "Ставка в торгах.", "properties": { "AuctionRateId": { "type": "string", "description": "Идентификатор ставки", "format": "guid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "AddedAt": { "type": "string", "description": "Когда сделана ставка", "format": "date-time", "example": "2026-09-08T10:15:30.000Z" }, "RateFirm": { "description": "Фирма, сделавшая ставку", "oneOf": [ { "$ref": "#/components/schemas/FirmStarsInfoView" } ] }, "Rate": { "type": "number", "description": "Ставка на груз, которую поставил пользователь", "format": "decimal", "example": 48000 }, "State": { "description": "Статус ставки. Коды описаны в AuctionRateState", "example": 0, "oneOf": [ { "$ref": "#/components/schemas/ati.search-loadsAndDictionaries__AuctionRateState" } ] }, "LoadingDate": { "type": "string", "description": "Ближайшая возможная для перевозчика дата загрузки.\nИспользуется только в аукционах с критерием победы по ставке и дате загрузки", "format": "date-time", "nullable": true, "example": "2026-09-09T00:00:00.000Z" }, "FirmId": { "type": "integer", "description": "Идентификатор фирмы, сделавшей ставку", "format": "int32", "example": 7654321 }, "ContactId": { "type": "integer", "description": "Идентификатор контакта, сделавшего ставку", "format": "int32", "example": 0 } } }, "FirmServiceCity": { "type": "object", "description": "Город местонахождения фирмы.", "properties": { "CityId": { "type": "integer", "description": "Идентификатор города. dict: GET /v1.0/dictionaries/cities → CityId.\ndocs: https://ati.su/developers/api/dictionaries/geo/", "format": "int32", "example": 1 }, "RegionId": { "type": "integer", "description": "Идентификатор региона. dict: GET /v1.0/dictionaries/regions → Id.\ndocs: https://ati.su/developers/api/dictionaries/geo/", "format": "int32", "nullable": true, "example": 153 }, "CountryId": { "type": "integer", "description": "Идентификатор страны. dict: GET /v1.0/dictionaries/countries → Id.\ndocs: https://ati.su/developers/api/dictionaries/geo/", "format": "int32", "nullable": true, "example": 1 }, "FullName": { "type": "string", "description": "Город, регион и страна через запятую", "example": "Санкт-Петербург, Санкт-Петербург (регион), Россия" }, "ShortName": { "type": "string", "description": "Город, регион (если город не областной центр) и код страны (если не Россия)", "example": "Санкт-Петербург" }, "IsRegionalCenter": { "type": "boolean", "description": "Является ли город региональным центром", "example": true }, "CitySize": { "type": "integer", "description": "Размер города по числу жителей\n \n* `0` - не определён\n* `1` - до 10 000\n* `2` - от 10 000 до 50 000\n* `3` - от 50 000 до 100 000\n* `4` - от 100 000 до 500 000\n* `5` - от 500 000 до 1 000 000\n* `6` - свыше 1 000 000", "format": "int32", "example": 6 }, "FiasId": { "type": "string", "description": "Идентификатор города в базе ФИАС", "format": "guid", "nullable": true, "example": "c2deb16a-0330-4f05-821f-1d09c93331e6" }, "CityName": { "type": "string", "description": "Название города", "example": "Санкт-Петербург" }, "RegionName": { "type": "string", "description": "Название региона", "example": "Санкт-Петербург (регион)" }, "CountryName": { "type": "string", "description": "Название страны", "example": "Россия" }, "CountryCodeName": { "type": "string", "description": "Трёхбуквенный код страны, как InterShortName в справочнике стран", "example": "RUS" } } }, "ati.search-loadsAndDictionaries__AuctionFinishAction": { "type": "integer", "description": "Действие после того, как все попытки перезапуска и выбора нового победителя торгов исчерпаны.\n \n* `1` - Опубликовать груз со ставкой. В грузе должна быть указана ставка (SumWithNDS, SumWithoutNDS, RateSum)\n* `2` - Опубликовать груз с запросом ставки, возможные типы оплаты будут взяты из поля AcceptPaymentTypes в грузе.\n* `3` - Перенести груз в архив", "x-enumNames": [ "PublishLoad", "PublishLoadWithRateRequest", "DeleteLoad" ], "enum": [ 1, 2, 3 ] }, "FirmStarsInfoView": { "type": "object", "description": "Фирма-участник торгов: рейтинг, статус и контакт.", "properties": { "Score": { "type": "number", "description": "Рейтинг фирмы в звёздах", "format": "double", "example": 4.5 }, "Status": { "description": "Статус фирмы в АТИ. Коды описаны в FirmStatus", "example": 1, "oneOf": [ { "$ref": "#/components/schemas/ati.search-loadsAndDictionaries__FirmStatus" } ] }, "Name": { "type": "string", "description": "Имя фирмы", "example": "ООО «Перевозчик»" }, "ContactName": { "type": "string", "description": "Имя контакта", "example": "Иван Петров" }, "AtiId": { "type": "string", "description": "Идентификатор фирмы в АТИ", "example": "1234567" } } }, "ati.search-loadsAndDictionaries__AuctionRateState": { "type": "integer", "description": "Статус ставки.\n \n* `-8` - Грузовладелец отклонил документ\n* `-7` - Победитель отклонил документ\n* `-6` - Победитель отменил сделку\n* `-5` - Грузовладелец отменил сделку\n* `-4` - Победитель отказался, теперь его нельзя выбрать больше в качестве победителя\n* `-3` - Бывший победитель\n* `-2` - Перевозчик отказался от участия\n* `-1` - Предложение отклонил грузовладелец/перевозчик\n* `0` - Непобедная ставка при завершении торгов\n* `1` - Победная ставка в аукционе", "x-enumNames": [ "Undecided", "Winner", "CargoOwnerDeclineDocument", "WinnerDeclineDocument", "WinnerRefuseDeal", "CargoOwnerRefuseDeal", "WinnerRefused", "ExWinner", "Refused", "Loser" ], "enum": [ 0, 1, -8, -7, -6, -5, -4, -3, -2, -1 ] }, "claim_challenge_statusesResponse": { "type": "array", "items": { "$ref": "#/components/schemas/claim_challenge_statusesItem" }, "description": "Статусы оспоренности претензии: заявил ли ответчик несогласие с претензией по существу.", "example": [ { "dictionary_item_id": 1, "attributes": { "name": "Не оспорена" } } ] }, "claim_connection_statusesResponse": { "type": "array", "items": { "$ref": "#/components/schemas/claim_connection_statusesItem" }, "description": "Статусы связи ответчика по претензии с юр. лицом, указанным в её документах: подтверждена ли связь и на каком основании.", "example": [ { "dictionary_item_id": 1, "attributes": { "name": "Не подтверждена" } } ] }, "claim_digital_document_statusesResponse": { "type": "array", "items": { "$ref": "#/components/schemas/claim_digital_document_statusesItem" }, "description": "Состояния проверки электронного документа претензии.", "example": [ { "dictionary_item_id": 1, "attributes": { "name": "Проверка пройдена" } } ] }, "claim_doc_statusesResponse": { "type": "array", "items": { "$ref": "#/components/schemas/claim_doc_statusesItem" }, "description": "Статусы отдельного документа претензии: проверен ли документ модератором ATI.SU.", "example": [ { "dictionary_item_id": 1, "attributes": { "name": "Документ проверен" } } ] }, "claim_doc_typesResponse": { "type": "array", "items": { "$ref": "#/components/schemas/claim_doc_typesItem" }, "description": "Типы документов, которые прикладываются к претензии: договор, заявка, транспортная накладная, акт и прочие.", "example": [ { "dictionary_item_id": 1, "attributes": { "name": "ТН (Транспортная накладная)" } } ] }, "claim_draft_statusesResponse": { "type": "array", "items": { "$ref": "#/components/schemas/claim_draft_statusesItem" }, "description": "Состояния черновика претензии, поданной с электронными документами: идёт ли по нему проверка и чем она закончилась.", "example": [ { "dictionary_item_id": 1, "attributes": { "name": "Проверка пройдена, черновик материализован в претензию" } } ] }, "claim_for_typesResponse": { "type": "array", "items": { "$ref": "#/components/schemas/claim_for_typesItem" }, "description": "Сторона, к которой выставлена претензия: заказчик или исполнитель перевозки.", "example": [ { "dictionary_item_id": 1, "attributes": { "name": "К заказчику" } } ] }, "claim_levelsResponse": { "type": "array", "items": { "$ref": "#/components/schemas/claim_levelsItem" }, "description": "Уровни претензии: лайт — поданная по минимальному комплекту документов, про — по полному комплекту.", "example": [ { "dictionary_item_id": 1, "attributes": { "name": "Претензия-про" } } ] }, "claim_moderator_statusesResponse": { "type": "array", "items": { "$ref": "#/components/schemas/claim_moderator_statusesItem" }, "description": "Статусы модерации претензии: проверил ли претензию модератор ATI.SU и с каким результатом.", "example": [ { "dictionary_item_id": 1, "attributes": { "name": "Проверена модератором" } } ] }, "claim_rolesResponse": { "type": "array", "items": { "$ref": "#/components/schemas/claim_rolesItem" }, "description": "Роли участника претензии: истец — тот, кто выставил претензию, ответчик — тот, кому она выставлена.", "example": [ { "dictionary_item_id": 1, "attributes": { "name": "Истец" } } ] }, "claim_sort_typesResponse": { "type": "array", "items": { "$ref": "#/components/schemas/claim_sort_typesItem" }, "description": "Поля, по которым упорядочивается список претензий: дата, сумма, имя стороны.", "example": [ { "dictionary_item_id": 1, "attributes": { "name": "По дате" } } ] }, "claim_statusesResponse": { "type": "array", "items": { "$ref": "#/components/schemas/claim_statusesItem" }, "description": "Статусы претензии: опубликована, отклонена, урегулирована и прочие состояния её жизненного цикла.", "example": [ { "dictionary_item_id": 1, "attributes": { "name": "Опубликована" } } ] }, "claim_typesResponse": { "type": "array", "items": { "$ref": "#/components/schemas/claim_typesItem" }, "description": "Типы претензий ATI.SU: за что участник выставляет претензию контрагенту — неоплата, простой транспорта, утрата груза и прочие основания.", "example": [ { "dictionary_item_id": 1, "attributes": { "claim_levels": "0,1", "claim_name": "Опоздание на загрузку/выгрузку (просрочка в доставке груза)", "for_type": "2" } } ] }, "firm_documents_templateResponse": { "type": "array", "items": { "$ref": "#/components/schemas/firm_documents_templateItem" }, "description": "Типы документов фирмы: свидетельства, лицензии, договоры и другие документы, которые фирма прикладывает к своему профилю", "example": [ { "dictionary_item_id": 1, "attributes": { "template_name": "Лицензия" } } ] }, "claim_challenge_statusesItem": { "type": "object", "properties": { "dictionary_item_id": { "type": "integer", "description": "Идентификатор элемента словаря", "example": 1 }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/claim_challenge_statusesAttributes" } ], "description": "Поля элемента: ключ — имя поля, значение — строка" } }, "description": "Элемент словаря claim_challenge_statuses" }, "claim_connection_statusesItem": { "type": "object", "properties": { "dictionary_item_id": { "type": "integer", "description": "Идентификатор элемента словаря", "example": 1 }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/claim_connection_statusesAttributes" } ], "description": "Поля элемента: ключ — имя поля, значение — строка" } }, "description": "Элемент словаря claim_connection_statuses" }, "claim_digital_document_statusesItem": { "type": "object", "properties": { "dictionary_item_id": { "type": "integer", "description": "Идентификатор элемента словаря", "example": 1 }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/claim_digital_document_statusesAttributes" } ], "description": "Поля элемента: ключ — имя поля, значение — строка" } }, "description": "Элемент словаря claim_digital_document_statuses" }, "claim_doc_statusesItem": { "type": "object", "properties": { "dictionary_item_id": { "type": "integer", "description": "Идентификатор элемента словаря", "example": 1 }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/claim_doc_statusesAttributes" } ], "description": "Поля элемента: ключ — имя поля, значение — строка" } }, "description": "Элемент словаря claim_doc_statuses" }, "claim_doc_typesItem": { "type": "object", "properties": { "dictionary_item_id": { "type": "integer", "description": "Идентификатор элемента словаря", "example": 1 }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/claim_doc_typesAttributes" } ], "description": "Поля элемента: ключ — имя поля, значение — строка" } }, "description": "Элемент словаря claim_doc_types" }, "claim_draft_statusesItem": { "type": "object", "properties": { "dictionary_item_id": { "type": "integer", "description": "Идентификатор элемента словаря", "example": 1 }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/claim_draft_statusesAttributes" } ], "description": "Поля элемента: ключ — имя поля, значение — строка" } }, "description": "Элемент словаря claim_draft_statuses" }, "claim_for_typesItem": { "type": "object", "properties": { "dictionary_item_id": { "type": "integer", "description": "Идентификатор элемента словаря", "example": 1 }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/claim_for_typesAttributes" } ], "description": "Поля элемента: ключ — имя поля, значение — строка" } }, "description": "Элемент словаря claim_for_types" }, "claim_levelsItem": { "type": "object", "properties": { "dictionary_item_id": { "type": "integer", "description": "Идентификатор элемента словаря", "example": 1 }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/claim_levelsAttributes" } ], "description": "Поля элемента: ключ — имя поля, значение — строка" } }, "description": "Элемент словаря claim_levels" }, "claim_moderator_statusesItem": { "type": "object", "properties": { "dictionary_item_id": { "type": "integer", "description": "Идентификатор элемента словаря", "example": 1 }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/claim_moderator_statusesAttributes" } ], "description": "Поля элемента: ключ — имя поля, значение — строка" } }, "description": "Элемент словаря claim_moderator_statuses" }, "claim_rolesItem": { "type": "object", "properties": { "dictionary_item_id": { "type": "integer", "description": "Идентификатор элемента словаря", "example": 1 }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/claim_rolesAttributes" } ], "description": "Поля элемента: ключ — имя поля, значение — строка" } }, "description": "Элемент словаря claim_roles" }, "claim_sort_typesItem": { "type": "object", "properties": { "dictionary_item_id": { "type": "integer", "description": "Идентификатор элемента словаря", "example": 1 }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/claim_sort_typesAttributes" } ], "description": "Поля элемента: ключ — имя поля, значение — строка" } }, "description": "Элемент словаря claim_sort_types" }, "claim_statusesItem": { "type": "object", "properties": { "dictionary_item_id": { "type": "integer", "description": "Идентификатор элемента словаря", "example": 1 }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/claim_statusesAttributes" } ], "description": "Поля элемента: ключ — имя поля, значение — строка" } }, "description": "Элемент словаря claim_statuses" }, "claim_typesItem": { "type": "object", "properties": { "dictionary_item_id": { "type": "integer", "description": "Идентификатор элемента словаря", "example": 1 }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/claim_typesAttributes" } ], "description": "Поля элемента: ключ — имя поля, значение — строка" } }, "description": "Элемент словаря claim_types" }, "firm_documents_templateItem": { "type": "object", "properties": { "dictionary_item_id": { "type": "integer", "description": "Идентификатор элемента словаря", "example": 1 }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/firm_documents_templateAttributes" } ], "description": "Поля элемента: ключ — имя поля, значение — строка" } }, "description": "Элемент словаря firm_documents_template" }, "claim_challenge_statusesAttributes": { "type": "object", "properties": { "name": { "type": "string", "description": "Название статуса оспоренности претензии.", "example": "Не оспорена" } }, "description": "Поля элемента словаря claim_challenge_statuses" }, "claim_connection_statusesAttributes": { "type": "object", "properties": { "name": { "type": "string", "description": "Название статуса связи ответчика с фирмой по документам.", "example": "Не подтверждена" } }, "description": "Поля элемента словаря claim_connection_statuses" }, "claim_digital_document_statusesAttributes": { "type": "object", "properties": { "name": { "type": "string", "description": "Название состояния проверки электронного документа.", "example": "Проверка пройдена" } }, "description": "Поля элемента словаря claim_digital_document_statuses" }, "claim_doc_statusesAttributes": { "type": "object", "properties": { "name": { "type": "string", "description": "Название статуса документа претензии.", "example": "Документ проверен" } }, "description": "Поля элемента словаря claim_doc_statuses" }, "claim_doc_typesAttributes": { "type": "object", "properties": { "name": { "type": "string", "description": "Название типа документа претензии.", "example": "ТН (Транспортная накладная)" } }, "description": "Поля элемента словаря claim_doc_types" }, "claim_draft_statusesAttributes": { "type": "object", "properties": { "name": { "type": "string", "description": "Название состояния черновика претензии.", "example": "Проверка пройдена, черновик материализован в претензию" } }, "description": "Поля элемента словаря claim_draft_statuses" }, "claim_for_typesAttributes": { "type": "object", "properties": { "name": { "type": "string", "description": "Название стороны, к которой выставлена претензия.", "example": "К заказчику" } }, "description": "Поля элемента словаря claim_for_types" }, "claim_levelsAttributes": { "type": "object", "properties": { "name": { "type": "string", "description": "Название уровня претензии.", "example": "Претензия-про" } }, "description": "Поля элемента словаря claim_levels" }, "claim_moderator_statusesAttributes": { "type": "object", "properties": { "name": { "type": "string", "description": "Название статуса модерации претензии.", "example": "Проверена модератором" } }, "description": "Поля элемента словаря claim_moderator_statuses" }, "claim_rolesAttributes": { "type": "object", "properties": { "name": { "type": "string", "description": "Название роли участника претензии.", "example": "Истец" } }, "description": "Поля элемента словаря claim_roles" }, "claim_sort_typesAttributes": { "type": "object", "properties": { "name": { "type": "string", "description": "Название поля, по которому упорядочивается список претензий.", "example": "По дате" } }, "description": "Поля элемента словаря claim_sort_types" }, "claim_statusesAttributes": { "type": "object", "properties": { "name": { "type": "string", "description": "Название статуса претензии.", "example": "Опубликована" } }, "description": "Поля элемента словаря claim_statuses" }, "claim_typesAttributes": { "type": "object", "properties": { "claim_levels": { "type": "string", "description": "Уровни, которые доступны для этого типа претензий.", "example": "0,1" }, "claim_name": { "type": "string", "description": "Название типа претензии.", "example": "Опоздание на загрузку/выгрузку (просрочка в доставке груза)" }, "for_type": { "type": "string", "description": "Сторона, к которой выставляется претензия этого типа.", "example": "2" } }, "description": "Поля элемента словаря claim_types" }, "firm_documents_templateAttributes": { "type": "object", "properties": { "template_name": { "type": "string", "description": "Название типа документа", "example": "Лицензия" } }, "description": "Поля элемента словаря firm_documents_template" }, "firms__ErrorResponse": { "type": "object", "properties": { "error": { "type": "string", "nullable": true }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UserRights": { "enum": [ 0, 1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 131072, 262144, 2097152, 8388608, 8534011, 16777216, 25313275, 27670527, 27672575 ], "type": "integer", "format": "int64", "description": "Права контакта" }, "ContactRightNestingType": { "enum": [ 0, 1, 2 ], "type": "integer", "format": "int32", "description": "Тип доступа
0 - только свое подразделение
1 - только свое и дочернее подразделение
2 - все подразделения" }, "FirmCommentPublic": { "type": "object", "properties": { "id": { "type": "string", "description": "Идентификатор комментария", "format": "uuid" }, "ati_id": { "type": "string", "description": "Идентификатор фирмы, оставившей комментарий", "nullable": true }, "user_id": { "type": "integer", "description": "Идентификатор контакта", "format": "int32", "nullable": true }, "commented_firm_ati_id": { "type": "string", "description": "Идентификатор фирмы, о которой оставили комментарий", "nullable": true }, "comment": { "type": "string", "description": "Текст комментария", "nullable": true }, "added_date": { "type": "string", "description": "Дата добавления комментария", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "FirmCommentPublicPost": { "type": "object", "properties": { "ati_id": { "type": "string", "description": "Идентификатор фирмы, оставившей комментарий", "nullable": true }, "user_id": { "type": "integer", "description": "Идентификатор контакта", "format": "int32", "nullable": true }, "commented_firm_ati_id": { "type": "string", "description": "Идентификатор фирмы, о которой оставили комментарий", "nullable": true }, "comment": { "type": "string", "description": "Текст комментария", "nullable": true }, "added_date": { "type": "string", "description": "Дата добавления комментария", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "TaxationTypes": { "enum": [ 0, 1, 2, 4, 8 ], "type": "integer", "format": "int32" }, "PayedServicePublic": { "type": "object", "properties": { "ati_id": { "type": "string", "nullable": true }, "service_id": { "type": "integer", "description": "Идентификатор лицензии", "format": "int32" }, "service_name": { "type": "string", "description": "Название лицензии", "nullable": true }, "dependencies": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Включенные лицензии", "nullable": true } }, "additionalProperties": false }, "FirmActiveServicePublic": { "type": "object", "properties": { "service_id": { "type": "integer", "description": "Идентификатор лицензии", "format": "int32" }, "service_name": { "type": "string", "description": "Название лицензии", "nullable": true }, "service_amount": { "type": "integer", "description": "Количество лицензии", "format": "int32", "nullable": true } }, "additionalProperties": false }, "RiAttributes": { "enum": [ 0, 1, 2, 4, 8, 16, 32, 64, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536, 262144 ], "type": "integer", "description": "Представляет атрибуты пользователя (таблица ri_users поле Attribute).", "format": "int32" }, "firms__CityAttributes": { "enum": [ 0, 4 ], "type": "integer", "format": "int32" }, "firms__City": { "type": "object", "properties": { "city_id": { "type": "integer", "description": "Идентификатор города", "format": "int32" }, "region_id": { "type": "integer", "description": "Идентификатор региона, в котором находится город", "format": "int32", "nullable": true }, "country_id": { "type": "integer", "description": "Идентификатор страны, в которой находится город", "format": "int32", "nullable": true }, "full_name": { "type": "string", "description": "Полное название города", "nullable": true, "readOnly": true }, "short_name": { "type": "string", "description": "Краткое название города", "nullable": true, "readOnly": true }, "is_regional_center": { "type": "boolean", "description": "Является ли город региональным центром", "readOnly": true }, "city_size": { "type": "integer", "description": "Идентификатор размера города", "format": "int32" }, "fias_id": { "type": "string", "description": "Идентификатор города по ФИАС", "format": "uuid", "nullable": true }, "attributes": { "allOf": [ { "$ref": "#/components/schemas/firms__CityAttributes" } ], "description": "Аттрибуты города" }, "city_name": { "type": "string", "description": "Название города", "nullable": true }, "region_name": { "type": "string", "description": "Название региона, в котором находится город", "nullable": true }, "country_name": { "type": "string", "description": "Название страны, в которой находится город", "nullable": true }, "country_code_name": { "type": "string", "description": "Кодовое название страны, в которой находится город", "nullable": true } }, "additionalProperties": false }, "firms__FirmStatus": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ], "type": "integer", "format": "int32" }, "PassportPublic": { "type": "object", "properties": { "ati_id": { "type": "string", "description": "Идентификатор фирмы", "nullable": true }, "total_score": { "type": "number", "description": "Сумма баллов пользователя ATI.SU", "format": "double" }, "ati_data_match_point": { "type": "number", "description": "Данные фирмы в ATI.SU (название, город) совпадают с настоящими данными фирмы", "format": "double" }, "account_lifetime_point": { "type": "number", "description": "За срок \"существования\" фирмы", "format": "double" }, "business_activity_point": { "type": "number", "description": "Свидетельство ведения фирмой текущей хозяйственной деятельности.", "format": "double" }, "round_table_point": { "type": "number", "description": "Балл по решению общественного движения пользователей ATI.SU \"Круглый стол\"", "format": "double" }, "claim_point": { "type": "number", "description": "Балл за имеющиеся Претензии к пользователю", "format": "double" }, "prof_activity_point": { "type": "number", "description": "За проф. деятельность в ATI.SU.", "format": "double" }, "ati_administration_point": { "type": "number", "description": "По решению администрации ATI.SU", "format": "double" }, "clones_point": { "type": "number", "description": "Балл за клонов участника системы", "format": "double" }, "egr_point": { "type": "number", "description": "По данным Единых Государственных Реестров Юридических Лиц и ИП", "format": "double" }, "mass_registration_point": { "type": "number", "description": "Юридическое лицо зарегистрировано по адресу массовой регистрации", "format": "double" }, "mass_founder_point": { "type": "number", "description": "Учредитель юридического лица является учредителем множества других юридических лиц", "format": "double" }, "firm_lifetime_point": { "type": "number", "description": "За давность регистрации в АвтоТрансИнфо", "format": "double" }, "ri_users_attributes": { "allOf": [ { "$ref": "#/components/schemas/RiAttributes" } ], "description": "Аттрибуты фирмы" }, "recommendations_count": { "type": "integer", "description": "Количество рекомендаций", "format": "int32" }, "status": { "allOf": [ { "$ref": "#/components/schemas/firms__FirmStatus" } ], "description": "Статус отвечает за цвет подложки звезд" }, "status_description": { "type": "string", "description": "Описание статуса", "nullable": true } }, "additionalProperties": false, "description": "Структура \"Паспорт\"" }, "AccountContactPublic": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор контакта", "format": "int32" }, "name": { "type": "string", "description": "Имя контакта", "nullable": true }, "fixed_rate_agreement_accepted": { "type": "boolean", "description": "Контакт принял соглашение о фиксированной ставке." }, "telephone": { "type": "string", "description": "Телефон контакта", "nullable": true }, "telephone_brand": { "type": "string", "description": "Брэнд телефона контакта", "nullable": true }, "telephone_region": { "type": "string", "description": "Русское название телефона контакта", "nullable": true }, "lo_users_attributes": { "type": "integer", "description": "Атрибут пользователя", "format": "int32" }, "email": { "type": "string", "description": "Электронная почта контакта", "nullable": true }, "icq": { "type": "string", "description": "Icq контакта", "nullable": true }, "mobile": { "type": "string", "description": "Мобильный телефона контакта", "nullable": true }, "mobile_brand": { "type": "string", "description": "Брэнд мобильного телефона контакта", "nullable": true }, "mobile_region": { "type": "string", "description": "Русское название мобильного телефона контакта", "nullable": true }, "skype_name": { "type": "string", "description": "Скайп контакта", "nullable": true }, "fax": { "type": "string", "description": "Факс контакта", "nullable": true }, "mobile_operator": { "type": "string", "description": "Мобильный оператор", "nullable": true }, "region_id": { "type": "string", "description": "Идентификатор региона контакта", "nullable": true }, "city_id": { "type": "integer", "description": "Идентификатор города контакта", "format": "int32", "nullable": true }, "is_visibled": { "type": "boolean", "description": "Параметр определяет, является ли контакт видимым или скрытым. От скрытого контакта нельзя добавить груз" }, "is_email_visibled": { "type": "boolean", "description": "Параметр определяет, является ли электронный адрес видимым или скрытым" }, "location": { "allOf": [ { "$ref": "#/components/schemas/firms__City" } ], "description": "Структура \"Город\" контакта", "nullable": true }, "access_rights": { "type": "integer", "description": "Права доступа", "format": "int32" }, "note": { "type": "string", "description": "Заметка о контакте", "nullable": true }, "has_personal_password": { "type": "boolean", "description": "Наличие личного пароля у контакта" } }, "additionalProperties": false }, "AccountPublic": { "type": "object", "properties": { "login": { "type": "string", "description": "Логин пользователя", "nullable": true }, "admin_email": { "type": "string", "description": "Адресс электронной почты администратора фирмы", "nullable": true }, "add_date": { "type": "string", "description": "Дата создания аккаунта", "format": "date-time" }, "firm_type_id": { "type": "integer", "description": "Идентификатор профиля деятельности", "format": "int32" }, "firm_type": { "type": "string", "description": "Профиль деятельности", "nullable": true }, "payed_services": { "type": "array", "items": { "$ref": "#/components/schemas/PayedServicePublic" }, "description": "Структура \"Оплаченные услуги\"", "nullable": true }, "firm_active_services": { "type": "array", "items": { "$ref": "#/components/schemas/FirmActiveServicePublic" }, "nullable": true }, "payed_services_end_date": { "type": "string", "description": "Дата окончания оплаченных услуг", "format": "date-time" }, "has_payed_services": { "type": "boolean", "description": "Оплачены ли у фирмы какие-либо лицензии", "readOnly": true }, "is_reset_similarity_point": { "type": "boolean", "description": "Был сброшен балл за соответствие в связи с продолжительной неактивностью фирмы", "readOnly": true }, "time_zone_id": { "type": "string", "description": "Текстовое описание часового пояса", "nullable": true }, "has_documents": { "type": "boolean", "description": "Флаг о наличии документов связанных с фирмой в таблице FirmDocuments" }, "account_id": { "type": "string", "description": "Код фирмы в ATI.SU", "nullable": true }, "contact_id": { "type": "integer", "description": "Идентификатор контакта", "format": "int32", "nullable": true }, "full_firm_name": { "type": "string", "description": "Полное название фирмы, учитывается название фирмы, ОПФ и брэнд.\r\n\r\nБрэнд не включается в полное название для форм собственности\r\n\r\n (другая)\r\n ПБОЮЛ\r\n ПБЮЛ\r\n ФЛП\r\n физ.лицо", "nullable": true }, "firm_name": { "type": "string", "description": "Название фирмы", "nullable": true }, "brand": { "type": "string", "description": "Брэнд фирмы", "nullable": true }, "ownership": { "type": "string", "description": "Организационно-правовая форма фирмы", "nullable": true }, "ownership_id": { "type": "integer", "description": "Идентификатор организационно-правовой формы фирмы", "format": "int32" }, "address": { "type": "string", "description": "Адрес фирмы", "nullable": true }, "inn": { "type": "string", "description": "ИНН фирмы", "nullable": true }, "ogrn": { "type": "string", "description": "ОГРН фирмы", "nullable": true }, "time_zone_minutes": { "type": "integer", "description": "Отступ в минутах от UTC для часового пояса, выставленного в кабинете данного аккаунта", "format": "int32" }, "claims_sum": { "type": "number", "description": "Сумма претензий к данной фирме в рублях", "format": "double", "nullable": true }, "claims_count": { "type": "integer", "description": "Количество претензий от фирм", "format": "int32" }, "city_id": { "type": "integer", "description": "Идентификатор города", "format": "int32" }, "bad_partner_mentions_count": { "type": "integer", "description": "Количество упоминаний на форуме Недобросовестных партнеров", "format": "int32" }, "bad_partner_firms_count": { "type": "integer", "description": "Количество упоминаний о данной фирме на форуме \"Недобросовестные партнеры\"", "format": "int32" }, "recommendations_count": { "type": "integer", "description": "Количество фирм, которые написали сообщение о данной фирме на форуме \"Недобросовестные партнеры\"", "format": "int32" }, "ri_users_attributes": { "allOf": [ { "$ref": "#/components/schemas/RiAttributes" } ], "description": "Аттрибуты фирмы" }, "ri_users_attributes2": { "type": "integer", "description": "Аттрибуты фирмы", "format": "int32" }, "firm_attributes": { "type": "integer", "description": "Аттрибуты фирмы", "format": "int32" }, "is_rrd": { "type": "boolean", "description": "Включен ли у фирмы режим РРД" }, "loads_access": { "type": "integer", "description": "Уровень доступа пользователя к грузам", "format": "int32" }, "loads_access_reason": { "type": "integer", "description": "Причина понижения доступа пользователя к грузам", "format": "int32" }, "load_responses_access": { "type": "integer", "description": "Уровень доступа пользователя к отзывам на грузы", "format": "int32" }, "load_responses_access_reason": { "type": "integer", "description": "Причина понижения доступа пользователя к отзывам на грузы", "format": "int32" }, "unlimited_stealth_access": { "type": "integer", "description": "Уровень доступа пользователя к стеллс, id сервиса 400", "format": "int32" }, "unlimited_stealth_access_reason": { "type": "integer", "description": "Причина понижения доступа пользователя к стеллс", "format": "int32" }, "trucks_access": { "type": "integer", "description": "Уровень доступа пользователя к транспорту", "format": "int32" }, "trucks_access_reason": { "type": "integer", "description": "Причина понижения доступа пользователя к транспорту", "format": "int32" }, "truck_responses_access": { "type": "integer", "description": "Уровень доступа пользователя к отзывам на транспорт", "format": "int32" }, "truck_responses_access_reason": { "type": "integer", "description": "Причина понижения доступа пользователя к отзывам на транспорт", "format": "int32" }, "position_in_city": { "type": "integer", "description": "Место в рэйтинге по городу", "format": "int32", "nullable": true }, "position_in_country": { "type": "integer", "description": "Место в рэйтинге по стране", "format": "int32", "nullable": true }, "is_responses_for_black_list_enabled": { "type": "boolean", "description": "Включено принятие встречных предложений от фирм из черного списка" }, "location": { "allOf": [ { "$ref": "#/components/schemas/firms__City" } ], "description": "Структура \"Город\"", "nullable": true }, "passport": { "allOf": [ { "$ref": "#/components/schemas/PassportPublic" } ], "description": "Структура \"Паспорт\"", "nullable": true }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/AccountContactPublic" }, "description": "Список структур \"Контакт\"", "nullable": true }, "currency_id": { "type": "integer", "description": "Идентификатор валюты", "format": "int32", "nullable": true }, "note": { "type": "string", "description": "Примечание", "nullable": true }, "http": { "type": "string", "description": "Сайт фирмы", "nullable": true }, "taxation_type": { "allOf": [ { "$ref": "#/components/schemas/TaxationTypes" } ], "description": "Тип налогооблажения", "nullable": true }, "with_vat": { "type": "boolean", "description": "Ндс" } }, "additionalProperties": false }, "FirmType": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор типа фирмы.", "format": "int32" }, "name": { "type": "string", "description": "Название типа", "nullable": true }, "russian_name": { "type": "string", "description": "Название типа.", "nullable": true }, "english_name": { "type": "string", "description": "Английское название типа.", "nullable": true }, "enable_for_registration": { "type": "boolean", "description": "Флаг, означающий, что данный профиль деятельности доступен для выбора при регистрации." } }, "additionalProperties": false, "description": "Структура \"Профиль деятельности\"." }, "AffilatedFirmPublic": { "type": "object", "properties": { "firm_name": { "type": "string", "description": "Название", "nullable": true }, "inn": { "type": "string", "description": "ИНН", "nullable": true }, "tf_firm_color": { "type": "string", "description": "Цвет фирмы по системе \"Светофор\"", "nullable": true }, "tf_has_signals": { "type": "boolean", "description": "Есть факты в системе \"Светофор\"" } }, "additionalProperties": false }, "firms__FirmDocument": { "type": "object", "properties": { "link": { "type": "string", "description": "Ссылка на документ.", "nullable": true }, "description": { "type": "string", "description": "Автогенерируемое описание документа.", "nullable": true }, "creation_date": { "type": "string", "description": "Дата создания документа.", "format": "date-time" }, "name": { "type": "string", "description": "Имя документа.", "nullable": true }, "type_id": { "type": "integer", "description": "Идентификатор типа документа из коллекции !:LocalizedDictionaries.DocumentTemplates.", "format": "int32" } }, "additionalProperties": false }, "AccountSummaryPublic": { "type": "object", "properties": { "ati_id": { "type": "string", "description": "Идентификатор фирмы", "nullable": true }, "brand": { "type": "string", "description": "Брэнд фирмы", "nullable": true }, "ownership": { "type": "string", "description": "Организационно-правовая форма фирмы", "nullable": true }, "full_name": { "type": "string", "description": "Полное имя фирмы: Брэнд (Название фирмы, ОПФ)", "nullable": true }, "firm_name": { "type": "string", "description": "Название фирмы", "nullable": true }, "location": { "allOf": [ { "$ref": "#/components/schemas/firms__City" } ], "description": "Структура \"Город\"", "nullable": true }, "address": { "type": "string", "description": "Адрес фирмы", "nullable": true }, "web_site": { "type": "string", "description": "Сайт фирмы", "nullable": true }, "position_in_city": { "type": "integer", "description": "Место в рэйтинге по городу", "format": "int32", "nullable": true }, "position_in_country": { "type": "integer", "description": "Место в рэйтинге по стране", "format": "int32", "nullable": true }, "name_eng": { "type": "string", "description": "Интернациональное название фирмы", "nullable": true }, "firm_type": { "type": "string", "description": "Профиль деятельности фирмы", "nullable": true }, "firm_type_id_int": { "type": "integer", "description": "Идентификатор профиля деятельности", "format": "int32" }, "firm_type_id": { "type": "string", "description": "(Устаревшее)\r\nИдентификатор профиля деятельности строкой", "nullable": true }, "predicted_firm_type_id": { "type": "integer", "description": "Идентификатор предполагаемого профиля деятельности фирмы, основанный на её анализе", "format": "int32", "nullable": true }, "info_reference": { "type": "string", "description": "Ссылка на карточку фирмы", "nullable": true }, "passport_reference": { "type": "string", "description": "Ссылка на паспорт фирмы", "nullable": true }, "city": { "type": "string", "description": "Город, в котором расположена фирма", "nullable": true }, "score": { "type": "number", "description": "Количество звезд фирмы. Если число отрицательно, то это красные звезды", "format": "double" }, "bad_partner_mentions_count": { "type": "integer", "description": "Количество упоминаний на форуме недобросовестных партнеров", "format": "int32" }, "claims_count": { "type": "integer", "description": "Количество претензий от фирм", "format": "int32" }, "language": { "type": "string", "description": "Язык фирмы", "nullable": true }, "recommendations_count": { "type": "integer", "description": "Количество рекомендаций от фирм", "format": "int32" }, "inn": { "type": "string", "description": "Инн", "nullable": true }, "ogrn": { "type": "string", "description": "ОГРН", "nullable": true }, "kpp": { "type": "string", "description": "Код причины постановки на учет фирмы", "nullable": true }, "okpo": { "type": "string", "description": "Общероссийский классификатор предприятий и организаций", "nullable": true }, "affiliated_firms": { "type": "array", "items": { "$ref": "#/components/schemas/AffilatedFirmPublic" }, "description": "Связанные фирмы", "nullable": true }, "negative_points_sum": { "type": "number", "description": "Сумма отрицательных баллов", "format": "double" }, "tf_firm_color": { "type": "string", "description": "Цвет фирмы в светофоре", "nullable": true }, "tf_account_color": { "type": "string", "description": "Цвет аккаунта в светофоре", "nullable": true }, "tf_has_signals": { "type": "boolean", "description": "Флаг о существовании любой информации о фирме в светофоре" }, "registration_date": { "type": "string", "description": "Дата регистрации на сайте, которая AddDate из firms.", "format": "date-time" }, "contact_info_changed": { "type": "string", "description": "Дата последних изменений в истории фирмы.", "format": "date-time" }, "deletion_date": { "type": "string", "description": "Дата удаления фирмы.", "format": "date-time", "nullable": true }, "last_month_active_days": { "type": "integer", "description": "Число дней со входами на сайт за последние 30 дней.", "format": "int32" }, "firm_documents": { "type": "array", "items": { "$ref": "#/components/schemas/firms__FirmDocument" }, "description": "Список структуры \"Документ фирмы\"", "nullable": true }, "verified_trucks": { "type": "integer", "description": "Количеством зарегистрированных ТС", "format": "int32" } }, "additionalProperties": false }, "EmailInfo": { "type": "object", "properties": { "email": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ContactPublic": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор контакта", "format": "int32" }, "firm_name": { "type": "string", "description": "Название фирмы", "nullable": true }, "ownership": { "type": "string", "description": "Организационно-правовая форма", "nullable": true }, "ownership_id": { "type": "integer", "description": "Форма собственности", "format": "int32" }, "ati_id": { "type": "string", "description": "Код фирмы в ATI.SU", "nullable": true }, "firm_deletion_date": { "type": "string", "description": "Дата удаления аккаунта", "format": "date-time", "nullable": true }, "name": { "type": "string", "description": "Имя контакта", "nullable": true }, "phone": { "type": "string", "description": "Номер телефона (основной)", "nullable": true }, "e_mail": { "type": "string", "description": "Электронная почта контакта", "nullable": true }, "email_for_link": { "type": "string", "description": "Адрес для отправки письма на задание логина/пароля", "nullable": true }, "icq": { "type": "string", "description": "ICQ контакта", "nullable": true }, "mobile": { "type": "string", "description": "Номер телефона контакта (мобильный)", "nullable": true }, "fax": { "type": "string", "description": "Номер телефона контакта (факс)", "nullable": true }, "note": { "type": "string", "description": "Примечание", "nullable": true }, "is_visible": { "type": "boolean", "description": "Контакта виден / скрыт" }, "is_email_visible": { "type": "boolean", "description": "E-mail виден / скрыт" }, "mobile_id": { "type": "integer", "description": "Номер телефона (мобильный) без кода города", "format": "int32", "nullable": true }, "phone_id": { "type": "integer", "description": "Номер телефона (основной) без кода города", "format": "int32", "nullable": true }, "fax_id": { "type": "integer", "description": "Номер телефона контакта (факс) без кода города", "format": "int32", "nullable": true }, "skype_name": { "type": "string", "description": "Логин в Skype", "nullable": true }, "city_id": { "type": "integer", "description": "Идентификатори города", "format": "int32", "nullable": true }, "attributes": { "type": "integer", "description": "Атрибуты контакта", "format": "int32", "nullable": true }, "access_rights": { "type": "integer", "description": "Права контакта (для ррд)", "format": "int32" }, "gsm_operator_id": { "type": "integer", "description": "Идентификатор сотового оператора", "format": "int32", "nullable": true }, "is_deleted": { "type": "boolean", "description": "Удален ли контакт", "readOnly": true }, "deletion_date": { "type": "string", "description": "Дата удаления контакта", "format": "date-time", "nullable": true }, "is_photo_exists": { "type": "boolean", "description": "Загружено ли фото" }, "login": { "type": "string", "description": "Логин контакта", "nullable": true }, "has_personal_password": { "type": "boolean", "description": "Есть ли персональный пароль" }, "language": { "type": "string", "description": "Язык сайта выбранный, контактом", "nullable": true }, "department_id": { "type": "integer", "description": "Идентификатор основного подразделения контакта", "format": "int32" }, "position": { "type": "string", "description": "Должность", "nullable": true }, "user_rights": { "allOf": [ { "$ref": "#/components/schemas/UserRights" } ], "description": "Права контакта в новой схеме" }, "contact_right_nesting_type_id": { "allOf": [ { "$ref": "#/components/schemas/ContactRightNestingType" } ], "description": "Уровень доступа к другим подразделениям" } }, "additionalProperties": false }, "FirmContact": { "type": "object", "properties": { "firm_id": { "type": "integer", "description": "Идентификатор фирмы", "format": "int32", "nullable": true }, "firm_name": { "type": "string", "description": "Название фирмы", "nullable": true }, "ownership": { "type": "string", "description": "Организационно-правовая форма", "nullable": true }, "ownership_id": { "type": "integer", "description": "Форма собственности", "format": "int32" }, "password": { "type": "string", "description": "Пароль", "nullable": true }, "id": { "type": "integer", "description": "Идентификатор контакта", "format": "int32" }, "ati_id": { "type": "string", "description": "Код фирмы в ATI.SU", "nullable": true }, "firm_deletion_date": { "type": "string", "description": "Дата удаления аккаунта", "format": "date-time", "nullable": true }, "name": { "type": "string", "description": "Имя контакта", "nullable": true }, "phone": { "type": "string", "description": "Номер телефона (основной)", "nullable": true }, "e_mail": { "type": "string", "description": "Электронная почта контакта", "nullable": true }, "email_for_link": { "type": "string", "description": "Адрес для отправки письма на задание логина/пароля", "nullable": true }, "icq": { "type": "string", "description": "ICQ контакта", "nullable": true }, "mobile": { "type": "string", "description": "Номер телефона контакта (мобильный)", "nullable": true }, "fax": { "type": "string", "description": "Номер телефона контакта (факс)", "nullable": true }, "note": { "type": "string", "description": "Примечание", "nullable": true }, "is_visible": { "type": "boolean", "description": "Контакта виден / скрыт" }, "is_email_visible": { "type": "boolean", "description": "E-mail виден / скрыт" }, "mobile_id": { "type": "integer", "description": "Номер телефона (мобильный) без кода города", "format": "int32", "nullable": true }, "phone_id": { "type": "integer", "description": "Номер телефона (основной) без кода города", "format": "int32", "nullable": true }, "fax_id": { "type": "integer", "description": "Номер телефона контакта (факс) без кода города", "format": "int32", "nullable": true }, "skype_name": { "type": "string", "description": "Логин в Skype", "nullable": true }, "city_id": { "type": "integer", "description": "Идентификатори города", "format": "int32", "nullable": true }, "attributes": { "type": "integer", "description": "Атрибуты контакта", "format": "int32", "nullable": true }, "access_rights": { "type": "integer", "description": "Права контакта (для ррд)", "format": "int32" }, "gsm_operator_id": { "type": "integer", "description": "Идентификатор сотового оператора", "format": "int32", "nullable": true }, "is_deleted": { "type": "boolean", "description": "Удален ли контакт", "readOnly": true }, "deletion_date": { "type": "string", "description": "Дата удаления контакта", "format": "date-time", "nullable": true }, "is_photo_exists": { "type": "boolean", "description": "Загружено ли фото" }, "login": { "type": "string", "description": "Логин контакта", "nullable": true }, "has_personal_password": { "type": "boolean", "description": "Есть ли персональный пароль" }, "language": { "type": "string", "description": "Язык сайта выбранный, контактом", "nullable": true }, "department_id": { "type": "integer", "description": "Идентификатор основного подразделения контакта", "format": "int32" }, "position": { "type": "string", "description": "Должность", "nullable": true }, "user_rights": { "allOf": [ { "$ref": "#/components/schemas/UserRights" } ], "description": "Права контакта в новой схеме" }, "contact_right_nesting_type_id": { "allOf": [ { "$ref": "#/components/schemas/ContactRightNestingType" } ], "description": "Уровень доступа к другим подразделениям" } }, "additionalProperties": false }, "ContactSummaryPublic": { "type": "object", "properties": { "ati_id": { "type": "string", "description": "Код в ATI.SU.", "nullable": true }, "contact_id": { "type": "integer", "description": "Идентификатор контакта.", "format": "int32" }, "name": { "type": "string", "description": "Имя контакта.", "nullable": true }, "phone": { "type": "string", "description": "Рабочий телефон.", "nullable": true }, "mobile_phone": { "type": "string", "description": "Мобильный телефон.", "nullable": true }, "claims_count": { "type": "integer", "description": "Количество претензий.", "format": "int32" }, "recommendations_count": { "type": "integer", "description": "Количество рекомендаций.", "format": "int32" }, "bad_partner_mentions_count": { "type": "integer", "description": "Количество упоминаний на форуме \"Недобросовестные партнеры\".", "format": "int32" }, "leveled_claims_count": { "type": "integer", "description": "Количество претензий лайт", "format": "int32" }, "claims_pro_sum": { "type": "number", "description": "Сумма выставленных на фирму претензий Про.", "format": "double" }, "claims_lite_sum": { "type": "number", "description": "Сумма выставленных на фирму претензий Лайт.", "format": "double" }, "firm_type": { "type": "string", "description": "Профиль деятельности фирмы.", "nullable": true }, "firm_name": { "type": "string", "description": "Название фирмы.", "nullable": true }, "ownership": { "type": "string", "description": "Организационно-правовая форма.", "nullable": true }, "city": { "type": "string", "description": "Город", "nullable": true }, "score": { "type": "number", "description": "Количество звезд фирмы.", "format": "double" }, "status": { "allOf": [ { "$ref": "#/components/schemas/firms__FirmStatus" } ], "description": "Статус, определяющий цвет подложки звезд.", "nullable": true }, "icq": { "type": "string", "description": "Icq контакта", "nullable": true }, "fax": { "type": "string", "description": "Факс контакта", "nullable": true }, "skype_name": { "type": "string", "description": "Skype контакта", "nullable": true }, "email": { "type": "string", "description": "Email контакта", "nullable": true }, "language": { "type": "string", "description": "Язык контакта", "nullable": true } }, "additionalProperties": false, "description": "Краткая информация о контакте." }, "LocationPascalCase": { "type": "object", "properties": { "Id2": { "type": "string", "description": "Уникальный идентификатор местоположения", "format": "uuid", "nullable": true }, "CityId": { "type": "integer", "description": "Идентификатор города", "format": "int32" }, "RegionId": { "type": "integer", "description": "Идентификатор региона", "format": "int32" }, "CountryId": { "type": "integer", "description": "Идентификатор страны", "format": "int32" }, "FullName": { "type": "string", "description": "Полное название местоположения", "nullable": true }, "ShortName": { "type": "string", "description": "Краткое название местоположения", "nullable": true }, "FullNameEng": { "type": "string", "description": "Полное название на английском языке", "nullable": true }, "ShortNameEng": { "type": "string", "description": "Краткое название на английском языке", "nullable": true }, "IsRegionalCenter": { "type": "boolean", "description": "Является ли региональным центром" }, "CitySize": { "type": "integer", "description": "Размер города", "format": "int32" }, "FiasId": { "type": "string", "description": "Идентификатор ФИАС", "format": "uuid", "nullable": true }, "Longitude": { "type": "number", "description": "Долгота", "format": "double", "nullable": true }, "Latitude": { "type": "number", "description": "Широта", "format": "double", "nullable": true }, "CityName": { "type": "string", "description": "Название города", "nullable": true }, "RegionName": { "type": "string", "description": "Название региона", "nullable": true }, "CountryName": { "type": "string", "description": "Название страны", "nullable": true }, "CityNameEng": { "type": "string", "description": "Название города на английском языке", "nullable": true }, "RegionNameEng": { "type": "string", "description": "Название региона на английском языке", "nullable": true }, "CountryNameEng": { "type": "string", "description": "Название страны на английском языке", "nullable": true }, "CountryCodeName": { "type": "string", "description": "Код страны", "nullable": true } }, "additionalProperties": false }, "PassportPascalCase": { "type": "object", "properties": { "TotalScore": { "type": "number", "description": "Общий балл паспорта", "format": "double" }, "ATIDataMatchPoint": { "type": "number", "description": "Балл за соответствие данных АТИ", "format": "double" }, "AccountLifetimePoint": { "type": "number", "description": "Балл за время существования аккаунта", "format": "double" }, "BusinessActivityPoint": { "type": "number", "description": "Балл за деловую активность", "format": "double" }, "RoundTablePoint": { "type": "number", "description": "Балл за участие в круглом столе", "format": "double" }, "ClaimPoint": { "type": "number", "description": "Балл за претензии", "format": "double" }, "ProfActivityPoint": { "type": "number", "description": "Балл за профессиональную активность", "format": "double" }, "ATIAdministrationPoint": { "type": "number", "description": "Балл от администрации АТИ", "format": "double" }, "ClonesPoint": { "type": "number", "description": "Балл за клоны", "format": "double" }, "EGRPoint": { "type": "number", "description": "Балл за ЕГР", "format": "double" }, "MassRegistrationPoint": { "type": "number", "description": "Балл за массовую регистрацию", "format": "double" }, "MassFounderPoint": { "type": "number", "description": "Балл за массового учредителя", "format": "double" }, "FirmLifetimePoint": { "type": "number", "description": "Балл за время существования фирмы", "format": "double" }, "Status": { "type": "integer", "description": "Статус паспорта", "format": "int32" }, "StatusDescription": { "type": "string", "description": "Описание статуса паспорта", "nullable": true } }, "additionalProperties": false }, "ContactPascalCase": { "type": "object", "properties": { "Id": { "type": "integer", "description": "Идентификатор контакта", "format": "int32" }, "Name": { "type": "string", "description": "Имя контакта", "nullable": true }, "Telephone": { "type": "string", "description": "Телефон", "nullable": true }, "TelephoneBrand": { "type": "string", "description": "Оператор телефона", "nullable": true }, "TelephoneRegion": { "type": "string", "description": "Регион телефона", "nullable": true }, "Email": { "type": "string", "description": "Email адрес", "nullable": true }, "Icq": { "type": "string", "description": "ICQ номер", "nullable": true }, "Mobile": { "type": "string", "description": "Мобильный телефон", "nullable": true }, "MobileBrand": { "type": "string", "description": "Оператор мобильного телефона", "nullable": true }, "MobileRegion": { "type": "string", "description": "Регион мобильного телефона", "nullable": true }, "SkypeName": { "type": "string", "description": "Skype имя", "nullable": true }, "Fax": { "type": "string", "description": "Факс", "nullable": true }, "MobileOperator": { "type": "string", "description": "Оператор мобильной связи", "nullable": true }, "RegionId": { "type": "integer", "description": "Идентификатор региона", "format": "int32", "nullable": true }, "Location": { "$ref": "#/components/schemas/LocationPascalCase", "description": "Местоположение контакта" }, "IsVisibled": { "type": "boolean", "description": "Видимость контакта" }, "IsEmailVisibled": { "type": "boolean", "description": "Видимость email" }, "Note": { "type": "string", "description": "Примечание", "nullable": true }, "Language": { "type": "string", "description": "Язык", "nullable": true }, "DepartmentId": { "type": "integer", "description": "Идентификатор отдела", "format": "int32" }, "Position": { "type": "string", "description": "Должность", "nullable": true }, "UserRights": { "type": "integer", "description": "Права пользователя", "format": "int32" }, "ContactRightNestingType": { "type": "integer", "description": "Тип вложенности прав контакта", "format": "int32" }, "AvailableDepartments": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Доступные отделы" }, "CanWorkWithSubdivisions": { "type": "boolean", "description": "Может работать с подразделениями" }, "CanTakeLoad": { "type": "boolean", "description": "Может принимать грузы" }, "CanWorkWithCommonBoard": { "type": "boolean", "description": "Может работать с общей доской" }, "CanWorkWithPersonalBoard": { "type": "boolean", "description": "Может работать с личной доской" }, "CanUseVirtualPayments": { "type": "boolean", "description": "Может использовать виртуальные платежи" } }, "additionalProperties": false }, "AccountPascalCase": { "type": "object", "properties": { "AccountId": { "type": "integer", "description": "Идентификатор аккаунта", "format": "int32" }, "ContactId": { "type": "integer", "description": "Идентификатор контакта", "format": "int32" }, "FullFirmName": { "type": "string", "description": "Полное название фирмы", "nullable": true }, "FirmName": { "type": "string", "description": "Название фирмы", "nullable": true }, "Brand": { "type": "string", "description": "Бренд фирмы", "nullable": true }, "Ownership": { "type": "string", "description": "Форма собственности", "nullable": true }, "OwnershipId": { "type": "integer", "description": "Идентификатор формы собственности", "format": "int32" }, "Location": { "$ref": "#/components/schemas/LocationPascalCase", "description": "Местоположение фирмы" }, "Inn": { "type": "string", "description": "ИНН фирмы", "nullable": true }, "TimeZoneMinutes": { "type": "integer", "description": "Часовой пояс в минутах от UTC", "format": "int32" }, "IsRrd": { "type": "boolean", "description": "Включен ли режим РРД" }, "LoadsAccess": { "type": "integer", "description": "Уровень доступа к грузам", "format": "int32" }, "ClaimsCount": { "type": "integer", "description": "Количество претензий", "format": "int32" }, "BadPartnerMentionsCount": { "type": "integer", "description": "Количество упоминаний недобросовестных партнеров", "format": "int32" }, "BadPartnerFirmsCount": { "type": "integer", "description": "Количество недобросовестных партнеров", "format": "int32" }, "FirmTypeId": { "type": "integer", "description": "Идентификатор типа фирмы", "format": "int32" }, "FirmType": { "type": "string", "description": "Тип фирмы", "nullable": true }, "RecommendationCount": { "type": "integer", "description": "Количество рекомендаций", "format": "int32" }, "MaxContactsCount": { "type": "integer", "description": "Максимальное количество контактов", "format": "int32" }, "Passport": { "$ref": "#/components/schemas/PassportPascalCase", "description": "Паспорт фирмы" }, "Contacts": { "type": "array", "items": { "$ref": "#/components/schemas/ContactPascalCase" }, "description": "Список контактов" }, "RiUsersAttributes": { "type": "integer", "description": "Атрибуты пользователя", "format": "int32" } }, "additionalProperties": false }, "billing-requisites__FirmRequisitePublic": { "type": "object", "properties": { "requisite_id": { "type": "string", "description": "Идентификатор реквизита.", "format": "uuid", "example": "5e7d4f3a-1234-5678-9abc-def012345678" }, "ati_id": { "type": [ "null", "string" ], "description": "Код фирмы в АТИ.", "example": "12345" }, "requisite_type_id": { "type": "integer", "description": "Идентификатор типа реквизита. Допустимые значения для данной формы собственности — массив `requisiteTypes`\nв ответе словаря `GET /v1.0/firms/requisites/ownerships/{countryId}` (поле `id` элемента словаря\nсоответствует тому же набору, что и список `requisiteTypes`).", "format": "int32", "example": 1 }, "requisite_name": { "type": [ "null", "string" ], "description": "Название реквизита.", "example": "Основной реквизит" }, "legal_name": { "type": [ "null", "string" ], "description": "Юридическое наименование фирмы.", "example": "ООО \"Ромашка\"" }, "own_ship_id": { "type": "integer", "description": "Идентификатор формы собственности. Значение берётся из метода\n`GET /v1.0/firms/requisites/ownerships/{countryId}`. Подставляйте поле `id` из ответа словаря.", "format": "int32", "example": 1 }, "fio": { "type": [ "null", "string" ], "description": "ФИО владельца.", "example": "Иванов Иван Иванович" }, "inn": { "type": [ "null", "string" ], "description": "ИНН.", "example": "1234567890" }, "ogrn": { "type": [ "null", "string" ], "description": "ОГРН (для реквизитов в валюте USD/EUR в этом поле хранится VAT).", "example": "1234567890123" }, "phone": { "type": [ "null", "string" ], "description": "Телефон.", "example": "+7 (495) 123-45-67" }, "fax": { "type": [ "null", "string" ], "description": "Факс.", "example": "+7 (495) 123-45-68" }, "email": { "type": [ "null", "string" ], "description": "Электронный адрес.", "example": "info@example.com" }, "kpp": { "type": [ "null", "string" ], "description": "КПП.", "example": "123456789" }, "rs": { "type": [ "null", "string" ], "description": "Расчётный счёт.", "example": "40702810400000001234" }, "ks": { "type": [ "null", "string" ], "description": "Корреспондентский счёт банка.", "example": "30101810400000000225" }, "bik": { "type": [ "null", "string" ], "description": "БИК банка.", "example": "044525225" }, "bank": { "type": [ "null", "string" ], "description": "Наименование банка.", "example": "ПАО Сбербанк" }, "codes": { "type": [ "null", "string" ], "description": "Дополнительные коды реквизита.", "example": "OKVED:49.41" }, "is_read_only": { "type": "boolean", "description": "Признак реквизитов только для чтения.", "example": false }, "okpo": { "type": [ "null", "string" ], "description": "ОКПО.", "example": "12345678" }, "is_vat_payer": { "type": "boolean", "description": "Признак плательщика НДС.", "example": true }, "last_use_date": { "type": [ "null", "string" ], "description": "Дата последнего использования в системе (UTC).", "format": "date-time", "example": "2024-01-15T10:30:00Z" }, "is_active": { "type": "boolean", "description": "Активный реквизит.", "default": true, "example": true }, "is_visible": { "type": "boolean", "description": "Будет ли виден реквизит пользователю в будущем. Используется для одноразовых реквизитов\n(например, при создании счёта с оплатой по банковской карте — там реквизит создаётся из пары полей).", "default": true, "example": true }, "legal_address": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/billing-requisites__FirmAddressPublic" } ], "description": "Юридический адрес", "example": { "address_id": "5e7d4f3a-1234-5678-9abc-def012345678", "ati_id": "12345", "country_id": 1, "region_id": 77, "city_id": 1, "city_name": "Москва", "post_index": "101000", "street_type_id": 1, "street_name": "Тверская", "house_no": "10", "part_no": "корп.1", "litera": "лит.А", "office_no": "501", "post_contact": "Иванов И.И.", "add_date": "2024-01-15T10:30:00Z", "attributes": 12, "formatted_text": "101000, г. Москва, ул. Тверская, д.10, корп.1, лит.А, оф.501" } }, "post_address": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/billing-requisites__FirmAddressPublic" } ], "description": "Почтовый адрес", "example": { "address_id": "5e7d4f3a-1234-5678-9abc-def012345678", "ati_id": "12345", "country_id": 1, "region_id": 77, "city_id": 1, "city_name": "Москва", "post_index": "101000", "street_type_id": 1, "street_name": "Тверская", "house_no": "10", "part_no": "корп.1", "litera": "лит.А", "office_no": "501", "post_contact": "Иванов И.И.", "add_date": "2024-01-15T10:30:00Z", "attributes": 12, "formatted_text": "101000, г. Москва, ул. Тверская, д.10, корп.1, лит.А, оф.501" } }, "legal_address_id": { "type": "string", "description": "Идентификатор юридического адреса в системе.", "format": "uuid", "example": "5e7d4f3a-1234-5678-9abc-def012345678" }, "post_address_id": { "type": "string", "description": "Идентификатор почтового адреса в системе.", "format": "uuid", "example": "6f8e5g4b-2345-6789-0bcd-ef0123456789" }, "signees": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/billing-requisites__Signee" }, "description": "Список подписантов", "example": [ { "signee_id": "5e7d4f3a-1234-5678-9abc-def012345678", "requisite_id": "6f8e5g4b-2345-6789-0bcd-ef0123456789", "full_name": "Иванова Ивана Ивановича", "position": "генерального директора", "act_upon": "Устава", "is_default": true, "deletion_date": "2024-12-31T00:00:00Z", "full_name_and_position": "Генеральный директор Иванов И.И." } ] }, "person_passport": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/billing-requisites__PersonPassport" } ], "description": "Паспорт физического лица. Возвращается только для реквизитов своей фирмы;\nдля реквизитов другой фирмы всегда `null`.", "example": { "series": "4500", "number": "123456", "date_of_issue": "2010-05-15T00:00:00Z", "department_code": "770-001", "issued_by": "ОВД района Замоскворечье г. Москвы", "registration": "101000, г. Москва, ул. Тверская, д.10" } }, "available_in_ati_docs": { "type": "boolean", "description": "Признак доступности реквизитов в АТИ Доках.", "readOnly": true, "example": true }, "exclusive_for_invoice_pay_type": { "type": [ "null", "integer" ], "description": "Идентификатор типа платежа, для которого реквизиты являются приоритетными.\nПри наличии эксклюзивных другие доступные реквизиты для такого InvoicePayTypeId возвращаться не будут.", "format": "int32", "example": 1 }, "is_short_requisite": { "type": "boolean", "description": "Признак того, что реквизиты являются короткими/неполными.\nДля коротких реквизитов есть ослабленная валидация.", "example": false } }, "additionalProperties": false, "description": "Публичные реквизиты фирмы (юридическое лицо, ИП или физическое лицо) с банковскими реквизитами,\nадресами и связанными подписантами.", "example": { "requisite_id": "5e7d4f3a-1234-5678-9abc-def012345678", "ati_id": "12345", "requisite_type_id": 1, "requisite_name": "Основной реквизит", "legal_name": "ООО \"Ромашка\"", "own_ship_id": 1, "fio": "Иванов Иван Иванович", "inn": "1234567890", "ogrn": "1234567890123", "phone": "+7 (495) 123-45-67", "fax": "+7 (495) 123-45-68", "email": "info@example.com", "kpp": "123456789", "rs": "40702810400000001234", "ks": "30101810400000000225", "bik": "044525225", "bank": "ПАО Сбербанк", "codes": "OKVED:49.41", "is_read_only": false, "okpo": "12345678", "is_vat_payer": true, "last_use_date": "2024-01-15T10:30:00Z", "is_active": true, "is_visible": true, "legal_address": { "address_id": "5e7d4f3a-1234-5678-9abc-def012345678", "ati_id": "12345", "country_id": 1, "region_id": 77, "city_id": 1, "city_name": "Москва", "post_index": "101000", "street_type_id": 1, "street_name": "Тверская", "house_no": "10", "part_no": "корп.1", "litera": "лит.А", "office_no": "501", "post_contact": "Иванов И.И.", "add_date": "2024-01-15T10:30:00Z", "attributes": 12, "formatted_text": "101000, г. Москва, ул. Тверская, д.10, корп.1, лит.А, оф.501" }, "post_address": { "address_id": "5e7d4f3a-1234-5678-9abc-def012345678", "ati_id": "12345", "country_id": 1, "region_id": 77, "city_id": 1, "city_name": "Москва", "post_index": "101000", "street_type_id": 1, "street_name": "Тверская", "house_no": "10", "part_no": "корп.1", "litera": "лит.А", "office_no": "501", "post_contact": "Иванов И.И.", "add_date": "2024-01-15T10:30:00Z", "attributes": 12, "formatted_text": "101000, г. Москва, ул. Тверская, д.10, корп.1, лит.А, оф.501" }, "legal_address_id": "5e7d4f3a-1234-5678-9abc-def012345678", "post_address_id": "6f8e5g4b-2345-6789-0bcd-ef0123456789", "person_passport": { "series": "4500", "number": "123456", "date_of_issue": "2010-05-15T00:00:00Z", "department_code": "770-001", "issued_by": "ОВД района Замоскворечье г. Москвы", "registration": "101000, г. Москва, ул. Тверская, д.10", "scan_files": [ { "link": "https://files.example.com/passport/123.pdf", "id": "file-abc-123", "size": 102400, "name": "passport_scan.pdf" } ] }, "available_in_ati_docs": true, "exclusive_for_invoice_pay_type": 1, "is_short_requisite": false, "signees": [ { "signee_id": "5e7d4f3a-1234-5678-9abc-def012345678", "requisite_id": "6f8e5g4b-2345-6789-0bcd-ef0123456789", "full_name": "Иванова Ивана Ивановича", "position": "генерального директора", "act_upon": "Устава", "is_default": true, "deletion_date": "2024-12-31T00:00:00Z", "full_name_and_position": "Генеральный директор Иванов И.И." } ] } }, "billing-requisites__AddressParts": { "type": "object", "properties": { "street_types": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/billing-requisites__AddressPartItem" }, "description": "Коллекция типов улиц (например, проспект).", "example": [ { "id": 1, "name": "проспект", "short_name": "пр-кт" } ] }, "building_types": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/billing-requisites__AddressPartItem" }, "description": "Коллекция типов зданий (например, дом).", "example": [ { "id": 1, "name": "проспект", "short_name": "пр-кт" } ] }, "building_part_types": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/billing-requisites__AddressPartItem" }, "description": "Коллекция типов строений (например, корпус).", "example": [ { "id": 1, "name": "проспект", "short_name": "пр-кт" } ] }, "room_types": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/billing-requisites__AddressPartItem" }, "description": "Коллекция типов помещений (например, офис).", "example": [ { "id": 1, "name": "проспект", "short_name": "пр-кт" } ] } }, "additionalProperties": false, "description": "Типы адресов.", "example": { "street_types": [ { "id": 1, "name": "проспект", "short_name": "пр-кт" } ], "building_types": [ { "id": 1, "name": "проспект", "short_name": "пр-кт" } ], "building_part_types": [ { "id": 1, "name": "проспект", "short_name": "пр-кт" } ], "room_types": [ { "id": 1, "name": "проспект", "short_name": "пр-кт" } ] } }, "billing-requisites__Country": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор страны.", "format": "int32", "example": 1 }, "name": { "type": [ "null", "string" ], "description": "Полное название страны.", "example": "Россия" }, "short_name": { "type": [ "null", "string" ], "description": "Короткое название страны.", "example": "РФ" }, "default_ownership": { "type": "null", "allOf": [ { "$ref": "#/components/schemas/billing-requisites__Ownership" } ], "description": "Форма собственности по умолчанию для данной страны", "example": { "id": 1, "name": "Общество с ограниченной ответственностью", "name_eng": "Limited Liability Company", "short_name": "ООО", "short_name_eng": "LLC", "ownership_type": "LegalPerson", "ownership_type_name": "LegalPerson" } }, "ownerships": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/billing-requisites__Ownership" }, "description": "Список всех доступных в данной стране форм собственности", "readOnly": true, "example": [ { "id": 1, "name": "Общество с ограниченной ответственностью", "name_eng": "Limited Liability Company", "short_name": "ООО", "short_name_eng": "LLC", "ownership_type": "LegalPerson", "ownership_type_name": "LegalPerson", "requisite_types": [ 0 ] } ] } }, "additionalProperties": false, "description": "Сущность страны для справочников сервиса", "example": { "id": 1, "name": "Россия", "short_name": "РФ", "default_ownership": { "id": 1, "name": "Общество с ограниченной ответственностью", "name_eng": "Limited Liability Company", "short_name": "ООО", "short_name_eng": "LLC", "ownership_type": "LegalPerson", "ownership_type_name": "LegalPerson", "requisite_types": [ 0 ] }, "ownerships": [ { "id": 1, "name": "Общество с ограниченной ответственностью", "name_eng": "Limited Liability Company", "short_name": "ООО", "short_name_eng": "LLC", "ownership_type": "LegalPerson", "ownership_type_name": "LegalPerson", "requisite_types": [ 0 ] } ] } }, "billing-requisites__Ownership": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор формы собственности.", "format": "int32", "example": 1 }, "name": { "type": [ "null", "string" ], "description": "Полное название формы собственности (рус.).", "example": "Общество с ограниченной ответственностью" }, "name_eng": { "type": [ "null", "string" ], "description": "Полное название формы собственности (англ.).", "example": "Limited Liability Company" }, "short_name": { "type": [ "null", "string" ], "description": "Короткое название формы собственности (рус.).", "example": "ООО" }, "short_name_eng": { "type": [ "null", "string" ], "description": "Короткое название формы собственности (англ.).", "example": "LLC" }, "ownership_type": { "type": [ "null", "string" ], "description": "Тип формы собственности: \"LegalPerson\" / \"SoleProprietor\" / \"NaturalPerson\".", "readOnly": true, "example": "LegalPerson" }, "ownership_type_name": { "type": [ "null", "string" ], "description": "Устаревшее поле. Используй поле OwnershipType", "readOnly": true, "example": "LegalPerson" }, "requisite_types": { "type": [ "null", "array" ], "items": { "type": "integer", "format": "int32" }, "description": "Список идентификаторов типов реквизитов, применимых к этой форме собственности", "example": [ 0 ] } }, "additionalProperties": false, "description": "Форма собственности (организационно-правовая форма) фирмы из справочника по стране.", "example": { "id": 1, "name": "Общество с ограниченной ответственностью", "name_eng": "Limited Liability Company", "short_name": "ООО", "short_name_eng": "LLC", "ownership_type": "LegalPerson", "ownership_type_name": "LegalPerson", "requisite_types": [ 0 ] } }, "billing-requisites__FirmAddressPublic": { "type": "object", "properties": { "address_id": { "type": "string", "description": "Идентификатор адреса. Можно передать пустой при создании — в ответе вернётся созданный ID.", "format": "uuid", "example": "5e7d4f3a-1234-5678-9abc-def012345678" }, "ati_id": { "type": [ "null", "string" ], "description": "Код фирмы в АТИ.", "example": "12345" }, "country_id": { "type": [ "null", "integer" ], "description": "Идентификатор страны. Значение берётся из метода `GET /v1.0/firms/requisites/countries`.\nПодставляйте поле `id` из ответа словаря.", "format": "int32", "example": 1 }, "region_id": { "type": [ "null", "integer" ], "description": "Идентификатор региона. Источник — внешний геосервис ATI (не из этого сервиса).", "format": "int32", "example": 77 }, "city_id": { "type": [ "null", "integer" ], "description": "Идентификатор города. Источник — внешний геосервис ATI (не из этого сервиса).", "format": "int32", "example": 1 }, "city_name": { "type": [ "null", "string" ], "description": "Название города.", "example": "Москва" }, "post_index": { "type": [ "null", "string" ], "description": "Почтовый индекс.", "example": "101000" }, "street_type_id": { "type": "integer", "description": "Тип улицы. Значение берётся из метода `GET /v1.0/firms/requisites/addressparts`\n(поле `street_types[].id`).", "format": "int32", "example": 1 }, "street_name": { "type": [ "null", "string" ], "description": "Улица.", "example": "Тверская" }, "house_no": { "type": [ "null", "string" ], "description": "Номер дома.", "example": "10" }, "part_no": { "type": [ "null", "string" ], "description": "Корпус дома. Разрешается вводить текст не более 10 символов, который должен начинаться\nс короткого значения из справочника частей строений (например, по шаблону `^корп\\..+$`).", "example": "корп.1" }, "litera": { "type": [ "null", "string" ], "description": "Литера. Формат: \"лит.\" + один или более символов (например: лит.А, лит.Б, лит.1).\nШаблон: `^лит\\..+$`.", "example": "лит.А" }, "office_no": { "type": [ "null", "string" ], "description": "Номер офиса.", "example": "501" }, "post_contact": { "type": [ "null", "string" ], "description": "Получатель почты.", "example": "Иванов И.И." }, "add_date": { "type": [ "null", "string" ], "description": "Дата добавления (UTC).", "format": "date-time", "example": "2024-01-15T10:30:00Z" }, "attributes": { "type": "integer", "description": "Атрибуты адреса. Битовая маска из `FirmAddressAttributes`.\nВозможные значения флагов:\n1 — UseThisAddressAsDefaultForMail,\n2 — Deleted,\n4 — IsLegalAddress,\n8 — IsPostAddress,\n16 — OriginalSignaturesRequired,\n32 — IsActualAddress.\nПримеры комбинаций: только юридический адрес — 4; только почтовый адрес — 8;\nуниверсальный адрес (юридический и почтовый) — 12.", "format": "int32", "example": 12 }, "formatted_text": { "type": [ "null", "string" ], "description": "Отформатированное строковое представление адреса.", "example": "101000, г. Москва, ул. Тверская, д.10, корп.1, лит.А, оф.501" } }, "additionalProperties": false, "description": "Адрес фирмы", "example": { "address_id": "5e7d4f3a-1234-5678-9abc-def012345678", "ati_id": "12345", "country_id": 1, "region_id": 77, "city_id": 1, "city_name": "Москва", "post_index": "101000", "street_type_id": 1, "street_name": "Тверская", "house_no": "10", "part_no": "корп.1", "litera": "лит.А", "office_no": "501", "post_contact": "Иванов И.И.", "add_date": "2024-01-15T10:30:00Z", "attributes": 12, "formatted_text": "101000, г. Москва, ул. Тверская, д.10, корп.1, лит.А, оф.501" } }, "billing-requisites__Signee": { "type": "object", "properties": { "signee_id": { "type": "string", "description": "Идентификатор подписанта.", "format": "uuid", "example": "5e7d4f3a-1234-5678-9abc-def012345678" }, "requisite_id": { "type": "string", "description": "Идентификатор реквизита, которому принадлежит эта запись.", "format": "uuid", "example": "6f8e5g4b-2345-6789-0bcd-ef0123456789" }, "full_name": { "type": [ "null", "string" ], "description": "ФИО (обязательно в родительном падеже).", "example": "Иванова Ивана Ивановича" }, "position": { "type": [ "null", "string" ], "description": "Должность (обязательно в родительном падеже).", "example": "генерального директора" }, "act_upon": { "type": [ "null", "string" ], "description": "На основании чего действует (обязательно в родительном падеже).", "example": "Устава" }, "is_default": { "type": "boolean", "description": "Выбирать по умолчанию.", "example": true }, "deletion_date": { "type": [ "null", "string" ], "description": "Дата удаления (UTC).", "format": "date-time", "example": "2024-12-31T00:00:00Z" }, "full_name_and_position": { "type": [ "null", "string" ], "description": "Поле, объединяющее ФИО и должность. Не является автовычисляемым (не конкатенация\n`FullName` и `Position`), хранится отдельно.", "example": "Генеральный директор Иванов И.И." } }, "additionalProperties": false, "description": "Подписант реквизита (лицо, действующее от имени фирмы).", "example": { "signee_id": "5e7d4f3a-1234-5678-9abc-def012345678", "requisite_id": "6f8e5g4b-2345-6789-0bcd-ef0123456789", "full_name": "Иванова Ивана Ивановича", "position": "генерального директора", "act_upon": "Устава", "is_default": true, "deletion_date": "2024-12-31T00:00:00Z", "full_name_and_position": "Генеральный директор Иванов И.И." } }, "billing-requisites__PersonPassport": { "type": "object", "properties": { "series": { "type": [ "null", "string" ], "description": "Серия паспорта.", "example": "4500" }, "number": { "type": [ "null", "string" ], "description": "Номер паспорта.", "example": "123456" }, "date_of_issue": { "type": "string", "description": "Дата выдачи паспорта (UTC).", "format": "date-time", "example": "2010-05-15T00:00:00Z" }, "department_code": { "type": [ "null", "string" ], "description": "Код подразделения, выдавшего паспорт.", "example": "770-001" }, "issued_by": { "type": [ "null", "string" ], "description": "Наименование органа, выдавшего паспорт.", "example": "ОВД района Замоскворечье г. Москвы" }, "registration": { "type": [ "null", "string" ], "description": "Адрес регистрации.", "example": "101000, г. Москва, ул. Тверская, д.10" }, "scan_files": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/billing-requisites__PersonPassportScanFile" }, "description": "Сканы страниц паспорта (опционально).", "example": [ { "link": "https://files.example.com/passport/123.pdf", "id": "file-abc-123", "size": 102400, "name": "passport_scan.pdf" } ] } }, "additionalProperties": false, "description": "Данные паспорта физического лица для реквизитов.", "example": { "series": "4500", "number": "123456", "date_of_issue": "2010-05-15T00:00:00Z", "department_code": "770-001", "issued_by": "ОВД района Замоскворечье г. Москвы", "registration": "101000, г. Москва, ул. Тверская, д.10", "scan_files": [ { "link": "https://files.example.com/passport/123.pdf", "id": "file-abc-123", "size": 102400, "name": "passport_scan.pdf" } ] } }, "billing-requisites__AddressPartItem": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор элемента адреса.", "format": "int32", "example": 1 }, "name": { "type": [ "null", "string" ], "description": "Полное название элемента адреса.", "example": "проспект" }, "short_name": { "type": [ "null", "string" ], "description": "Короткое название элемента адреса.", "example": "пр-кт" } }, "additionalProperties": false, "description": "Элемент справочника частей адреса (тип улицы, тип строения и т.п.).", "example": { "id": 1, "name": "проспект", "short_name": "пр-кт" } }, "billing-requisites__PersonPassportScanFile": { "type": "object", "properties": { "link": { "type": [ "null", "string" ], "description": "Ссылка на файл скана.", "example": "https://files.example.com/passport/123.pdf" }, "id": { "type": [ "null", "string" ], "description": "Идентификатор файла в хранилище.", "example": "file-abc-123" }, "size": { "type": "integer", "description": "Размер файла в байтах.", "format": "int32", "example": 102400 }, "name": { "type": [ "null", "string" ], "description": "Имя файла (как сохранён в хранилище).", "example": "passport_scan.pdf" } }, "additionalProperties": false, "description": "Файл со сканом страницы паспорта.", "example": { "link": "https://files.example.com/passport/123.pdf", "id": "file-abc-123", "size": 102400, "name": "passport_scan.pdf" } }, "GeoService.Dictionaries.Models.AutoComplete.CityGeoObject": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор географического объекта", "format": "int32" }, "name": { "type": "string", "description": "Название географического объекта" }, "short_name": { "type": "string", "description": "Короткое название географического объекта", "nullable": true }, "city_type": { "required": [ "city_type_id", "name", "short_name" ], "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.CityType" } ], "description": "Тип нас. пункта", "nullable": true }, "old_name": { "type": "string", "description": "Старое название\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "alt_name": { "type": "string", "description": "Альтернативное название\r\n\nЗначение по умолчанию: `null`", "nullable": true } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.AutoComplete.SimpleGeoObject": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор географического объекта", "format": "int32" }, "name": { "type": "string", "description": "Название географического объекта" }, "short_name": { "type": "string", "description": "Короткое название географического объекта", "nullable": true } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.AutoComplete.SubdistrictGeoObject": { "type": "object", "properties": { "name": { "type": "string", "description": "Название части района" }, "short_name": { "type": "string", "description": "Короткое название части района" } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.AutoComplete.Suggestion": { "type": "object", "properties": { "type": { "enum": [ 1, 2, 4, 8 ], "type": "integer", "description": "Тип элемента для автокомплита. В запросе может быть маской, в ответе не может быть маской.\r\n\nЗначение по умолчанию: `1`

Members:

", "format": "int32" }, "direction": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SimpleGeoObject" } ], "description": "Направление\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "country": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SimpleGeoObject" } ], "description": "Страна\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "region": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SimpleGeoObject" } ], "description": "Регион\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "districts": { "type": "array", "items": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SimpleGeoObject" }, "description": "Районы\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "subdistrict": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.SubdistrictGeoObject" } ], "description": "Часть района\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "city": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.CityGeoObject" } ], "description": "Населённый пункт\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "address": { "type": "string", "description": "Адрес" }, "geo_point": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoPointResponse" } ], "description": "Координаты объекта", "nullable": true } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.AutoComplete.SuggestionsRequest": { "required": [ "prefix" ], "type": "object", "properties": { "prefix": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Поисковая строка", "example": "санкт" }, "suggestion_types": { "enum": [ 1, 2, 4, 8 ], "type": "integer", "description": "Тип элемента для автокомплита. В запросе может быть маской, в ответе не может быть маской.\r\n\nЗначение по умолчанию: `1`

Members:

", "format": "int32", "example": 15 }, "limit": { "maximum": 50, "minimum": 1, "type": "integer", "description": "Сколько элементов нужно вернуть пользователю\r\n\nЗначение по умолчанию: `10`", "format": "int32", "nullable": true, "example": 15 }, "country_id": { "type": "integer", "description": "Страна по умолчанию для сортировки объектов. Объекты из этой страны будут наверху списка.\r\n\nЕсли не передать или передать `null`, то для залогиненного пользователя настройка возьмется из кабинета.\nЗначение по умолчанию: `null`", "format": "int32", "nullable": true, "example": 1 } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.AutoComplete.SuggestionsResponse": { "type": "object", "properties": { "suggestions": { "type": "array", "items": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.AutoComplete.Suggestion" } } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Requests.GeoCoding.BoundingBox": { "type": "object", "properties": { "sw": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoPointRequest" } ], "description": "Точка, обозначающая нижний левый угол области поиска." }, "ne": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoPointRequest" } ], "description": "Точка, обозначающая верхний правый угол области поиска." } }, "additionalProperties": false, "description": "Область поиска. Задается координатами нижнего левого угла и верхнего правого.\r\n\nЗначение по умолчанию: `null`" }, "GeoService.Dictionaries.Models.Requests.GeoCoding.GetGeoCodingDirectRequest": { "required": [ "address", "max_level" ], "type": "object", "properties": { "address": { "maxLength": 1024, "minLength": 0, "type": "string", "description": "Адресная строка.", "example": "Россия, Ленинградская область, Гатчинский муниципальный округ, Вырица, Вокзальная улица, д. 23" }, "exact_in_bounding_box": { "type": "boolean", "description": "Флаг, указывающий, что искать объекты нужно строго в области, обозначенной в параметре bounding_box.\r\nДля true вне области не ищем. Для false приоритет для объектов внутри области.\r\nЕсли true, то обязательно передавать bounding_box.\n\r\nЗначение по умолчанию: `false`\n\r\n! Зарезервирован на будущее, сейчас не используется.", "nullable": true, "example": false }, "max_level": { "maximum": 5, "minimum": 1, "type": "integer", "description": "Максимальный уровень, до которого необходимо провести гео-кодирование.\r\n\n\r\nВозможные значения\r\n\n\r\n1 — страна\n\r\n2 — область/регион\n\r\n3 — населённый пункт\n\r\n4 — улица\n\r\n5 — дом\r\n", "format": "int32", "example": 3 }, "bounding_box": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoCoding.BoundingBox" } ], "description": "Область поиска. Задается координатами нижнего левого угла и верхнего правого.\n\r\nЗначение по умолчанию: `null`", "nullable": true }, "count": { "maximum": 10, "minimum": 1, "type": "integer", "description": "Ограничение количества элементов в выдаче.\n\r\nДиапазон значений от `1` до `10`.\n\r\nЗначение по умолчанию: `1`", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Запрос на гео-кодирование по адресной строке" }, "GeoService.Dictionaries.Models.Requests.GeoCoding.GetReverseGeoCodingRequest": { "required": [ "location", "max_level" ], "type": "object", "properties": { "location": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoPointRequest" } ], "description": "Координаты точки, от которой необходимо провести обратное гео-кодирование." }, "max_level": { "type": "integer", "description": "Максимальный уровень, до которого необходимо провести гео-кодирование.\r\n\n\r\nВозможные значения\r\n\n\r\n1 — страна\n\r\n2 — область/регион\n\r\n3 — населённый пункт\n\r\n4 — улица\n\r\n5 — дом\r\n", "format": "int32", "nullable": true, "example": 3 }, "count": { "type": "integer", "description": "Ограничение количества элементов в выдаче.\n\r\nДиапазон значений от `1` до `10`.\n\r\nЗначение по умолчанию: `1`", "format": "int32", "example": 1 } }, "additionalProperties": false, "description": "Модель, представляющая настройки обратного гео-кодирования" }, "GeoService.Dictionaries.Models.Requests.GeoPointRequest": { "required": [ "lat", "lon" ], "type": "object", "properties": { "lat": { "type": "number", "description": "Широта", "format": "double", "example": 59.93904 }, "lon": { "type": "number", "description": "Долгота", "format": "double", "example": 30.31581 } }, "additionalProperties": false, "description": "Координаты" }, "GeoService.Dictionaries.Models.Requests.GetCitiesByGarIdsRequest": { "required": [ "fias_ids" ], "type": "object", "properties": { "fias_ids": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Список идентификаторов ФИАС населённых пунктов\r\n\nДопустимое количество элементов от 1 до 1000", "example": [ "c2deb16a-0330-4f05-821f-1d09c93331e6", "0c5b2444-70a0-4932-980c-b4dc0d3f02b5" ] } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Requests.GetCitiesByIdsRequest": { "required": [ "ids" ], "type": "object", "properties": { "ids": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Список идентификаторов населённых пунктов (кодов ATI.SU)\r\n\nДопустимое количество элементов от 1 до 1000", "example": [ 1, 3611 ] } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Requests.GetCitiesByKladrCodesRequest": { "required": [ "kladr_codes" ], "type": "object", "properties": { "kladr_codes": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Список идентификаторов КЛАДР населённых пунктов\r\n\nДопустимое количество элементов от 1 до 1000", "example": [ "7800000000000", "7700000000000" ] } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Requests.GetCountriesByIdsRequest": { "required": [ "ids" ], "type": "object", "properties": { "ids": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Список идентификаторов стран (кодов ATI.SU)\r\n\nДопустимое количество элементов от 1 до 1000", "example": [ 1, 50 ] } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Requests.GetDistrictsByIdsRequest": { "required": [ "ids" ], "type": "object", "properties": { "ids": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Список идентификаторов районов (кодов ATI.SU)\r\n\nДопустимое количество элементов от 1 до 1000", "example": [ 8456, 8464, 6857 ] } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Requests.GetRegionsByGarIdsRequest": { "required": [ "fias_ids" ], "type": "object", "properties": { "fias_ids": { "uniqueItems": true, "type": "array", "items": { "type": "string", "format": "uuid" }, "description": "Список идентификаторов ФИАС регионов\r\n\nДопустимое количество элементов от 1 до 1000", "example": [ "6d1ebb35-70c6-4129-bd55-da3969658f5d", "29251dcf-00a1-4e34-98d4-5c47484a36d4" ] } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Requests.GetRegionsByIdsRequest": { "required": [ "ids" ], "type": "object", "properties": { "ids": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Список идентификаторов регионов (кодов ATI.SU)", "example": [ 1, 680, 681 ] } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Requests.ReverseGeoCodingRequest": { "required": [ "location" ], "type": "object", "properties": { "location": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Requests.GeoPointRequest" } ], "description": "Координаты" } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Responses.City": { "required": [ "city_id", "clarified_name", "country_id", "name", "size" ], "type": "object", "properties": { "city_id": { "type": "integer", "description": "Идентификатор населённого пункта", "format": "int32", "readOnly": true }, "country_id": { "type": "integer", "description": "Идентификатор страны", "format": "int32" }, "federal_district_id": { "type": "integer", "description": "Идентификатор федерального округа\r\n\nЗначение по умолчанию: `null`", "format": "int32", "nullable": true }, "region_id": { "type": "integer", "description": "Идентификатор региона\r\n\nЗначение по умолчанию: `null`", "format": "int32", "nullable": true }, "district_ids": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Идентификаторы районов\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "name": { "type": "string", "description": "Название населённого пункта" }, "alt_name": { "type": "string", "description": "Альтернативное название населённого пункта\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "old_name": { "type": "string", "description": "Старое название населённого пункта\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "subdistrict": { "type": "string", "description": "Часть района\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "short_subdistrict": { "type": "string", "description": "Часть района с сокращениями типа\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "fias_id": { "type": "string", "description": "Идентификатор ФИАС\r\n\nЗначение по умолчанию: `null`", "format": "uuid", "nullable": true }, "kladr": { "type": "string", "description": "Идентификатор КЛАДР\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "okato": { "type": "string", "description": "Код ОКАТО\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "oktmo": { "type": "string", "description": "Код ОКТМО\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "is_regional_center": { "type": "boolean", "description": "Является ли населённый пункт региональным центром\r\n\nЗначение по умолчанию: `false`" }, "is_district_center": { "type": "boolean", "description": "Является ли населённый пункт районным центром\r\n\nЗначение по умолчанию: `false`" }, "size": { "enum": [ 1, 2, 3, 4, 5, 6 ], "type": "integer", "description": "Размер населённого пункта.

Members:

Members:

", "format": "int32" }, "geo_point": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoPointResponse" } ], "description": "Координаты\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "city_type_id": { "type": "integer", "description": "Идентификатор типа населённого пункта\r\n\nЗначение по умолчанию: `null`", "format": "int32", "nullable": true }, "timezone": { "type": "string", "description": "Часовой пояс в формате IANA.\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "clarified_name": { "type": "string", "description": "Название населённого пункта с уточнением типа и района при необходимости\r\nЕсли в регионе несколько населённых пунктов с одинаковым названием, то для них добавляется уточнение" }, "legacy_attributes": { "type": "integer", "description": "Атрибуты устаревшей записи населённого пункта\r\n\nВозвращаются только для населенных пунктов, помеченных как `is_legacy=true`.\nЗначение по умолчанию: `null`", "format": "int32", "nullable": true }, "is_legacy": { "type": "boolean", "description": "Флаг, обозначающий, что объект является устаревшим\r\n\nЗначение по умолчанию: `false`" } }, "additionalProperties": false, "description": "Модель, описывающая сущность \"Населённый пункт\"" }, "GeoService.Dictionaries.Models.Responses.CityType": { "required": [ "city_type_id", "name", "short_name" ], "type": "object", "properties": { "city_type_id": { "type": "integer", "description": "Идентификатор типа населённого пункта", "format": "int32" }, "name": { "type": "string", "description": "Название типа" }, "short_name": { "type": "string", "description": "Сокращённое название типа" } }, "additionalProperties": false, "description": "Модель, описывающая сущность \"Тип населённого пункта\"" }, "GeoService.Dictionaries.Models.Responses.Country": { "required": [ "country_id", "iso_3166_alpha2", "iso_3166_alpha3", "iso_3166_numeric", "name" ], "type": "object", "properties": { "country_id": { "type": "integer", "description": "Идентификатор страны", "format": "int32" }, "name": { "type": "string", "description": "Название страны" }, "iso_3166_alpha2": { "type": "string", "description": "Двухбуквенный код страны по ISO-3166" }, "iso_3166_alpha3": { "type": "string", "description": "Трехбуквенный код страны по ISO-3166" }, "iso_3166_numeric": { "type": "integer", "description": "Числовой код страны по ISO-3166", "format": "int32" }, "is_legacy": { "type": "boolean", "description": "Флаг, обозначающий, что объект является устаревшим.\r\n\nЗначение по умолчанию: `false`" } }, "additionalProperties": false, "description": "Модель, описывающая сущность \"Страна\"" }, "GeoService.Dictionaries.Models.Responses.Direction": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор направления", "format": "int32" }, "name": { "type": "string", "description": "Описание направления" } }, "additionalProperties": false, "description": "Направление \"Север\", \"Юг\" и т.д." }, "GeoService.Dictionaries.Models.Responses.DirectionResponse": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор направления. Может быть битовой маской", "format": "int32" }, "name": { "type": "string", "description": "Описание направления. Может быть перечислением направлений" } }, "additionalProperties": false, "description": "Направление \"Север\", \"Юг\" и т.д." }, "GeoService.Dictionaries.Models.Responses.District": { "required": [ "country_id", "district_id", "name", "short_name" ], "type": "object", "properties": { "district_id": { "type": "integer", "description": "Идентификатор района", "format": "int32" }, "country_id": { "type": "integer", "description": "Идентификатор страны", "format": "int32" }, "federal_district_id": { "type": "integer", "description": "Идентификатор федерального округа\r\n\nЗначение по умолчанию: `null`", "format": "int32", "nullable": true }, "name": { "type": "string", "description": "Название района" }, "short_name": { "type": "string", "description": "Название района с сокращениями типа" }, "region_id": { "type": "integer", "description": "Идентификатор региона\r\n\nЗначение по умолчанию: `null`", "format": "int32", "nullable": true } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Responses.FederalDistrict": { "required": [ "country_id", "federal_district_id", "name" ], "type": "object", "properties": { "federal_district_id": { "type": "integer", "description": "Идентификатор фед. округа", "format": "int32" }, "country_id": { "type": "integer", "description": "Идентификатор страны", "format": "int32" }, "name": { "type": "string", "description": "Название федерального округа" }, "is_legacy": { "type": "boolean", "description": "Флаг, обозначающий, что объект является устаревшим.\r\n\nЗначение по умолчанию: `false`" } }, "additionalProperties": false, "description": "Модель, описывающая сущность \"Федеральный округ\"" }, "GeoService.Dictionaries.Models.Responses.GeoCoding.AddressElement": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор географического объекта", "format": "int32" }, "name": { "type": "string", "description": "Название географического объекта" }, "short_name": { "type": "string", "description": "Короткое название географического объекта", "nullable": true } }, "additionalProperties": false, "description": "Идентификатор и название элемента адреса" }, "GeoService.Dictionaries.Models.Responses.GeoCoding.CityElement": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор населённого пункта", "format": "int32" }, "name": { "type": "string", "description": "Название населённого пункта" }, "city_type": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.CityType" } ], "description": "Тип населённого пункта" } }, "additionalProperties": false, "description": "Название, идентификатор и тип населённого пункта населённого пункта" }, "GeoService.Dictionaries.Models.Responses.GeoCoding.CityType": { "type": "object", "properties": { "city_type_id": { "type": "integer", "description": "Идентификатор типа населённого пункта", "format": "int32" }, "name": { "type": "string", "description": "Название типа населённого пункта" }, "short_name": { "type": "string", "description": "Короткое название типа населённого пункта" } }, "additionalProperties": false, "description": "Тип населённого пункта" }, "GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingResponse": { "type": "object", "properties": { "max_count_exceeded": { "type": "boolean", "description": "Флаг, указывающий, что найдено больше результатов, чем просили в параметре count и требуется уточнение.\r\n\nЗначение по умолчанию: `false`" }, "uncertainty_score": { "type": "integer", "description": "Минимальная степень неуверенности в точности распознавания среди всех результатов.", "format": "int32" }, "uncertainty_reasons": { "type": "array", "items": { "type": "string" }, "description": "Ошибки распознавания, которые приводят к тому, что нельзя быть на 100% уверенными в результате" }, "suggestions": { "type": "array", "items": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingSuggestion" }, "description": "Распознанные адреса" } }, "additionalProperties": false, "description": "Результат гео-кодирования" }, "GeoService.Dictionaries.Models.Responses.GeoCoding.GeoCodingSuggestion": { "required": [ "address", "level", "uncertainty_reasons", "uncertainty_score" ], "type": "object", "properties": { "uncertainty_score": { "type": "integer", "description": "Степень неуверенности в точности распознавания. Рассчитывается как сумма весов ошибок распознавания из поля uncertainty_reasons. 0 - абсолютно уверены.", "format": "int32" }, "uncertainty_reasons": { "type": "array", "items": { "type": "string" }, "description": "Ошибки распознавания, которые приводят к тому, что нельзя быть на 100% уверенными в результате." }, "address": { "type": "string", "description": "Адресная строка до уровня, до которого удалось распознать", "readOnly": true }, "level": { "type": "integer", "description": "Уровень, до которого удалось распознать\r\n\n\r\nВозможные значения\r\n\n\r\n1 — страна\n\r\n2 — область/регион\n\r\n3 — населённый пункт\n\r\n4 — улица\n\r\n5 — дом\r\n", "format": "int32" }, "country": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.AddressElement" } ], "description": "Название и идентификатор страны\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "region": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.AddressElement" } ], "description": "Название и идентификатор региона\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "districts": { "type": "array", "items": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.AddressElement" }, "description": "Районы\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "subdistrict": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.SubdistrictElement" } ], "description": "Часть района\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "city": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.CityElement" } ], "description": "Название, идентификатор и тип населённого пункта населённого пункта\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "geo_point": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoPointResponse" } ], "description": "Координаты объекта, который удалось распознать\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "name": { "type": "string", "description": "Название для именованных объектов (магазины, склады, месторождения и т.п.)\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "street": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.StreetElement" } ], "description": "Название и идентификатор улицы\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "house": { "allOf": [ { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.GeoCoding.AddressElement" } ], "description": "Номер и идентификатор дома/строения\r\n\nЗначение по умолчанию: `null`", "nullable": true } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Responses.GeoCoding.StreetElement": { "type": "object", "properties": { "name": { "type": "string", "description": "Название улицы" }, "short_name": { "type": "string", "description": "Название улицы с коротким типом" } }, "additionalProperties": false, "description": "Название и идентификатор улицы" }, "GeoService.Dictionaries.Models.Responses.GeoCoding.SubdistrictElement": { "type": "object", "properties": { "name": { "type": "string", "description": "Название части района" }, "short_name": { "type": "string", "description": "Короткое название части района" } }, "additionalProperties": false, "description": "" }, "GeoService.Dictionaries.Models.Responses.GeoPointResponse": { "type": "object", "properties": { "lat": { "type": "number", "description": "Широта", "format": "double" }, "lon": { "type": "number", "description": "Долгота", "format": "double" } }, "additionalProperties": false, "description": "Координаты" }, "GeoService.Dictionaries.Models.Responses.GetCitiesResponse": { "required": [ "cities" ], "type": "object", "properties": { "cities": { "type": "array", "items": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.City" } } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Responses.GetCityTypesResponse": { "required": [ "city_types" ], "type": "object", "properties": { "city_types": { "type": "array", "items": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.CityType" } } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Responses.GetCountriesResponse": { "required": [ "countries" ], "type": "object", "properties": { "countries": { "type": "array", "items": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Country" } } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Responses.GetDirectionsResponse": { "required": [ "directions" ], "type": "object", "properties": { "directions": { "type": "array", "items": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Direction" } } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Responses.GetDistrictsResponse": { "required": [ "districts" ], "type": "object", "properties": { "districts": { "type": "array", "items": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.District" } } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Responses.GetFederalDistrictsResponse": { "required": [ "federal_districts" ], "type": "object", "properties": { "federal_districts": { "type": "array", "items": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.FederalDistrict" } } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Responses.GetRegionsResponse": { "required": [ "regions" ], "type": "object", "properties": { "regions": { "type": "array", "items": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Responses.Region" } } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Responses.Region": { "required": [ "clarified_name", "country_id", "name", "region_id" ], "type": "object", "properties": { "region_id": { "type": "integer", "description": "Идентификатор региона", "format": "int32" }, "name": { "type": "string", "description": "Название региона" }, "country_id": { "type": "integer", "description": "Идентификатор страны", "format": "int32" }, "federal_district_id": { "type": "integer", "description": "Идентификатор федерального округа\r\n\nЗначение по умолчанию: `null`", "format": "int32", "nullable": true }, "fias_id": { "type": "string", "description": "Идентификатор ФИАС\r\n\nЗначение по умолчанию: `null`", "format": "uuid", "nullable": true }, "tax_region_code": { "type": "string", "description": "Код региона для ФНС.\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "clarified_name": { "type": "string", "description": "Название региона с уточнением, что это регион при необходимости.\r\nЕсли название региона совпадает с каким-нибудь городом, то для него добавляется уточнение." }, "regional_center_id": { "type": "integer", "description": "Идентификатор регионального центра\r\n\nЗначение по умолчанию: `null`", "format": "int32", "nullable": true }, "is_legacy": { "type": "boolean", "description": "Флаг, обозначающий, что объект является устаревшим.\r\n\nЗначение по умолчанию: `false`" } }, "additionalProperties": false, "description": "Модель, описывающая сущность \"Регион\"" }, "GeoService.Dictionaries.Models.Validation.SingleErrorResponse": { "type": "object", "properties": { "error": { "type": "string", "description": "Текстовый код ошибки" }, "reason": { "type": "string", "description": "Человекочитаемое описание ошибки" }, "details": { "type": "object", "additionalProperties": {}, "description": "Дополнительная информация об ошибке", "nullable": true } }, "additionalProperties": false }, "GeoService.Dictionaries.Models.Validation.ValidationErrorResponse": { "type": "object", "properties": { "error": { "type": "string", "readOnly": true }, "reason": { "type": "string", "readOnly": true }, "error_list": { "type": "array", "items": { "$ref": "#/components/schemas/GeoService.Dictionaries.Models.Validation.SingleErrorResponse" } }, "details": { "type": "object", "additionalProperties": {}, "nullable": true } }, "additionalProperties": false }, "InternalLocationsParseDto": { "items": { "type": "string" }, "type": "array" }, "PublicGeoParserResultView": { "properties": { "city_id": { "description": "Id города", "format": "int32", "type": "integer" }, "is_success": { "description": "Геокодирование завершено успешно", "type": "boolean" }, "street": { "description": "Улица/район", "type": "string" } }, "required": [ "is_success" ], "type": "object" }, "DocflowMetaSchema": { "title": "DocflowMetaSchema", "required": [ "id", "state", "participants", "flags", "history", "driver_data", "payment_history", "astral_stand" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "state": { "$ref": "#/components/schemas/DocflowStates" }, "participants": { "$ref": "#/components/schemas/ParticipantsSchema" }, "flags": { "title": "Flags", "type": "array", "items": { "type": "string" }, "description": "Список флагов" }, "history": { "title": "History", "type": "array", "items": { "$ref": "#/components/schemas/DocflowMetaHistorySchema" } }, "driver_data": { "$ref": "#/components/schemas/DriverData" }, "number": { "title": "Number", "type": "string", "description": "Номер ЭТРН" }, "date": { "title": "Date", "pattern": "^(3[01]|[12][0-9]|0[1-9])\\.(1[012]|0[1-9])\\.(2\\d{3})$", "type": "string", "description": "Дата заполнения ЭТРН", "example": "01.04.2023" }, "payment_history": { "title": "Payment History", "allOf": [ { "$ref": "#/components/schemas/PaymentHistory" } ], "description": "История платежей" }, "astral_stand": { "allOf": [ { "$ref": "#/components/schemas/AstralStandsEnum" } ], "description": "Используемый стенд Астрала" }, "template_name": { "title": "Template Name", "type": "string", "description": "Имя шаблона" } }, "description": "Общая информация о документообороте" }, "SignatoryCredentialsGenerateSchema": { "title": "SignatoryCredentialsGenerateSchema", "required": [ "certificate_id" ], "type": "object", "properties": { "certificate_id": { "title": "Certificate Id", "type": "string", "description": "Идентификатор сертификата" }, "power_of_attorney_id": { "title": "Power Of Attorney Id", "type": "string", "description": "Идентификатор МЧД" } }, "description": "Схема тела запроса для генерации xml, необходимая для генерации\nполномочий подписанта" }, "Body_upload_title_1_body_from_xml_etrn_v1_docflows__docflow_id__titles_title_1_xml_put": { "title": "Body_upload_title_1_body_from_xml_etrn_v1_docflows__docflow_id__titles_title_1_xml_put", "required": [ "document" ], "type": "object", "properties": { "document": { "title": "Document", "type": "string", "description": "XML файл первого титула, кодировка берётся из XML-декларации", "format": "binary" } } }, "Body_upload_title_2_body_from_xml_etrn_v1_docflows__docflow_id__titles_title_2_xml_put": { "title": "Body_upload_title_2_body_from_xml_etrn_v1_docflows__docflow_id__titles_title_2_xml_put", "required": [ "document" ], "type": "object", "properties": { "document": { "title": "Document", "type": "string", "description": "XML файл второго титула, кодировка берётся из XML-декларации", "format": "binary" } } }, "Body_upload_title_3_body_from_xml_etrn_v1_docflows__docflow_id__titles_title_3_xml_put": { "title": "Body_upload_title_3_body_from_xml_etrn_v1_docflows__docflow_id__titles_title_3_xml_put", "required": [ "document" ], "type": "object", "properties": { "document": { "title": "Document", "type": "string", "description": "XML файл третьего титула, кодировка берётся из XML-декларации", "format": "binary" } } }, "Body_upload_title_4_body_from_xml_etrn_v1_docflows__docflow_id__titles_title_4_xml_put": { "title": "Body_upload_title_4_body_from_xml_etrn_v1_docflows__docflow_id__titles_title_4_xml_put", "required": [ "document" ], "type": "object", "properties": { "document": { "title": "Document", "type": "string", "description": "XML файл четвёртого титула, кодировка берётся из XML-декларации", "format": "binary" } } }, "Body_send_title_1_etrn_v1_docflows__docflow_id__titles_title_1_send_post": { "title": "Body_send_title_1_etrn_v1_docflows__docflow_id__titles_title_1_send_post", "required": [ "document", "sign" ], "type": "object", "properties": { "document": { "title": "Document", "type": "string", "description": "XML файл документа.", "format": "binary" }, "sign": { "title": "Sign", "type": "string", "description": "base64 подпись документа (detached)" } } }, "NullableTitle2DraftData": { "title": "NullableTitle2DraftData", "type": "object", "properties": { "верс_форм": { "title": "ВерсФорм", "enum": [ "5.01" ], "type": "string", "default": "5.01" }, "ид_пол_иной": { "title": "ИдПолИной", "type": "array", "items": { "maxLength": 46, "minLength": 4, "type": "string" }, "default": [] }, "документ": { "title": "Документ", "allOf": [ { "$ref": "#/components/schemas/app__core__schemas__title_2_schema__NullableType8" } ] } } }, "Nullable______": { "properties": { "фамилия": { "type": "string", "maxLength": 60, "minLength": 1, "nullable": true, "title": "Фамилия" }, "имя": { "type": "string", "maxLength": 60, "minLength": 1, "nullable": true, "title": "Имя" }, "отчество": { "type": "string", "maxLength": 60, "minLength": 1, "nullable": true, "title": "Отчество" } }, "type": "object", "title": "NullableФИОТип" }, "app__core__schemas__title_2_schema__NullableType8": { "title": "NullableType8", "type": "object", "properties": { "кнд": { "title": "КНД", "enum": [ "1110340" ], "type": "string", "default": "1110340" }, "сод_инф_прв_прием": { "title": "СодИнфПрвПрием", "allOf": [ { "$ref": "#/components/schemas/app__core__schemas__title_2_schema__NullableType5" } ] } } }, "app__core__schemas__title_2_schema__NullableType3": { "title": "NullableType3", "type": "object", "properties": { "факт_кол_ед_изм": { "title": "ФактКолЕдИзм", "maxLength": 255, "minLength": 1, "type": "string" }, "итог_разм_штр_рф": { "title": "ИтогРазмШтрРФ", "type": "number" }, "код_окв": { "title": "КодОКВ", "maxLength": 3, "minLength": 3, "pattern": "[0-9]{3}", "type": "string" }, "наим_окв": { "title": "НаимОКВ", "maxLength": 100, "minLength": 1, "type": "string" }, "итог_разм_штр_ин": { "title": "ИтогРазмШтрИн", "type": "number" }, "дата_курс_вал": { "title": "ДатаКурсВал", "maxLength": 10, "minLength": 10, "pattern": "(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})", "type": "string" }, "курс_вал": { "title": "КурсВал", "type": "number" }, "расч_штр": { "title": "РасчШтр", "maxLength": 1000, "minLength": 1, "type": "string" } } }, "app__core__schemas__title_2_schema__NullableType4": { "title": "NullableType4", "type": "object", "properties": { "дат_вр_отмет": { "title": "ДатВрОтмет", "maxLength": 25, "minLength": 25, "pattern": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))", "type": "string" }, "нал_коор_точ_вр_отм": { "title": "НалКоорТочВрОтм", "enum": [ "0", "1" ], "type": "string" }, "обст_отмет": { "title": "ОбстОтмет", "maxLength": 2000, "minLength": 1, "type": "string" }, "отм_акт_взв": { "title": "ОтмАктВзв", "maxLength": 1000, "minLength": 1, "type": "string" }, "св_акт": { "title": "СвАкт", "type": "array", "items": { "$ref": "#/components/schemas/app__core__schemas__titles_common__NullableRekvDocTip" }, "default": [] }, "разм_штр": { "title": "РазмШтр", "type": "array", "items": { "$ref": "#/components/schemas/app__core__schemas__title_2_schema__NullableType3" }, "default": [] }, "инф_пол": { "title": "ИнфПол", "type": "array", "items": { "$ref": "#/components/schemas/app__core__schemas__titles_common__NullableInfPolTip" }, "default": [] } } }, "app__core__schemas__title_2_schema__NullableType5": { "title": "NullableType5", "type": "object", "properties": { "зам_прв_прием": { "title": "ЗамПрвПрием", "allOf": [ { "$ref": "#/components/schemas/app__core__schemas__title_2_schema__NullableType2" } ] }, "отмет_прв_прием": { "title": "ОтметПрвПрием", "type": "array", "items": { "$ref": "#/components/schemas/app__core__schemas__title_2_schema__NullableType4" }, "default": [] }, "инф_пол": { "title": "ИнфПол", "type": "array", "items": { "$ref": "#/components/schemas/app__core__schemas__titles_common__NullableInfPolTip" }, "default": [] } } }, "app__core__schemas__titles_common__NullableRekvDocTip": { "title": "NullableРеквДокТип", "type": "object", "properties": { "наим_док": { "title": "НаимДок", "maxLength": 255, "minLength": 1, "type": "string" }, "номер_док": { "title": "НомерДок", "maxLength": 255, "minLength": 1, "type": "string" }, "дата_док": { "title": "ДатаДок", "maxLength": 10, "minLength": 10, "pattern": "(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})", "type": "string" }, "ид_док": { "title": "ИдДок", "maxLength": 255, "minLength": 1, "type": "string" }, "доп_свед_док": { "title": "ДопСведДок", "maxLength": 2000, "minLength": 1, "type": "string" }, "ид_рек_сост": { "title": "ИдРекСост", "type": "array", "items": { "$ref": "#/components/schemas/app__core__schemas__titles_common__NullableIdRekSostTip" } } } }, "app__core__schemas__titles_common__NullableInfPolTip": { "title": "NullableИнфПолТип", "type": "object", "ид_файл_инф_пол": { "title": "ИдФайлИнфПол", "maxLength": 36, "minLength": 36, "type": "string" }, "текст_инф": { "title": "ТекстИнф", "type": "array", "items": { "$ref": "#/components/schemas/app__core__schemas__titles_common__NullableTextInfTip" }, "default": [] } }, "app__core__schemas__title_2_schema__NullableType2": { "title": "NullableType2", "type": "object", "properties": { "зам_дат_вр_приб": { "title": "ЗамДатВрПриб", "maxLength": 25, "minLength": 25, "pattern": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))", "type": "string" }, "нал_коор_точ_вр_прб": { "title": "НалКоорТочВрПрб", "enum": [ "0", "1" ], "type": "string" }, "зам_дат_вр_убыт": { "title": "ЗамДатВрУбыт", "maxLength": 25, "minLength": 25, "pattern": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))", "type": "string" }, "нал_коор_точ_вр_уб": { "title": "НалКоорТочВрУб", "enum": [ "0", "1" ], "type": "string" }, "зам_дат_вр_пос_прием": { "title": "ЗамДатВрПосПрием", "maxLength": 25, "minLength": 25, "pattern": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))", "type": "string" }, "нал_коор_точ_вр_прм": { "title": "НалКоорТочВрПрм", "enum": [ "0", "1" ], "type": "string" }, "зам_сост_груз": { "title": "ЗамСостГруз", "maxLength": 10000, "minLength": 1, "type": "string" }, "зам_масс": { "title": "ЗамМасс", "maxLength": 1000, "minLength": 1, "type": "string" }, "зам_кол_мест": { "title": "ЗамКолМест", "maxLength": 1000, "minLength": 1, "type": "string" }, "зам_погр_раб": { "title": "ЗамПогрРаб", "maxLength": 1000, "minLength": 1, "type": "string" }, "инф_пол": { "title": "ИнфПол", "type": "array", "items": { "$ref": "#/components/schemas/app__core__schemas__titles_common__NullableInfPolTip" }, "default": [] } } }, "app__core__schemas__titles_common__NullableIdRekSostTip": { "title": "NullableИдРекСостТип", "type": "object", "properties": { "иннюл": { "title": "ИННЮЛ", "maxLength": 10, "minLength": 10, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}", "type": "string" }, "иннфл": { "title": "ИННФЛ", "maxLength": 12, "minLength": 12, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}", "type": "string" }, "данн_ино": { "title": "ДаннИно", "allOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_common__NullableSvInNeUchTrNTip" } ] }, "наим_оив": { "title": "НаимОИВ", "maxLength": 255, "minLength": 1, "type": "string" } } }, "app__core__schemas__titles_common__NullableTextInfTip": { "title": "NullableТекстИнфТип", "type": "object", "properties": { "идентиф": { "title": "Идентиф", "maxLength": 50, "minLength": 1, "type": "string" }, "значение": { "title": "Значение", "maxLength": 2000, "minLength": 1, "type": "string" } } }, "app__core__schemas__titles_common__NullableSvInNeUchTrNTip": { "title": "NullableСвИнНеУчТрНТип", "type": "object", "properties": { "ид_стат": { "title": "ИдСтат", "enum": [ "ЮЛ", "ФЛ" ], "type": "string" }, "стран": { "title": "Стран", "maxLength": 255, "minLength": 1, "type": "string" }, "наим": { "title": "Наим", "maxLength": 1000, "minLength": 1, "type": "string" }, "идентиф": { "title": "Идентиф", "maxLength": 255, "minLength": 1, "type": "string" }, "иные_свед": { "title": "ИныеСвед", "maxLength": 255, "minLength": 1, "type": "string" }, "уд_личн_ин_фл": { "title": "УдЛичнИнФЛ", "allOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_common__NullableUdLihnInFLTip" } ] } } }, "app__core__schemas__titles_common__NullableUdLihnInFLTip": { "title": "NullableУдЛичнИнФЛТип", "type": "object", "properties": { "вид_док": { "title": "ВидДок", "maxLength": 1000, "minLength": 1, "type": "string" }, "ном_док": { "title": "НомДок", "maxLength": 100, "minLength": 1, "type": "string" }, "дата_док": { "title": "ДатаДок", "maxLength": 10, "minLength": 10, "pattern": "(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})", "type": "string" } } }, "DocflowMetaHistorySchema": { "title": "DocflowMetaHistorySchema", "required": [ "state", "ati_id", "contact_id", "timestamp" ], "type": "object", "properties": { "state": { "title": "State", "type": "string" }, "ati_id": { "title": "Ati Id", "type": "string" }, "contact_id": { "title": "Contact Id", "type": "integer" }, "firm_name": { "title": "Firm Name", "type": "string", "description": "Название фирмы участника" }, "contact_name": { "title": "Contact Name", "type": "string", "description": "Название контакта участника" }, "user_astral_id": { "title": "User Astral Id", "type": "string" }, "user_astral_name": { "title": "User Astral Name", "type": "string" }, "timestamp": { "title": "Timestamp", "type": "string", "format": "date-time" }, "sign_info": { "$ref": "#/components/schemas/MetaSignInfoSchema" } }, "description": "Схема с историей документа в методе получения мета информации" }, "PaymentHistory": { "title": "PaymentHistory", "type": "object", "properties": { "title_1": { "title": "Title 1", "type": "array", "items": { "$ref": "#/components/schemas/PaymentData" } }, "title_2": { "title": "Title 2", "type": "array", "items": { "$ref": "#/components/schemas/PaymentData" } }, "title_3": { "title": "Title 3", "type": "array", "items": { "$ref": "#/components/schemas/PaymentData" } }, "title_4": { "title": "Title 4", "type": "array", "items": { "$ref": "#/components/schemas/PaymentData" } }, "title_5": { "title": "Title 5", "type": "array", "items": { "$ref": "#/components/schemas/PaymentData" } }, "title_6": { "title": "Title 6", "type": "array", "items": { "$ref": "#/components/schemas/PaymentData" } }, "title_7": { "title": "Title 7", "type": "array", "items": { "$ref": "#/components/schemas/PaymentData" } }, "title_8": { "title": "Title 8", "type": "array", "items": { "$ref": "#/components/schemas/PaymentData" } } } }, "PaymentData": { "title": "PaymentData", "required": [ "document_id", "is_completed" ], "type": "object", "properties": { "document_id": { "title": "Document Id", "type": "string" }, "is_completed": { "title": "Is Completed", "type": "boolean", "description": "Завершен ли флоу для титула успешно" } } }, "MetaSignInfoSchema": { "title": "MetaSignInfoSchema", "required": [ "title", "valid_from", "valid_until", "id", "components" ], "type": "object", "properties": { "title": { "title": "Title", "type": "string" }, "valid_from": { "title": "Valid From", "type": "string" }, "valid_until": { "title": "Valid Until", "type": "string" }, "id": { "title": "Id", "type": "string" }, "components": { "title": "Components", "type": "object", "additionalProperties": { "type": "string" } } }, "description": "Информация о подписи в истории" }, "AstralStandsEnum": { "title": "AstralStandsEnum", "enum": [ "fake", "real" ], "type": "string", "description": "An enumeration." }, "DocflowStates": { "title": "DocflowStates", "enum": [ "draft", "title_1_accepted", "title_1_waiting_operator", "title_1_success", "title_2_accepted", "title_2_waiting_operator", "title_2_success", "title_3_accepted", "title_3_waiting_operator", "title_3_success", "title_4_accepted", "title_4_waiting_operator", "title_4_success", "title_7_requested", "title_7_accepted", "title_7_waiting_operator", "title_7_success", "title_8_accepted", "title_8_waiting_operator", "title_8_success", "operator_failed" ], "type": "string", "description": "Все возможные состояния для документооборота ЭТрН" }, "ParticipantsSchema": { "title": "ParticipantsSchema", "required": [ "cargo_sender" ], "type": "object", "properties": { "cargo_sender": { "title": "Cargo Sender", "allOf": [ { "$ref": "#/components/schemas/UserSchema" } ], "description": "Грузоотправитель" }, "cargo_carrier": { "title": "Cargo Carrier", "allOf": [ { "$ref": "#/components/schemas/UserSchema" } ], "description": "Перевозчик" }, "cargo_receiver": { "title": "Cargo Receiver", "allOf": [ { "$ref": "#/components/schemas/UserSchema" } ], "description": "Грузополучатель" } } }, "DriverData": { "title": "DriverData", "type": "object", "properties": { "phone": { "title": "Phone", "pattern": "^[0-9]{11,13}$", "type": "string", "description": "Телефон выбранного водителя" }, "driver_decision": { "allOf": [ { "$ref": "#/components/schemas/DriverDecisionEnum" } ], "description": "Решение водителя" }, "decision_timestamp": { "title": "Decision Timestamp", "type": "string", "description": "Дата и время принятия решения водителем", "format": "date-time" }, "rejection_reason": { "title": "Rejection Reason", "type": "string", "description": "Причина отказа водителя" }, "send_in_title_1": { "title": "Send In Title 1", "type": "boolean", "description": "Нужно ли отправлять ЭТРН в АТИ Водитель автоматически при подписании первого титула", "default": true }, "is_sent_to_driver": { "title": "Is Sent To Driver", "type": "boolean", "description": "Отправлен ли уже ЭТРН в АТИ Водитель", "default": false }, "loading_point": { "title": "Loading Point", "allOf": [ { "$ref": "#/components/schemas/DriverLoadingPointData" } ], "description": "Точка погрузки" }, "unloading_point": { "title": "Unloading Point", "allOf": [ { "$ref": "#/components/schemas/DriverLoadingPointData" } ], "description": "Точка разгрузки" } }, "description": "Информация относящаяся к интеграции с водителем" }, "DriverDecisionEnum": { "title": "DriverDecisionEnum", "enum": [ "accepted", "rejected" ], "type": "string", "description": "Возможные решения водителя по этрн" }, "DriverLoadingPointData": { "title": "DriverLoadingPointData", "required": [ "timestamp" ], "type": "object", "properties": { "arrival_timestamp": { "title": "Arrival Timestamp", "type": "string", "description": "Дата и время прибытия в точку", "format": "date-time" }, "departure_timestamp": { "title": "Departure Timestamp", "type": "string", "description": "Дата и время отбытия из точки", "format": "date-time" }, "timestamp": { "title": "Timestamp", "type": "string", "description": "Дата и время изменения статуса", "format": "date-time" }, "notes": { "title": "Notes", "type": "string", "description": "Примечание, формат key1=value1;key2=value2" } }, "description": "Данные от водителя о точке погрузки/разгрузки" }, "VehicleOwnershipTypeEnum": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "title": "VehicleOwnershipTypeEnum" }, "NullableTitle1DraftData-Input": { "properties": { "верс_форм": { "type": "string", "const": "5.01", "nullable": true, "title": "Верс Форм", "default": "5.01" }, "ид_пол_иной": { "items": { "type": "string", "maxLength": 46, "minLength": 4, "nullable": true }, "type": "array", "title": "Ид Пол Иной", "nullable": true }, "документ": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__title_1_schema__Nullable___________-Input__4" }, { "type": "null" } ] } }, "type": "object", "title": "NullableTitle1DraftData" }, "Body_send_title_2_etrn_v1_docflows__docflow_id__titles_title_2_send_post": { "title": "Body_send_title_2_etrn_v1_docflows__docflow_id__titles_title_2_send_post", "required": [ "document", "sign" ], "type": "object", "properties": { "document": { "title": "Document", "type": "string", "description": "XML файл документа.", "format": "binary" }, "sign": { "title": "Sign", "type": "string", "description": "base64 подпись документа (detached)" } } }, "Body_send_title_3_etrn_v1_docflows__docflow_id__titles_title_3_send_post": { "title": "Body_send_title_3_etrn_v1_docflows__docflow_id__titles_title_3_send_post", "required": [ "document", "sign" ], "type": "object", "properties": { "document": { "title": "Document", "type": "string", "description": "XML файл документа.", "format": "binary" }, "sign": { "title": "Sign", "type": "string", "description": "base64 подпись документа (detached)" } } }, "app__core__schemas__titles_full__title_1_schema__Nullable_______-Input__4": { "properties": { "тс": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable______________-Input__4" }, { "type": "null" } ] }, "прицеп": { "oneOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable______________-Input__4" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "title": "Прицеп" }, "спец_усл_движ": { "oneOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable________________5" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "title": "Спец Усл Движ" }, "инф_пол": { "oneOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable___________2" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "title": "Инф Пол" } }, "type": "object", "title": "NullableСвТСТип" }, "app__core__schemas__titles_full__title_1_schema__Nullable_________-Input__1": { "properties": { "наим_груз": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Наим Груз" }, "код_тов_ном": { "type": "string", "maxLength": 4, "minLength": 4, "nullable": true, "title": "Код Тов Ном" }, "сост_груз": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Сост Груз" }, "сп_упак": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Сп Упак" }, "вид_тар": { "type": "string", "maxLength": 2, "minLength": 2, "nullable": true, "title": "Вид Тар" }, "плотн": { "oneOf": [ { "type": "number" }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Плотн" }, "объем": { "oneOf": [ { "type": "number" }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Объем" }, "кол_мест_гр": { "oneOf": [ { "type": "number" }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Кол Мест Гр" }, "уч_гос_сист": { "type": "string", "enum": [ "0", "1" ], "nullable": true, "title": "Уч Гос Сист" }, "др_о_груз": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Др О Груз" }, "марк": { "items": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true }, "type": "array", "nullable": true, "title": "Марк" }, "габар": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable________-Input__4" }, { "type": "null" } ] }, "св_оп_груз": { "oneOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable_____________1" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "title": "Св Оп Груз" }, "св_контейн": { "oneOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable____________-Input__3" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "title": "Св Контейн" }, "пл_мас_груз": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable________-Input__5" }, { "type": "null" } ] }, "ценн_груз": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable___________-Input__2" }, { "type": "null" } ] }, "зак_усл": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable_________1" }, { "type": "null" } ] }, "св_гос_сист": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__title_1_schema__Nullable____________" }, { "type": "null" } ] } }, "type": "object", "title": "NullableОпГрузТип" }, "app__core__schemas__titles_full__title_1_schema__Nullable_________-Input__2": { "properties": { "оп_груз": { "oneOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__title_1_schema__Nullable_________-Input__1" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "title": "Оп Груз" }, "об_ценн_гр": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable___________-Input__2" }, { "type": "null" } ] }, "инф_пол": { "oneOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable___________2" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "title": "Инф Пол" } }, "type": "object", "title": "NullableСвГрузТип" }, "app__core__schemas__titles_full__title_1_schema__Nullable_________-Input__3": { "properties": { "запр_перегруз": { "type": "string", "enum": [ "0", "1" ], "nullable": true, "title": "Запр Перегруз" }, "дат_вр_дост_гр": { "type": "string", "maxLength": 25, "minLength": 25, "pattern": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))", "nullable": true, "title": "Дат Вр Дост Гр" }, "нал_коор_точ_вр_дост": { "type": "string", "enum": [ "0", "1" ], "nullable": true, "title": "Нал Коор Точ Вр Дост" }, "срок_дост_гр": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Срок Дост Гр" }, "св_пломба": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Св Пломба" }, "ук_норм_првз": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Ук Норм Првз" }, "огр_скор": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Огр Скор" }, "мрш_првз": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable____________5" }, { "type": "null" } ] }, "св_па": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__title_1_schema__Nullable_________3" }, { "type": "null" } ] }, "клим_реж": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__title_1_schema__Nullable__________-Input__2" }, { "type": "null" } ] }, "инф_пол": { "oneOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable___________2" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "title": "Инф Пол" } }, "type": "object", "title": "NullableУказГОТип" }, "app__core__schemas__titles_full__title_1_schema__Nullable_________1": { "properties": { "го_эксп": { "type": "string", "enum": [ "0", "1" ], "nullable": true, "title": "Го Эксп" }, "рек_идент_го": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable________________3" }, { "type": "null" } ] }, "осн_расч_иным": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable____________1" }, { "type": "null" } ] } }, "type": "object", "title": "NullableСвГОТип" }, "app__core__schemas__titles_full__title_1_schema__Nullable_________2": { "properties": { "рек_идент_гп": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable________________3" }, { "type": "null" } ] }, "адрес_дост_гр": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable_______________2" }, { "type": "null" } ] } }, "type": "object", "title": "NullableСвГПТип" }, "app__core__schemas__titles_full__title_1_schema__Nullable_________3": { "properties": { "лицо_па": { "type": "string", "enum": [ "Грузоотправитель", "Грузополучатель" ], "nullable": true, "title": "Лицо Па" }, "спос_пер_ук_па": { "type": "string", "const": "Электронное уведомление перевозчика о переадресовке", "nullable": true, "title": "Спос Пер Ук Па", "default": "Электронное уведомление перевозчика о переадресовке" }, "конт_па": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable____________4" }, { "type": "null" } ] }, "док_пер_полн_па": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable____________1" }, { "type": "null" } ] } }, "type": "object", "title": "NullableСвПАТип" }, "app__core__schemas__titles_full__title_1_schema__Nullable__________-Input__2": { "properties": { "темп_не_ниже": { "oneOf": [ { "type": "number" }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Темп Не Ниже" }, "темп_не_выше": { "oneOf": [ { "type": "number" }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Темп Не Выше" }, "влажн_не_ниже": { "oneOf": [ { "type": "number" }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Влажн Не Ниже" }, "влажн_не_выше": { "oneOf": [ { "type": "number" }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Влажн Не Выше" } }, "type": "object", "title": "NullableКлимРежТип" }, "app__core__schemas__titles_full__title_1_schema__Nullable__________-Input__4": { "properties": { "факт_кол_ед_изм": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Факт Кол Ед Изм" }, "итог_разм_штр_рф": { "oneOf": [ { "type": "number" }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Итог Разм Штр Рф" }, "код_окв": { "type": "string", "maxLength": 3, "minLength": 3, "pattern": "[0-9]{3}", "nullable": true, "title": "Код Окв" }, "наим_окв": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Наим Окв" }, "итог_разм_штр_ин": { "oneOf": [ { "type": "number" }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Итог Разм Штр Ин" }, "дата_курс_вал": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})", "nullable": true, "title": "Дата Курс Вал" }, "курс_вал": { "oneOf": [ { "type": "number" }, { "type": "string", "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$" }, { "type": "null" } ], "title": "Курс Вал" }, "расч_штр": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Расч Штр" } }, "type": "object", "title": "NullableРазмШтрТип" }, "app__core__schemas__titles_full__title_1_schema__Nullable__________-Input__5": { "properties": { "дат_вр_отмет": { "type": "string", "maxLength": 25, "minLength": 25, "pattern": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))", "nullable": true, "title": "Дат Вр Отмет" }, "нал_коор_точ_вр_отм": { "type": "string", "enum": [ "0", "1" ], "nullable": true, "title": "Нал Коор Точ Вр Отм" }, "обст_отмет": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Обст Отмет" }, "св_акт": { "oneOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable____________1" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "title": "Св Акт" }, "разм_штр": { "oneOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__title_1_schema__Nullable__________-Input__4" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "title": "Разм Штр" }, "св_акт_взв": { "oneOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable____________1" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "title": "Св Акт Взв" }, "инф_пол": { "oneOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable___________2" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "title": "Инф Пол" } }, "type": "object", "title": "NullableОтметГОТип" }, "app__core__schemas__titles_full__title_1_schema__Nullable__________1": { "properties": { "ид_файл_зак": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Ид Файл Зак" }, "дат_файл_зак": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})", "nullable": true, "title": "Дат Файл Зак" }, "вр_файл_зак": { "type": "string", "maxLength": 8, "minLength": 8, "pattern": "([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})", "nullable": true, "title": "Вр Файл Зак" }, "эп": { "type": "string", "minLength": 1, "nullable": true, "title": "Эп" } }, "type": "object", "title": "NullableИдЗакТип" }, "app__core__schemas__titles_full__title_1_schema__Nullable__________2": { "properties": { "рек_идент_зак": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable________________3" }, { "type": "null" } ] }, "дог_усл_пер": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable____________1" }, { "type": "null" } ] } }, "type": "object", "title": "NullableСвЗакТип" }, "app__core__schemas__titles_full__title_1_schema__Nullable___________-Input__2": { "properties": { "заяв_погр": { "type": "string", "maxLength": 25, "minLength": 25, "pattern": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))", "nullable": true, "title": "Заяв Погр" }, "нал_коор_точ_вр_заяв": { "type": "string", "enum": [ "0", "1" ], "nullable": true, "title": "Нал Коор Точ Вр Заяв" }, "ф_дат_вр_приб": { "type": "string", "maxLength": 25, "minLength": 25, "pattern": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))", "nullable": true, "title": "Ф Дат Вр Приб" }, "нал_коор_точ_вр_ф_погр": { "type": "string", "enum": [ "0", "1" ], "nullable": true, "title": "Нал Коор Точ Вр Ф Погр" }, "ф_дат_вр_убыт": { "type": "string", "maxLength": 25, "minLength": 25, "pattern": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))", "nullable": true, "title": "Ф Дат Вр Убыт" }, "нал_коор_точ_вр_ф_убыт": { "type": "string", "enum": [ "0", "1" ], "nullable": true, "title": "Нал Коор Точ Вр Ф Убыт" }, "ф_сост_тар": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Ф Сост Тар" }, "ф_сост_уп": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Ф Сост Уп" }, "ф_сост_куз": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Ф Сост Куз" }, "мас_брут_отгр": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Мас Брут Отгр" }, "мет_опр_масс": { "type": "string", "enum": [ "01", "02", "03" ], "nullable": true, "title": "Мет Опр Масс" }, "кол_мест_прием": { "enum": [ "number", "string" ], "nullable": true, "title": "Кол Мест Прием" }, "ф_адрес_погр": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable_______________2" }, { "type": "null" } ] }, "св_лиц_погр_гр": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__title_1_schema__Nullable______________-Input" }, { "type": "null" } ] }, "влад_инфр": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__title_1_schema__Nullable_____________1" }, { "type": "null" } ] }, "осн_дост_об_инфр_док": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable____________1" }, { "type": "null" } ] }, "осн_дост_об_инфр_текст": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Осн Дост Об Инфр Текст" }, "инф_пол": { "oneOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable___________2" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "title": "Инф Пол" } }, "type": "object", "title": "NullableСвПогрузТип" }, "app__core__schemas__titles_full__title_1_schema__Nullable___________-Input__3": { "properties": { "номер_тр_н": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Номер Тр Н" }, "дата_тр_н": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})", "nullable": true, "title": "Дата Тр Н" }, "ном_зак": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Ном Зак" }, "дата_зак": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})", "nullable": true, "title": "Дата Зак" }, "ид_зак": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__title_1_schema__Nullable__________1" }, { "type": "null" } ] }, "св_го": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__title_1_schema__Nullable_________1" }, { "type": "null" } ] }, "св_зак": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__title_1_schema__Nullable__________2" }, { "type": "null" } ] }, "св_гп": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__title_1_schema__Nullable_________2" }, { "type": "null" } ] }, "св_груз": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__title_1_schema__Nullable_________-Input__2" }, { "type": "null" } ] }, "сопр_док": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__title_1_schema__Nullable____________1" }, { "type": "null" } ] }, "указ_го": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__title_1_schema__Nullable_________-Input__3" }, { "type": "null" } ] }, "св_пер": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable________________3" }, { "type": "null" } ] }, "св_водит": { "oneOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__title_1_schema__Nullable____________3" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "title": "Св Водит" }, "св_тс": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__title_1_schema__Nullable_______-Input__4" }, { "type": "null" } ] }, "св_погруз": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__title_1_schema__Nullable___________-Input__2" }, { "type": "null" } ] }, "отмет_го": { "oneOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__title_1_schema__Nullable__________-Input__5" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "title": "Отмет Го" }, "инф_пол": { "oneOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable___________2" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "title": "Инф Пол" } }, "type": "object", "title": "NullableСодИнфГОТип" }, "app__core__schemas__titles_full__title_1_schema__Nullable___________-Input__4": { "properties": { "кнд": { "type": "string", "const": "1110339", "title": "Кнд", "default": "1110339", "nullable": true }, "наим_эк_суб_сост": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Наим Эк Суб Сост", "nullable": true }, "осн_дов_орг_сост": { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable____________1", "nullable": true }, "сод_инф_го": { "$ref": "#/components/schemas/app__core__schemas__titles_full__title_1_schema__Nullable___________-Input__3", "nullable": true } }, "type": "object", "title": "NullableДокументТип" }, "app__core__schemas__titles_full__title_1_schema__Nullable____________": { "properties": { "наим_гос_сист": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Гос Сист" }, "учет_ед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Учет Ед" }, "иная_инф": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Иная Инф" }, "ид_ном_учет_ед": { "items": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true }, "type": "array", "title": "Ид Ном Учет Ед" } }, "type": "object", "title": "NullableСвГосСистТип" }, "app__core__schemas__titles_full__title_1_schema__Nullable____________1": { "properties": { "док_к_тр_н": { "oneOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable____________1" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "title": "Док К Тр Н" }, "док_к_гр": { "oneOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable____________1" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "title": "Док К Гр" }, "док_пер_ценн": { "oneOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable____________1" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "title": "Док Пер Ценн" }, "рек_сопр_вед": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable____________1" }, { "type": "null" } ] } }, "type": "object", "title": "NullableСопрДокТип" }, "app__core__schemas__titles_full__title_1_schema__Nullable____________3": { "properties": { "ном_ву": { "type": "string", "maxLength": 20, "minLength": 1, "nullable": true, "title": "Ном Ву" }, "сер_ву": { "type": "string", "maxLength": 20, "minLength": 1, "nullable": true, "title": "Сер Ву" }, "дата_выд_ву": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})", "nullable": true, "title": "Дата Выд Ву" }, "иннфл": { "type": "string", "maxLength": 12, "minLength": 12, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}", "nullable": true, "title": "Иннфл" }, "св_сп_ид_подп": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Св Сп Ид Подп" }, "тлф": { "oneOf": [ { "items": { "type": "string", "maxLength": 20, "minLength": 1, "nullable": true }, "type": "array" }, { "type": "null" } ], "title": "Тлф" }, "фио": { "oneOf": [ { "$ref": "#/components/schemas/Nullable______" }, { "type": "null" } ] }, "путевой_лист": { "oneOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable____________1" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "title": "Путевой Лист" } }, "type": "object", "title": "NullableСвВодитТип" }, "app__core__schemas__titles_full__title_1_schema__Nullable_____________1": { "properties": { "совп_гов": { "type": "string", "enum": [ "1", "2", "3" ], "nullable": true, "title": "Совп Гов" }, "об_нет_инф_о_влад": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Об Нет Инф О Влад" }, "рек_влад_инф": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable________________3" }, { "type": "null" } ] }, "идент_рек_го": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable______________2" }, { "type": "null" } ] } }, "type": "object", "title": "NullableВладИнфрТип" }, "app__core__schemas__titles_full__title_1_schema__Nullable______________-Input": { "properties": { "совп_гоп": { "type": "string", "enum": [ "1", "2" ], "nullable": true, "title": "Совп Гоп" }, "рек_лиц_погр_гр": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable________________3" }, { "type": "null" } ] }, "осн_погр_гр": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable____________1" }, { "type": "null" } ] }, "раб_лиц_погр_гр": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__title_1_schema__Nullable_______________" }, { "type": "null" } ] }, "идент_рек_го": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable______________2" }, { "type": "null" } ] } }, "type": "object", "title": "NullableСвЛицПогрГрТип" }, "app__core__schemas__titles_full__title_1_schema__Nullable_______________": { "properties": { "должность": { "type": "string", "maxLength": 128, "minLength": 1, "nullable": true, "title": "Должность" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "о_долж_об": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "О Долж Об" }, "оп_иное": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable____________1" }, { "type": "null" } ] }, "фио": { "oneOf": [ { "$ref": "#/components/schemas/Nullable______" }, { "type": "null" } ] } }, "type": "object", "title": "NullableРабЛицПогрГрТип" }, "app__core__schemas__title_3_schema__NullableType9": { "title": "NullableType9", "type": "object", "properties": { "кнд": { "title": "КНД", "enum": [ "1110341" ], "type": "string", "default": "1110341" }, "наим_экон_суб_сост": { "title": "НаимЭконСубСост", "maxLength": 1000, "minLength": 1, "type": "string" }, "осн_довер_орг_сост": { "title": "ОснДоверОргСост", "allOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_common__NullableRekvDocTip" } ] }, "сод_инф_гп": { "title": "СодИнфГП", "allOf": [ { "$ref": "#/components/schemas/app__core__schemas__title_3_schema__NullableType6" } ] } } }, "app__core__schemas__title_3_schema__NullableType6": { "title": "NullableType6", "type": "object", "properties": { "сод_оп_отк": { "title": "СодОпОтк", "maxLength": 255, "minLength": 1, "type": "string" }, "прич_отк": { "title": "ПричОтк", "maxLength": 2000, "minLength": 1, "type": "string" }, "испр_тр_н": { "title": "ИспрТрН", "allOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_common__NullableIsprTip" } ] }, "прием_груз_гп": { "title": "ПриемГрузГП", "allOf": [ { "$ref": "#/components/schemas/app__core__schemas__title_3_schema__NullableType3" } ] }, "отмет_гп": { "title": "ОтметГП", "type": "array", "items": { "$ref": "#/components/schemas/app__core__schemas__title_3_schema__NullableType5" }, "default": [] }, "инф_пол": { "title": "ИнфПол", "type": "array", "items": { "$ref": "#/components/schemas/app__core__schemas__titles_common__NullableInfPolTip" }, "default": [] } } }, "app__core__schemas__titles_common__NullableIsprTip": { "title": "NullableИспрТип", "type": "object", "properties": { "ном_испр": { "title": "НомИспр", "type": "number" }, "дата_испр": { "title": "ДатаИспр", "maxLength": 10, "minLength": 10, "pattern": "(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})", "type": "string" } } }, "app__core__schemas__title_3_schema__NullableType3": { "title": "NullableType3", "type": "object", "properties": { "ф_дат_вр_приб": { "title": "ФДатВрПриб", "maxLength": 25, "minLength": 25, "pattern": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))", "type": "string" }, "нал_коор_точ_вр_ф_пр": { "title": "НалКоорТочВрФПр", "enum": [ "0", "1" ], "type": "string" }, "ф_дат_вр_убыт": { "title": "ФДатВрУбыт", "maxLength": 25, "minLength": 25, "pattern": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))", "type": "string" }, "нал_коор_точ_вр_ф_уб": { "title": "НалКоорТочВрФУб", "enum": [ "0", "1" ], "type": "string" }, "заяв_дат_вр_приб": { "title": "ЗаявДатВрПриб", "maxLength": 25, "minLength": 25, "pattern": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))", "type": "string" }, "нал_коор_точ_вр_з_пр": { "title": "НалКоорТочВрЗПр", "enum": [ "0", "1" ], "type": "string" }, "мет_опр_масс": { "title": "МетОпрМасс", "enum": [ "01", "02", "03" ], "type": "string" }, "кол_мест_прием_ч": { "title": "КолМестПриемЧ", "type": "number" }, "общ_св_сост": { "title": "ОбщСвСост", "maxLength": 10000, "minLength": 1, "type": "string" }, "мас_брут_знач_прием": { "title": "МасБрутЗначПрием", "type": "number" }, "мас_нет_знач_прием": { "title": "МасНетЗначПрием", "type": "number" }, "объем": { "title": "Объем", "type": "number" }, "адр_выгруз": { "title": "АдрВыгруз", "allOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_common__NullableAdresPolzTip" } ] }, "св_прин_по_наим": { "title": "СвПринПоНаим", "type": "array", "items": { "$ref": "#/components/schemas/app__core__schemas__title_3_schema__NullableType2" }, "default": [] }, "инф_пол": { "title": "ИнфПол", "type": "array", "items": { "$ref": "#/components/schemas/app__core__schemas__titles_common__NullableInfPolTip" }, "default": [] } } }, "app__core__schemas__title_3_schema__NullableType5": { "title": "NullableType5", "type": "object", "properties": { "дат_вр_отмет": { "title": "ДатВрОтмет", "maxLength": 25, "minLength": 25, "pattern": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))", "type": "string" }, "нал_коор_точ_вр_отм": { "title": "НалКоорТочВрОтм", "enum": [ "0", "1" ], "type": "string" }, "обст_отмет": { "title": "ОбстОтмет", "maxLength": 2000, "minLength": 1, "type": "string" }, "св_акт": { "title": "СвАкт", "type": "array", "items": { "$ref": "#/components/schemas/app__core__schemas__titles_common__NullableRekvDocTip" }, "default": [] }, "разм_штр": { "title": "РазмШтр", "type": "array", "items": { "$ref": "#/components/schemas/app__core__schemas__title_3_schema__NullableType4" }, "default": [] }, "св_акт_взв": { "title": "СвАктВзв", "type": "array", "items": { "$ref": "#/components/schemas/app__core__schemas__titles_common__NullableRekvDocTip" }, "default": [] }, "инф_пол": { "title": "ИнфПол", "type": "array", "items": { "$ref": "#/components/schemas/app__core__schemas__titles_common__NullableInfPolTip" }, "default": [] } } }, "app__core__schemas__titles_common__NullableAdresPolzTip": { "title": "NullableАдресПользТип", "type": "object", "properties": { "адр_коммент": { "title": "АдрКоммент", "maxLength": 2000, "minLength": 1, "type": "string" }, "глн": { "title": "ГЛН", "maxLength": 13, "minLength": 13, "type": "string" }, "коорд": { "title": "Коорд", "allOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_common__NullableKoordTip" } ] }, "адрес_рф": { "title": "АдресРФ", "allOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_common__NullableAdrRFTip" } ] }, "адрес_инф": { "title": "АдресИнф", "allOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_common__NullableAdrInfTip" } ] }, "код_гар": { "title": "КодГАР", "maxLength": 36, "minLength": 1, "type": "string" } } }, "app__core__schemas__title_3_schema__NullableType2": { "title": "NullableType2", "type": "object", "properties": { "наим_груз": { "title": "НаимГруз", "maxLength": 1000, "minLength": 1, "type": "string" }, "сост_груз": { "title": "СостГруз", "maxLength": 10000, "minLength": 1, "type": "string" }, "плотн": { "title": "Плотн", "type": "number" }, "объем": { "title": "Объем", "type": "number" }, "кол_мест": { "title": "КолМест", "type": "number" }, "пер_марк": { "title": "ПерМарк", "type": "array", "items": { "maxLength": 1000, "minLength": 1, "type": "string" }, "default": [] }, "мас_груз": { "title": "МасГруз", "allOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_common__NullableMassaTip" } ] } } }, "app__core__schemas__title_3_schema__NullableType4": { "title": "NullableType4", "type": "object", "properties": { "факт_кол_ед_изм": { "title": "ФактКолЕдИзм", "maxLength": 255, "minLength": 1, "type": "string" }, "итог_разм_штр_рф": { "title": "ИтогРазмШтрРФ", "type": "number" }, "код_окв": { "title": "КодОКВ", "maxLength": 3, "minLength": 3, "pattern": "[0-9]{3}", "type": "string" }, "наим_окв": { "title": "НаимОКВ", "maxLength": 100, "minLength": 1, "type": "string" }, "итог_разм_штр_ин": { "title": "ИтогРазмШтрИн", "type": "number" }, "дата_курс_вал": { "title": "ДатаКурсВал", "maxLength": 10, "minLength": 10, "pattern": "(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})", "type": "string" }, "курс_вал": { "title": "КурсВал", "type": "number" }, "расч_штр": { "title": "РасчШтр", "maxLength": 1000, "minLength": 1, "type": "string" } } }, "app__core__schemas__titles_common__NullableKoordTip": { "title": "NullableКоордТип", "type": "object", "properties": { "широта": { "title": "Широта", "maxLength": 17, "minLength": 15, "type": "string" }, "долгота": { "title": "Долгота", "maxLength": 18, "minLength": 15, "type": "string" } } }, "app__core__schemas__titles_common__NullableAdrRFTip": { "title": "NullableАдрРФТип", "type": "object", "properties": { "индекс": { "title": "Индекс", "maxLength": 6, "minLength": 6, "type": "string" }, "код_регион": { "title": "КодРегион", "maxLength": 2, "minLength": 2, "pattern": "[0-9]{2}", "type": "string" }, "район": { "title": "Район", "maxLength": 50, "minLength": 1, "type": "string" }, "город": { "title": "Город", "maxLength": 50, "minLength": 1, "type": "string" }, "насел_пункт": { "title": "НаселПункт", "maxLength": 50, "minLength": 1, "type": "string" }, "улица": { "title": "Улица", "maxLength": 50, "minLength": 1, "type": "string" }, "дом": { "title": "Дом", "maxLength": 20, "minLength": 1, "type": "string" }, "корпус": { "title": "Корпус", "maxLength": 20, "minLength": 1, "type": "string" }, "кварт": { "title": "Кварт", "maxLength": 20, "minLength": 1, "type": "string" } } }, "app__core__schemas__titles_common__NullableAdrInfTip": { "title": "NullableАдрИнфТип", "type": "object", "properties": { "код_стр": { "title": "КодСтр", "maxLength": 3, "minLength": 3, "pattern": "[0-9]{3}", "type": "string" }, "адр_текст": { "title": "АдрТекст", "maxLength": 1000, "minLength": 1, "type": "string" } } }, "app__core__schemas__titles_common__NullableMassaTip": { "title": "NullableМассаТип", "type": "object", "properties": { "мас_нет_знач": { "title": "МасНетЗнач", "type": "number" }, "мас_брут_знач": { "title": "МасБрутЗнач", "type": "number" }, "кол_палл": { "title": "КолПалл", "type": "number" } } }, "NullableTitle3DraftData": { "title": "NullableTitle3DraftData", "type": "object", "properties": { "верс_форм": { "title": "ВерсФорм", "enum": [ "5.01" ], "type": "string", "default": "5.01" }, "ид_пол_иной": { "title": "ИдПолИной", "type": "array", "items": { "maxLength": 46, "minLength": 4, "type": "string" }, "default": [] }, "документ": { "title": "Документ", "allOf": [ { "$ref": "#/components/schemas/app__core__schemas__title_3_schema__NullableType9" } ] } } }, "NullableTitle4DraftData": { "title": "NullableTitle4DraftData", "type": "object", "properties": { "верс_форм": { "title": "ВерсФорм", "enum": [ "5.01" ], "type": "string", "default": "5.01" }, "ид_пол_иной": { "title": "ИдПолИной", "type": "array", "items": { "maxLength": 46, "minLength": 4, "type": "string" }, "default": [] }, "документ": { "title": "Документ", "allOf": [ { "$ref": "#/components/schemas/app__core__schemas__title_4_schema__NullableType8" } ] } } }, "app__core__schemas__title_4_schema__NullableType8": { "title": "NullableType8", "type": "object", "properties": { "кнд": { "title": "КНД", "enum": [ "1110342" ], "type": "string", "default": "1110342" }, "сод_прв_выд": { "title": "СодПрвВыд", "allOf": [ { "$ref": "#/components/schemas/app__core__schemas__title_4_schema__NullableType5" } ] } } }, "app__core__schemas__title_4_schema__NullableType5": { "title": "NullableType5", "type": "object", "properties": { "зам_прв_выд": { "title": "ЗамПрвВыд", "allOf": [ { "$ref": "#/components/schemas/app__core__schemas__title_4_schema__NullableType2" } ] }, "отмет_прв_выд": { "title": "ОтметПрвВыд", "type": "array", "items": { "$ref": "#/components/schemas/app__core__schemas__title_4_schema__NullableType4" }, "default": [] }, "инф_пол": { "title": "ИнфПол", "type": "array", "items": { "$ref": "#/components/schemas/app__core__schemas__titles_common__NullableInfPolTip" }, "default": [] } } }, "app__core__schemas__title_4_schema__NullableType2": { "title": "NullableType2", "type": "object", "properties": { "зам_дата_вр_приб": { "title": "ЗамДатаВрПриб", "maxLength": 25, "minLength": 25, "pattern": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))", "type": "string" }, "нал_коор_точ_вр_пр": { "title": "НалКоорТочВрПр", "enum": [ "0", "1" ], "type": "string" }, "зам_дат_вр_убыт": { "title": "ЗамДатВрУбыт", "maxLength": 25, "minLength": 25, "pattern": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))", "type": "string" }, "нал_коор_точ_вр_уб": { "title": "НалКоорТочВрУб", "enum": [ "0", "1" ], "type": "string" }, "зам_дат_вр_пос_выгр": { "title": "ЗамДатВрПосВыгр", "maxLength": 25, "minLength": 25, "pattern": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))", "type": "string" }, "нал_коор_точ_вр_выгр": { "title": "НалКоорТочВрВыгр", "enum": [ "0", "1" ], "type": "string" }, "зам_сост_груз": { "title": "ЗамСостГруз", "maxLength": 10000, "minLength": 1, "type": "string" }, "зам_раб_выгр": { "title": "ЗамРабВыгр", "maxLength": 10000, "minLength": 1, "type": "string" }, "инф_пол": { "title": "ИнфПол", "type": "array", "items": { "$ref": "#/components/schemas/app__core__schemas__titles_common__NullableInfPolTip" }, "default": [] } } }, "app__core__schemas__title_4_schema__NullableType4": { "title": "NullableType4", "type": "object", "properties": { "дат_вр_отмет": { "title": "ДатВрОтмет", "maxLength": 25, "minLength": 25, "pattern": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+-]([01][0-9])[:]([0-5][0-9])))", "type": "string" }, "нал_коор_точ_вр_отм": { "title": "НалКоорТочВрОтм", "enum": [ "0", "1" ], "type": "string" }, "обст_отмет": { "title": "ОбстОтмет", "maxLength": 2000, "minLength": 1, "type": "string" }, "отм_акт_взв": { "title": "ОтмАктВзв", "maxLength": 1000, "minLength": 1, "type": "string" }, "св_акт": { "title": "СвАкт", "type": "array", "items": { "$ref": "#/components/schemas/app__core__schemas__titles_common__NullableRekvDocTip" }, "default": [] }, "разм_штр": { "title": "РазмШтр", "type": "array", "items": { "$ref": "#/components/schemas/app__core__schemas__title_2_schema__NullableType3" }, "default": [] }, "инф_пол": { "title": "ИнфПол", "type": "array", "items": { "$ref": "#/components/schemas/app__core__schemas__titles_common__NullableInfPolTip" }, "default": [] } } }, "app__core__schemas__titles_full__titles_common__Nullable________-Input__4": { "properties": { "выс_знач": { "enum": [ "number", "string" ], "title": "Выс Знач", "nullable": true }, "дл_знач": { "enum": [ "number", "string" ], "nullable": true, "title": "Дл Знач" }, "шир_знач": { "enum": [ "number", "string" ], "nullable": true, "title": "Шир Знач" } }, "type": "object", "title": "NullableГабарТип" }, "app__core__schemas__titles_full__titles_common__Nullable________-Input__5": { "properties": { "мас_нет_знач": { "enum": [ "number", "string" ], "nullable": true, "title": "Мас Нет Знач" }, "мас_брут_знач": { "enum": [ "number", "string" ], "nullable": true, "title": "Мас Брут Знач" }, "кол_палл": { "enum": [ "number", "string" ], "nullable": true, "title": "Кол Палл" } }, "type": "object", "title": "NullableМассаТип" }, "app__core__schemas__titles_full__titles_common__Nullable_________1": { "properties": { "св_ип": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable____________2" }, { "type": "null" } ] }, "св_юл_уч": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable______________1" }, { "type": "null" } ] }, "св_ин_не_уч": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable________________2" }, { "type": "null" } ] }, "св_фл_участ": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable____________3" }, { "type": "null" } ] } }, "type": "object", "title": "NullableИдСвТип" }, "app__core__schemas__titles_full__titles_common__Nullable__________-Input__6": { "properties": { "тип": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Тип" }, "марка": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Марка" }, "грузопод": { "enum": [ "number", "string" ], "nullable": true, "title": "Грузопод" }, "вместим": { "enum": [ "number", "string" ], "nullable": true, "title": "Вместим" } }, "type": "object", "title": "NullableПарамТСТип" }, "app__core__schemas__titles_full__titles_common__Nullable__________1": { "properties": { "индекс": { "type": "string", "maxLength": 6, "minLength": 6, "nullable": true, "title": "Индекс" }, "код_регион": { "type": "string", "maxLength": 2, "minLength": 2, "pattern": "[0-9]{2}", "nullable": true, "title": "Код Регион" }, "район": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Район" }, "город": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Город" }, "насел_пункт": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Насел Пункт" }, "улица": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Улица" }, "дом": { "type": "string", "maxLength": 20, "minLength": 1, "nullable": true, "title": "Дом" }, "корпус": { "type": "string", "maxLength": 20, "minLength": 1, "nullable": true, "title": "Корпус" }, "кварт": { "type": "string", "maxLength": 20, "minLength": 1, "nullable": true, "title": "Кварт" } }, "type": "object", "title": "NullableАдрРФТип" }, "app__core__schemas__titles_full__titles_common__Nullable__________2": { "properties": { "адр_рф": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable__________1" }, { "type": "null" } ] }, "адр_инф": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable___________1" }, { "type": "null" } ] }, "код_гар": { "type": "string", "maxLength": 36, "minLength": 1, "nullable": true, "title": "Код Гар" } }, "type": "object", "title": "NullableАдресТип" }, "app__core__schemas__titles_full__titles_common__Nullable__________3": { "properties": { "широта": { "type": "string", "maxLength": 17, "minLength": 15, "nullable": true, "title": "Широта" }, "долгота": { "type": "string", "maxLength": 18, "minLength": 15, "nullable": true, "title": "Долгота" } }, "type": "object", "title": "NullableКоордТип" }, "app__core__schemas__titles_full__titles_common__Nullable___________-Input__2": { "properties": { "ст_ценн_гр": { "enum": [ "number", "string" ], "nullable": true, "title": "Ст Ценн Гр" }, "код_окв": { "type": "string", "maxLength": 3, "minLength": 3, "pattern": "[0-9]{3}", "nullable": true, "title": "Код Окв" }, "наим_окв": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Наим Окв" } }, "type": "object", "title": "NullableЦеннГрузТип" }, "app__core__schemas__titles_full__titles_common__Nullable___________1": { "properties": { "код_стр": { "type": "string", "maxLength": 3, "minLength": 3, "pattern": "[0-9]{3}", "nullable": true, "title": "Код Стр" }, "адр_текст": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Адр Текст" } }, "type": "object", "title": "NullableАдрИнфТип" }, "app__core__schemas__titles_full__titles_common__Nullable___________2": { "properties": { "ид_файл_инф_пол": { "type": "string", "maxLength": 36, "minLength": 36, "nullable": true, "title": "Ид Файл Инф Пол" }, "текст_инф": { "oneOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable_____________3" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "title": "Текст Инф" } }, "type": "object", "title": "NullableИнфПолТип" }, "app__core__schemas__titles_full__titles_common__Nullable____________-Input__3": { "properties": { "кол_контейн": { "enum": [ "number", "string" ], "title": "Кол Контейн" }, "ид_контейн": { "oneOf": [ { "items": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true }, "type": "array" }, { "type": "null" } ], "title": "Ид Контейн" } }, "type": "object", "title": "NullableСвКонтейнТип" }, "app__core__schemas__titles_full__titles_common__Nullable____________1": { "properties": { "наим_док": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Док" }, "номер_док": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Номер Док" }, "дата_док": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})", "title": "Дата Док", "nullable": true }, "ид_док": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Ид Док" }, "доп_свед_док": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Доп Свед Док" }, "ид_рек_сост": { "items": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable______________2" }, { "type": "null" } ] }, "type": "array", "title": "Ид Рек Сост" } }, "type": "object", "title": "NullableРеквДокТип" }, "app__core__schemas__titles_full__titles_common__Nullable____________2": { "properties": { "иннфл": { "type": "string", "maxLength": 12, "minLength": 12, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}", "nullable": true, "title": "Иннфл" }, "огрнип": { "type": "string", "maxLength": 15, "minLength": 15, "pattern": "[0-9]{15}", "nullable": true, "title": "Огрнип" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "фио": { "oneOf": [ { "$ref": "#/components/schemas/Nullable______" }, { "type": "null" } ] } }, "type": "object", "title": "NullableСвИПТрНТип" }, "app__core__schemas__titles_full__titles_common__Nullable____________3": { "properties": { "иннфл": { "type": "string", "maxLength": 12, "minLength": 12, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}", "nullable": true, "title": "Иннфл" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "фио": { "oneOf": [ { "$ref": "#/components/schemas/Nullable______" }, { "type": "null" } ] } }, "type": "object", "title": "NullableСвФЛТрНТип" }, "app__core__schemas__titles_full__titles_common__Nullable____________4": { "properties": { "тлф": { "items": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true }, "type": "array", "nullable": true, "title": "Тлф" }, "эл_почта": { "items": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true }, "type": "array", "nullable": true, "title": "Эл Почта" }, "ин_конт": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Ин Конт" } }, "type": "object", "title": "NullableКонтактТип" }, "app__core__schemas__titles_full__titles_common__Nullable____________5": { "properties": { "мрш_текст": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Мрш Текст" }, "мрш_маш_чит": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Мрш Маш Чит" } }, "type": "object", "title": "NullableСведМршТип" }, "app__core__schemas__titles_full__titles_common__Nullable_____________1": { "properties": { "ном_оон": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Ном Оон" }, "над_отг_наим": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Над Отг Наим" }, "тех_наим": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Тех Наим" }, "описание": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Описание" }, "клас": { "type": "string", "maxLength": 3, "minLength": 1, "nullable": true, "title": "Клас" }, "клас_код": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Клас Код" }, "гр_уп": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Гр Уп" }, "зн_оп": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Зн Оп" }, "код_огр_чер_тун": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Код Огр Чер Тун" }, "наз_радионук": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Наз Радионук" }, "опис_физ_хим_форм": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Опис Физ Хим Форм" }, "макс_акт": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Макс Акт" }, "кат_упак": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Кат Упак" }, "транс_индекс": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Транс Индекс" }, "индекс_без": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Индекс Без" }, "опоз_знак": { "type": "string", "maxLength": 10000, "minLength": 1, "nullable": true, "title": "Опоз Знак" }, "полн_акт_гр": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Полн Акт Гр" }, "об_мас_нет_взр_сод": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Об Мас Нет Взр Сод" }, "об_мас_нет_взр_сод_всех": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Об Мас Нет Взр Сод Всех" }, "проц_смеси": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Проц Смеси" }, "дат_ист_вр_удер": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})", "nullable": true, "title": "Дат Ист Вр Удер" }, "конт_темпер": { "type": "string", "maxLength": 10, "minLength": 1, "nullable": true, "title": "Конт Темпер" }, "авар_темпер": { "type": "string", "maxLength": 10, "minLength": 1, "nullable": true, "title": "Авар Темпер" } }, "type": "object", "title": "NullableСвОпГрузТип" }, "app__core__schemas__titles_full__titles_common__Nullable_____________3": { "properties": { "идентиф": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Идентиф" }, "значение": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Значение" } }, "type": "object", "title": "NullableТекстИнфТип" }, "app__core__schemas__titles_full__titles_common__Nullable______________-Input__4": { "properties": { "ном_стс": { "type": "string", "maxLength": 10, "minLength": 1, "nullable": true, "title": "Ном Стс" }, "номер_вин": { "type": "string", "maxLength": 17, "minLength": 1, "nullable": true, "title": "Номер Вин" }, "рег_номер": { "type": "string", "maxLength": 9, "minLength": 1, "nullable": true, "title": "Рег Номер" }, "тип_влад": { "oneOf": [ { "$ref": "#/components/schemas/VehicleOwnershipTypeEnum" }, { "type": "null" } ] }, "пар_тс": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable__________-Input__6" }, { "type": "null" } ] }, "осн_ар_лиз": { "oneOf": [ { "items": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable____________1" }, { "type": "null" } ] }, "type": "array" }, { "type": "null" } ], "title": "Осн Ар Лиз" } }, "type": "object", "title": "NullableПараметрыТСТип" }, "app__core__schemas__titles_full__titles_common__Nullable______________1": { "properties": { "наим_орг": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Наим Орг" }, "иннюл": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}", "nullable": true, "title": "Иннюл" }, "кпп": { "type": "string", "maxLength": 9, "minLength": 9, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})([0-9]{2})([0-9A-Z]{2})([0-9]{3})", "nullable": true, "title": "Кпп" } }, "type": "object", "title": "NullableСвЮЛУчТрНТип" }, "app__core__schemas__titles_full__titles_common__Nullable______________2": { "properties": { "иннюл": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}", "title": "Иннюл", "nullable": true }, "иннфл": { "type": "string", "maxLength": 12, "minLength": 12, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}", "title": "Иннфл", "nullable": true }, "данн_ино": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable________________2" }, { "type": "null" } ] }, "наим_оив": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Наим Оив", "nullable": true } }, "type": "object", "title": "NullableИдРекСостТип" }, "app__core__schemas__titles_full__titles_common__Nullable_______________1": { "properties": { "вид_док": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Вид Док" }, "ном_док": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Ном Док" }, "дата_док": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})", "nullable": true, "title": "Дата Док" } }, "type": "object", "title": "NullableУдЛичнИнФЛТип" }, "app__core__schemas__titles_full__titles_common__Nullable_______________2": { "properties": { "адр_коммент": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Адр Коммент" }, "глн": { "type": "string", "maxLength": 13, "minLength": 13, "nullable": true, "title": "Глн" }, "коорд": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable__________3" }, { "type": "null" } ] }, "адрес_рф": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable__________1" }, { "type": "null" } ] }, "адрес_инф": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable___________1" }, { "type": "null" } ] }, "код_гар": { "type": "string", "maxLength": 36, "minLength": 1, "nullable": true, "title": "Код Гар" } }, "type": "object", "title": "NullableАдресПользТип" }, "app__core__schemas__titles_full__titles_common__Nullable________________1": { "properties": { "инн_участ": { "type": "string", "maxLength": 12, "minLength": 10, "nullable": true, "title": "Инн Участ" }, "инф_участ": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Инф Участ" } }, "type": "object", "title": "NullableИнфДляУчастТип" }, "app__core__schemas__titles_full__titles_common__Nullable________________2": { "properties": { "ид_стат": { "type": "string", "enum": [ "ЮЛ", "ФЛ" ], "nullable": true, "title": "Ид Стат" }, "стран": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Стран" }, "наим": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Наим" }, "идентиф": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Идентиф" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "уд_личн_ин_фл": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable_______________1" }, { "type": "null" } ] } }, "type": "object", "title": "NullableСвИнНеУчТрНТип" }, "app__core__schemas__titles_full__titles_common__Nullable________________3": { "properties": { "инф_для_участ": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable________________1" }, { "type": "null" } ] }, "ид_св": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable_________1" }, { "type": "null" } ] }, "адрес": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable__________2" }, { "type": "null" } ] }, "контакт": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable____________4" }, { "type": "null" } ] } }, "type": "object", "title": "NullableУчастникТрНТип" }, "app__core__schemas__titles_full__titles_common__Nullable________________5": { "properties": { "ном_ср": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Ном Ср" }, "дата_ср": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "(((0[1-9]{1}|[1-2]{1}[0-9]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((30)\\.(01|0[3-9]{1}|1[0-2]{1}))|((31)\\.(01|03|05|07|08|10|12)))\\.(19[0-9]{2}|20[0-9]{2})", "nullable": true, "title": "Дата Ср" }, "срок_ср": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Срок Ср" }, "ид_ср": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Ид Ср" }, "свед_мрш": { "oneOf": [ { "$ref": "#/components/schemas/app__core__schemas__titles_full__titles_common__Nullable____________5" }, { "type": "null" } ] } }, "type": "object", "title": "NullableСпецУслДвижТип" }, "Body_send_title_4_etrn_v1_docflows__docflow_id__titles_title_4_send_post": { "title": "Body_send_title_4_etrn_v1_docflows__docflow_id__titles_title_4_send_post", "required": [ "document", "sign" ], "type": "object", "properties": { "document": { "title": "Document", "type": "string", "description": "XML файл документа.", "format": "binary" }, "sign": { "title": "Sign", "type": "string", "description": "base64 подпись документа (detached)" } } }, "Documents": { "type": "object", "properties": { "id": { "type": "string", "description": "Идентификатор документа" }, "file": { "type": "object", "$ref": "#/components/schemas/File" }, "number": { "type": "string", "description": "Номер документа" }, "date": { "type": "string", "example": "2020-22-11" }, "doctype": { "type": "string", "description": "Тип документа" }, "updated": { "type": "string", "example": "2020-08-11T14:55:57Z", "description": "Дата и время последнего обновления документа" }, "sender": { "type": "object", "$ref": "#/components/schemas/BaseUser", "description": "Отправитель документа" }, "receiver": { "type": "object", "$ref": "#/components/schemas/BaseUser", "description": "Получатель документа" }, "comments": { "type": "object", "properties": { "count": { "type": "string", "description": "Количество комментариев" }, "last": { "type": "string", "description": "Последний комментарий" } } }, "fix_price": { "type": "object", "description": "Информация о прикрепленном заказе", "properties": { "id": { "type": "string", "description": "Идентификатор заказа" }, "link": { "type": "string", "description": "Ссылка на заказ" }, "original_owner": { "type": "string" }, "contact_1": { "type": "string" }, "contact_2": { "type": "string" }, "document_creator": { "type": "string" } } }, "flags": { "type": "array", "description": "Флаги документа сообщающие о доступных действиях", "items": { "type": "string" } } } }, "File": { "type": "object", "properties": { "id": { "type": "string", "example": "f677f504254b4e4dbc3c48b390cdc71e", "description": "Идентификатор файла" }, "timestamp": { "type": "string", "example": "2020-08-25T14:39:14Z", "description": "Дата и время загрузки файла" }, "name": { "type": "string", "example": "b80985868fdc45e59209df7ee48daca9.xml", "description": "Имя файла" }, "mimetype": { "type": "string", "example": "application/vnd.ati-docs.xml", "description": "mimetype файла" }, "xml_template": { "type": "string", "example": "order" }, "size": { "type": "string", "example": 5516, "description": "Размер файла в байтах" } } }, "BaseUser": { "type": "object", "properties": { "ati_id": { "type": "string", "example": 14612, "description": "Идентификатор фирмы в ATI.SU (код в АТИ)" }, "name": { "type": "string", "description": "Название фирмы" }, "user": { "type": "object", "properties": { "ati_id": { "type": "string", "example": "14612.0", "description": "Идентификатор фирмы и контакта" }, "name": { "type": "string", "description": "Название контакта" } } }, "status": { "type": "string" }, "inn": { "type": "string" } } }, "AllNamesSchema": { "title": "AllNamesSchema", "enum": [ "УПД. Счет-фактура", "УПД. Счет-фактура и акт", "УПД. Акт", "УКД. Корректировочный счет-фактура", "УКД. Корректировочный счет-фактура и акт", "УКД. Корректировочный акт", "заказ", "заявка (к договору)", "заявка", "поручение экспедитору", "договор", "акт", "заказ услуги по оформлению пропусков в г. москва", "договор-заявка", "заказ (договор-заявка)", "заказ (табличный вид)", "заявка к договору (табличный вид)", "счет", "счет-фактура", "УПД (счет-фактура)", "уведомление об отказе от исполнения", "уведомление о расторжении в двустороннем порядке", "акт о срыве", "уведомление о составлении акта о непредъявлении груза для перевозки", "уведомление о составлении акта о непредъявлении транспортного средства под погрузку", "доверенность", "информационное письмо", "другой", "акт сверки", "доп. соглашение (к договору)", "накладная", "товарная накладная", "транспортная накладная", "товарно-транспортная накладная", "поздравительная открытка", "unknown" ], "type": "string", "description": "An enumeration." }, "AllTypesSchema": { "title": "AllTypesSchema", "enum": [ "СЧФ", "СЧФДОППродавец", "СЧФДОППокупатель", "ДОППродавец", "ДОППокупатель", "КорСЧФ", "КорСЧФДИСПродавец", "КорСЧФДИСПокупатель", "КорДИСПродавец", "КорДИСПокупатель", "ИзвещениеОПолучении", "ПодтверждениеОператораОбОтправке", "ПодтверждениеОператораОПолучении", "УведомлениеОбУточнении", "ЗапросНаАннулирование", "заказ", "заявка (к договору)", "заявка", "поручение экспедитору", "договор", "акт", "заказ услуги по оформлению пропусков в г. москва", "договор-заявка", "заказ (договор-заявка)", "заказ (табличный вид)", "заявка к договору (табличный вид)", "счет", "счет-фактура", "УПД (счет-фактура)", "уведомление об отказе от исполнения", "уведомление о расторжении в двустороннем порядке", "акт о срыве", "уведомление о составлении акта о непредъявлении груза для перевозки", "уведомление о составлении акта о непредъявлении транспортного средства под погрузку", "доверенность", "информационное письмо", "другой", "акт сверки", "доп. соглашение (к договору)", "накладная", "товарная накладная", "транспортная накладная", "товарно-транспортная накладная", "поздравительная открытка", "unknown" ], "type": "string", "description": "An enumeration." }, "DirectionSchema": { "title": "DirectionSchema", "enum": [ "incoming", "outgoing" ], "type": "string", "description": "An enumeration." }, "CreateEtrnFromOrderDocumentSchema": { "title": "CreateEtrnFromOrderDocumentSchema", "required": [ "order_document_id" ], "type": "object", "properties": { "order_document_id": { "title": "Order Document Id", "type": "string", "minLength": 1, "description": "Идентификатор документа-Заказа", "strip_whitespace": true }, "is_for_expeditor": { "title": "Is For Expeditor", "description": "Создать ЭТрН для экспедитора", "type": "boolean", "nullable": true } } }, "DocflowForOrdersSchema": { "title": "DocflowForOrdersSchema", "required": [ "id", "doctype", "date", "number", "is_draft" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "doctype": { "title": "Doctype", "type": "string" }, "date": { "title": "Date", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "number": { "title": "Number", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_draft": { "title": "Is Draft", "type": "boolean" } } }, "OrderDocumentsListResponseSchema": { "title": "OrderDocumentsListResponseSchema", "required": [ "docflows" ], "type": "object", "properties": { "docflows": { "title": "Docflows", "type": "array", "items": { "$ref": "#/components/schemas/DocflowForOrdersSchema" } } } }, "UpdateParticipantSchema": { "title": "UpdateParticipantSchema", "type": "object", "properties": { "cargo_carrier": { "$ref": "#/components/schemas/UserData" }, "cargo_receiver": { "$ref": "#/components/schemas/UserData" } } }, "UserData": { "title": "UserData", "required": [ "firm_id", "contact_id" ], "type": "object", "properties": { "firm_id": { "title": "Firm Id", "pattern": "[0-9]+", "type": "string", "description": "Идентификатор пользователя в АТИ" }, "contact_id": { "title": "Contact Id", "type": "integer", "description": "Идентификатор контакта пользователя в фирме" }, "user_astral_id": { "title": "User Astral Id", "type": "string", "description": "Идентификатор пользователя в Астрал" } }, "description": "Информация о пользователе, где \"cargo_sender\" - это отправитель, \"cargo_carrier\" - перевозчик, \"cargo_receiver\" - получатель" }, "FileIdResponseSchema": { "title": "FileIdResponseSchema", "required": [ "id" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" } }, "description": "Возвращает id файла" }, "DocumentsListCommentTailSchema": { "title": "DocumentsListCommentTailSchema", "required": [ "name", "text", "timestamp" ], "type": "object", "properties": { "name": { "title": "Name", "type": "string" }, "text": { "title": "Text", "type": "string" }, "timestamp": { "title": "Timestamp", "type": "string", "format": "date-time" } } }, "DocumentsListCommentsSchema": { "title": "DocumentsListCommentsSchema", "required": [ "count" ], "type": "object", "properties": { "count": { "title": "Count", "type": "integer", "description": "Количество комментариев" }, "tail": { "$ref": "#/components/schemas/DocumentsListCommentTailSchema" } } }, "DocumentsListContragentSchema": { "title": "DocumentsListContragentSchema", "required": [ "ati_code", "name" ], "type": "object", "properties": { "ati_code": { "title": "Ati Code", "type": "string" }, "name": { "title": "Name", "type": "string" } } }, "GenerateDocData": { "title": "GenerateDocData", "enum": [ "pdf", "qr" ], "type": "string", "description": "An enumeration." }, "DocumentsListFiltersSchema": { "title": "DocumentsListFiltersSchema", "type": "object", "properties": { "query": { "title": "Query", "type": "string" }, "type": { "$ref": "#/components/schemas/AllTypesSchema" }, "status": { "$ref": "#/components/schemas/FrontStateSchema" }, "contragent_ati_code": { "title": "Contragent Ati Code", "pattern": "^\\d+$", "type": "string" }, "edo_user": { "title": "Edo User", "type": "string", "description": "ID участника ЭДО(текущего пользователя)" }, "number": { "title": "Number", "type": "string", "description": "Номер документа" }, "date_from": { "title": "Date From", "type": "string", "format": "date" }, "date_to": { "title": "Date To", "type": "string", "format": "date" }, "direction": { "$ref": "#/components/schemas/DirectionSchema" }, "is_deleted": { "title": "Is Deleted", "type": "boolean", "default": false }, "is_archived": { "title": "Is Archived", "type": "boolean", "default": false }, "is_template": { "title": "Is Template", "type": "boolean", "default": false } } }, "DocumentsListResponseSchema": { "title": "DocumentsListResponseSchema", "required": [ "total", "total_remaining", "result" ], "type": "object", "properties": { "total": { "title": "Total", "type": "integer" }, "total_remaining": { "title": "Total Remaining", "type": "integer" }, "result": { "title": "Result", "type": "array", "items": { "$ref": "#/components/schemas/DocumentsListResultSchema" } } } }, "DocumentsListResultSchema": { "title": "DocumentsListResultSchema", "required": [ "id", "direction", "type", "status", "is_read", "updated_at", "comments", "flags", "signs" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "is_riak": { "title": "Is Riak", "type": "boolean" }, "direction": { "$ref": "#/components/schemas/DirectionSchema" }, "number": { "title": "Number", "type": "string" }, "date": { "title": "Date", "type": "string", "format": "date" }, "type": { "$ref": "#/components/schemas/AllNamesSchema" }, "status": { "title": "Status", "type": "string" }, "is_read": { "title": "Is Read", "type": "boolean" }, "updated_at": { "title": "Updated At", "type": "string", "format": "date-time" }, "contragent": { "$ref": "#/components/schemas/DocumentsListContragentSchema" }, "comments": { "$ref": "#/components/schemas/DocumentsListCommentsSchema" }, "flags": { "title": "Flags", "type": "array", "items": { "type": "string" } }, "highlight": { "$ref": "#/components/schemas/HighlightOptions" }, "signs": { "$ref": "#/components/schemas/SignsInfoSchema" }, "template_name": { "title": "Template Name", "type": "string" } } }, "DocumentsListSearchParamsSchema": { "title": "DocumentsListSearchParamsSchema", "type": "object", "properties": { "limit": { "title": "Limit", "maximum": 100, "minimum": 1, "type": "integer", "default": 50 }, "updated_at__lt": { "title": "Updated At Lt", "type": "string", "format": "date-time" }, "filters": { "$ref": "#/components/schemas/DocumentsListFiltersSchema" } } }, "UserHitSchema": { "title": "UserHitSchema", "required": [ "astral_user_id", "firm_id", "name", "account_id", "default_contact_id" ], "type": "object", "properties": { "astral_user_id": { "title": "Astral User Id", "type": "string", "description": "Идентификатор astral_user" }, "firm_id": { "title": "Firm Id", "type": "string", "description": "Идентификатор фирмы" }, "name": { "title": "Name", "type": "string", "description": "Наименование участника" }, "account_id": { "title": "Account Id", "type": "string", "description": "Идентификатор аккаунта АТИ" }, "default_contact_id": { "title": "Default Contact Id", "type": "integer", "description": "Идентификатор контакта аккаунта по умолчанию" } } }, "FrontStateSchema": { "title": "FrontStateSchema", "enum": [ "AWAITING_CONFIRMATION_SIGN", "WAITING_FOR_REVOKE", "CORRECTION_REQUESTED", "AWAITING_DECISION", "REVOKED", "EDO_DONE", "APPROVED", "DECLINED", "SIGNED", "NEW_EDITION", "CANCELLED", "DRAFT" ], "type": "string", "description": "An enumeration." }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "HighlightOptions": { "title": "HighlightOptions", "enum": [ "failure", "success", null ], "description": "An enumeration." }, "IssuerSchema": { "title": "IssuerSchema", "required": [ "OGRN", "INN", "CN" ], "type": "object", "properties": { "OGRN": { "title": "Ogrn", "type": "string" }, "INN": { "title": "Inn", "type": "string" }, "CN": { "title": "Cn", "type": "string" } }, "description": "Описывает схему документа в MongoDB.\nВсе вложенные в схему документы должны наследоваться от этого класса." }, "ScopeOfAuthorityBuyerSchema": { "title": "ScopeOfAuthorityBuyerSchema", "enum": [ "1", "2", "3", "29" ], "type": "string", "description": "An enumeration." }, "ScopeOfAuthorityRoutersSchema": { "title": "ScopeOfAuthorityRoutersSchema", "required": [ "sender", "receiver" ], "type": "object", "properties": { "sender": { "$ref": "#/components/schemas/ScopeOfAuthoritySellerSchema" }, "receiver": { "$ref": "#/components/schemas/ScopeOfAuthorityBuyerSchema" } }, "description": "Область полномочий" }, "ScopeOfAuthoritySellerSchema": { "type": "string", "enum": [ "0", "1", "2", "3", "4", "5", "6" ], "title": "ScopeOfAuthoritySellerSchema" }, "ShortSignerInfoSchema": { "title": "ShortSignerInfoSchema", "required": [ "title", "valid_from", "valid_until" ], "type": "object", "properties": { "title": { "title": "Title", "type": "string" }, "valid_from": { "title": "Valid From", "type": "string" }, "valid_until": { "title": "Valid Until", "type": "string" } } }, "SignatoryCredentialSchema": { "title": "SignatoryCredentialSchema", "required": [ "scope_of_authority", "status", "foundation_for_trust", "position", "certificate_id" ], "type": "object", "properties": { "scope_of_authority": { "$ref": "#/components/schemas/ScopeOfAuthorityRoutersSchema" }, "status": { "allOf": [ { "$ref": "#/components/schemas/SigneeStatusSchema" } ], "description": "Статус" }, "foundation_for_trust": { "title": "Foundation For Trust", "maxLength": 255, "minLength": 1, "type": "string", "description": "Основные полномочия" }, "foundation_for_trust_organization": { "title": "Foundation For Trust Organization", "maxLength": 255, "minLength": 1, "type": "string", "description": "Основные полномочия организации" }, "position": { "title": "Position", "maxLength": 128, "minLength": 1, "type": "string", "description": "Должность" }, "certificate_id": { "title": "Certificate Id", "type": "string" } }, "description": "Описывает схему документа в MongoDB.\nВсе вложенные в схему документы должны наследоваться от этого класса." }, "SigneeStatusSchema": { "title": "SigneeStatusSchema", "enum": [ "3", "4", "5", "6" ], "type": "string", "description": "An enumeration." }, "SignerSchema": { "properties": { "first_name": { "type": "string", "maxLength": 60, "minLength": 1, "title": "First Name", "description": "Имя подписанта" }, "last_name": { "type": "string", "maxLength": 60, "minLength": 1, "title": "Last Name", "description": "Фамилия подписанта" }, "patronymic": { "type": "string", "maxLength": 60, "nullable": true, "title": "Patronymic" }, "position": { "type": "string", "maxLength": 255, "nullable": true, "title": "Position" } }, "type": "object", "required": [ "first_name", "last_name" ], "title": "SignerSchema" }, "SignsInfoSchema": { "title": "SignsInfoSchema", "type": "object", "properties": { "user": { "$ref": "#/components/schemas/ShortSignerInfoSchema" }, "contragent": { "$ref": "#/components/schemas/ShortSignerInfoSchema" } } }, "UserCertificateSchema": { "title": "UserCertificateSchema", "required": [ "id", "valid_from", "valid_until", "issuer", "components", "title" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" }, "valid_from": { "title": "Valid From", "type": "string", "format": "date-time" }, "valid_until": { "title": "Valid Until", "type": "string", "format": "date-time" }, "serial": { "title": "Serial", "type": "string" }, "issuer": { "$ref": "#/components/schemas/IssuerSchema" }, "components": { "$ref": "#/components/schemas/UserComponentsSchema" }, "title": { "title": "Title", "type": "string" }, "body": { "title": "Body", "type": "string" }, "created_at": { "title": "Created At", "type": "string", "format": "date-time" } }, "description": "Описывает схему документа в MongoDB.\nВсе вложенные в схему документы должны наследоваться от этого класса." }, "UserComponentsSchema": { "title": "UserComponentsSchema", "required": [ "INN", "CN", "GN", "SN" ], "type": "object", "properties": { "SNILS": { "title": "Snils", "type": "string" }, "OGRN": { "title": "Ogrn", "type": "string" }, "INN": { "title": "Inn", "type": "string" }, "emailAddress": { "title": "Emailaddress", "type": "string" }, "C": { "title": "C", "type": "string" }, "ST": { "title": "St", "type": "string" }, "L": { "title": "L", "type": "string" }, "O": { "title": "O", "type": "string" }, "CN": { "title": "Cn", "type": "string" }, "street": { "title": "Street", "type": "string" }, "unstructuredName": { "title": "Unstructuredname", "type": "string" }, "title": { "title": "Title", "type": "string" }, "GN": { "title": "Gn", "type": "string" }, "SN": { "title": "Sn", "type": "string" } }, "description": "Описывает схему документа в MongoDB.\nВсе вложенные в схему документы должны наследоваться от этого класса." }, "UserSchema": { "title": "UserSchema", "required": [ "inn" ], "type": "object", "properties": { "inn": { "title": "Inn", "type": "string" }, "first_name": { "title": "First Name", "type": "string" }, "last_name": { "title": "Last Name", "type": "string" }, "patronymic": { "title": "Patronymic", "type": "string" }, "full_name": { "title": "Full Name", "type": "string" }, "kpp": { "title": "Kpp", "type": "string" }, "ati_id": { "title": "Ati Id", "type": "string", "description": "Алиас фирмы участника" }, "default": { "title": "Default", "type": "boolean", "default": false }, "is_roaming_user": { "title": "Is Roaming User", "type": "boolean", "default": false }, "id": { "title": "Id", "type": "string" }, "roaming_operator_id": { "title": "Roaming Operator Id", "type": "string" }, "created_at": { "title": "Created At", "type": "string", "format": "date-time" }, "certificates": { "title": "Certificates", "type": "array", "items": { "$ref": "#/components/schemas/UserCertificateSchema" } }, "signatory_credentials": { "title": "Signatory Credentials", "type": "array", "items": { "$ref": "#/components/schemas/SignatoryCredentialSchema" } } }, "description": "Описывает схему документа в MongoDB.\nВсе вложенные в схему документы должны наследоваться от этого класса." }, "ValidationError": { "properties": { "loc": { "items": { "enum": [ "string", "integer" ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "Comment2": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "2020-02-26T15:24:00.000Z" }, "text": { "type": "string", "description": "Текст сообщения" }, "has_attachments": { "type": "boolean", "example": false }, "attachment": { "type": "object", "description": "Данные вложения", "properties": { "id": { "type": "string", "example": "95a971edb0994372aa6b76a9e1be8bdb" }, "size": { "type": "integer", "example": 429939, "description": "Размер файла" }, "name": { "type": "string", "example": "Книга новичка АТИ.pdf", "description": "Название файла" }, "mimetype": { "type": "string", "example": "application/pdf" } } }, "user": { "type": "object", "description": "Данные пользователя", "properties": { "id": { "type": "string", "example": "765044.0", "description": "ati id" }, "fn": { "type": "string", "example": "wefwef_1!", "description": "Имя юзера" } } } } }, "DocumentData": { "description": "Данные для создания документа", "properties": { "date": { "description": "Дата документа", "format": "date", "type": "string" }, "doc_recipient_contact": { "$ref": "#/components/schemas/UserCode" }, "doc_request": { "description": "Флаг запроса решения для документа. Если это поле не передается, то для новых документов\nзапрос решения остается без изменений. Если это передается, то в документе для флага\nбудет использовано переданное значение.\n", "type": "boolean" }, "doc_sender_contact": { "$ref": "#/components/schemas/UserCode" }, "doctype": { "description": "Тип документа", "type": "string", "enum": [ "акт", "доверенность", "договор", "заказ", "заказ (табличный вид)", "заявка (к договору)", "заявка к договору (табличный вид)", "поручение экспедитору", "счет", "другой" ] }, "id": { "description": "Идентификатор документа", "type": "string" }, "number": { "description": "Номер документа", "type": "string" }, "xmlBody": { "description": "Тело документа в формате xml, в виде строки", "type": "string" } }, "type": "object" }, "DocumentUpdateResult": { "description": "Результат сохранения документа", "example": { "ok": true, "result": "12345676554321" }, "properties": { "ok": { "$ref": "#/components/schemas/OkResult" }, "result": { "description": "Идентификатор документа", "type": "string" } }, "type": "object" }, "doki__ErrorResponse": { "description": "Сообщение об ошибке", "properties": { "error": { "description": "Код ошибки", "example": "bad_request", "nullable": false, "type": "string" }, "reason": { "description": "Описание ошибки и возможная причина", "example": "Ошибка в запросе", "type": "string" } }, "required": [ "error", "reason" ], "type": "object" }, "NotFoundError": { "description": "Документ не найден", "properties": { "error": { "enum": [ "true" ], "type": "boolean" }, "reason": { "enum": [ "Документ не найден" ], "type": "string" } }, "type": "object" }, "OkResult": { "enum": [ true ], "type": "boolean" }, "DocflowIdResponseSchema": { "title": "DocflowIdResponseSchema", "required": [ "id" ], "type": "object", "properties": { "id": { "title": "Id", "type": "string" } }, "description": "Возвращает id документооборота" }, "UserCode": { "description": "Код пользователя в ATI.SU в формате <код фирмы>.", "type": "string" }, "ActionTypeEnum": { "type": "string", "enum": [ "start_sending", "confirm_sending", "start_receiving", "confirm_receiving", "roaming_error" ], "title": "ActionTypeEnum" }, "ActorTypeEnum": { "type": "string", "enum": [ "sender_user", "sender_operator", "receiver_user", "receiver_operator" ], "title": "ActorTypeEnum" }, "AuxDocumentInputSchema": { "properties": { "signer_info": { "$ref": "#/components/schemas/SignerSchema", "description": "Данные подписанта" }, "mchd_info": { "$ref": "#/components/schemas/MCHDSchema", "nullable": true } }, "type": "object", "required": [ "signer_info" ], "title": "AuxDocumentInputSchema" }, "Body_upload_title_1_body_from_xml_for_accounting_v4_docflows__docflow_id__documents_title_1_xml_put": { "properties": { "file": { "type": "string", "format": "binary", "title": "File", "description": "Файл документа" } }, "type": "object", "required": [ "file" ], "title": "Body_upload_title_1_body_from_xml_for_accounting_v4_docflows__docflow_id__documents_title_1_xml_put" }, "CombinedDocflowStateEnum": { "type": "string", "enum": [ "draft", "waiting_for_roaming_provider_confirmation", "waiting_for_roaming_user_response", "waiting_for_read_confirmation", "waiting_for_title_2", "clarification_notification_requested", "done", "roaming_error", "receiver_refused_to_sign", "annulment_requested", "annulment_done" ], "title": "CombinedDocflowStateEnum", "description": "Статусы ДО, нужные для вывода на фронте (левый сайдбар) и в списке документов\n\nМногие совпадают с `DocflowStateEnum`, но в некоторых случаях учитывается не только\nстатус самого ДО, но и статус документов внутри ДО" }, "DocflowFlagEnum": { "type": "string", "enum": [ "can_be_archived", "can_be_deleted", "can_be_unarchived", "can_be_undeleted", "can_be_annulled", "needs_read_confirmation", "edo_can_be_signed" ], "title": "DocflowFlagEnum", "description": "Флаги доступности действий над документооборотом" }, "DocflowIDSchema": { "properties": { "id": { "type": "string", "title": "Id", "description": "ID документооборота" } }, "type": "object", "required": [ "id" ], "title": "DocflowIDSchema" }, "DocflowInputSchema": { "properties": { "doctype": { "$ref": "#/components/schemas/SargonDoctypeEnum", "description": "Тип документа" }, "number": { "type": "string", "nullable": true, "title": "Number", "description": "Номер документа" }, "date": { "type": "string", "format": "date", "nullable": true, "title": "Date", "description": "Дата документа" }, "sender_edo_id": { "type": "string", "title": "Sender Edo Id", "description": "EDO ID отправителя документооборота" }, "receiver": { "oneOf": [ { "$ref": "#/components/schemas/NativeParticipantInputSchema" }, { "$ref": "#/components/schemas/RoamingParticipantInputSchema" } ], "discriminator": { "propertyName": "type", "mapping": { "native": "#/components/schemas/NativeParticipantInputSchema", "roaming": "#/components/schemas/RoamingParticipantInputSchema" } }, "nullable": true, "title": "Receiver", "description": "Информация о получателе документооборота" }, "ati_admin_id": { "type": "string", "nullable": true, "title": "Ati Admin Id", "description": "Идентификатор ДО, если документ был создан через АтиАдмин" } }, "type": "object", "required": [ "doctype", "sender_edo_id" ], "title": "DocflowInputSchema" }, "EnrichedDocflowMetaSchema": { "properties": { "doctype": { "$ref": "#/components/schemas/SargonDoctypeEnum", "description": "Тип документа" }, "number": { "type": "string", "nullable": true, "title": "Number", "description": "Номер документа" }, "date": { "type": "string", "format": "date", "nullable": true, "title": "Date", "description": "Дата документа" }, "id": { "type": "string", "title": "Id", "description": "ID документооборота" }, "state": { "$ref": "#/components/schemas/CombinedDocflowStateEnum", "description": "Статус документооборота" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "Дата создания документооборота" }, "updated_at": { "type": "string", "format": "date-time", "title": "Updated At", "description": "Дата обновления документооборота" }, "sender": { "oneOf": [ { "$ref": "#/components/schemas/EnrichedNativeParticipantData" }, { "$ref": "#/components/schemas/EnrichedRoamingParticipantData" } ], "title": "Sender", "description": "Информация об отправителе", "discriminator": { "propertyName": "user_type", "mapping": { "native": "#/components/schemas/EnrichedNativeParticipantData", "roaming": "#/components/schemas/EnrichedRoamingParticipantData" } } }, "receiver": { "oneOf": [ { "$ref": "#/components/schemas/EnrichedNativeParticipantData" }, { "$ref": "#/components/schemas/EnrichedRoamingParticipantData" } ], "discriminator": { "propertyName": "user_type", "mapping": { "native": "#/components/schemas/EnrichedNativeParticipantData", "roaming": "#/components/schemas/EnrichedRoamingParticipantData" } }, "nullable": true, "title": "Receiver", "description": "Информация о получателе" }, "flags": { "items": { "$ref": "#/components/schemas/DocflowFlagEnum" }, "type": "array", "title": "Flags", "description": "Флаги доступности действий над документооборотом" } }, "type": "object", "required": [ "doctype", "id", "state", "created_at", "updated_at", "sender", "flags" ], "title": "EnrichedDocflowMetaSchema" }, "DocflowUpdateSchema": { "properties": { "doctype": { "$ref": "#/components/schemas/SargonDoctypeEnum", "description": "Тип документа" }, "number": { "type": "string", "nullable": true, "title": "Number", "description": "Номер документа" }, "date": { "type": "string", "format": "date", "nullable": true, "title": "Date", "description": "Дата документа" }, "sender_edo_id": { "type": "string", "title": "Sender Edo Id", "description": "EDO ID отправителя документооборота" }, "receiver": { "oneOf": [ { "$ref": "#/components/schemas/NativeParticipantInputSchema" }, { "$ref": "#/components/schemas/RoamingParticipantInputSchema" } ], "discriminator": { "propertyName": "type", "mapping": { "native": "#/components/schemas/NativeParticipantInputSchema", "roaming": "#/components/schemas/RoamingParticipantInputSchema" } }, "nullable": true, "title": "Receiver", "description": "Информация о получателе документооборота" } }, "type": "object", "required": [ "doctype", "sender_edo_id" ], "title": "DocflowUpdateSchema" }, "DocumentTypeEnum": { "type": "string", "enum": [ "title-1", "title-1-read-confirmation", "title-1-clarification-notification", "title-1-signature-rejection", "title-2", "title-2-read-confirmation" ], "title": "DocumentTypeEnum" }, "EnrichedNativeParticipantData": { "properties": { "signature": { "$ref": "#/components/schemas/EnrichedSignatureSchema", "nullable": true }, "user_type": { "type": "string", "const": "native", "title": "User Type", "description": "Тип пользователя", "default": "native" }, "ati_id": { "type": "string", "nullable": true, "title": "Ati Id", "description": "Алиас фирмы участника" }, "firm_name": { "type": "string", "nullable": true, "title": "Firm Name", "description": "Название фирмы участника" }, "contact_id": { "type": "integer", "title": "Contact Id", "description": "ID контакта" }, "contact_name": { "type": "string", "nullable": true, "title": "Contact Name", "description": "Название контакта участника" }, "edo_user_id": { "type": "string", "nullable": true, "title": "Edo User Id", "description": "ID участника ЭДО" } }, "type": "object", "required": [ "ati_id", "firm_name", "contact_id", "contact_name", "edo_user_id" ], "title": "EnrichedNativeParticipantData" }, "EnrichedRoamingParticipantData": { "properties": { "signature": { "$ref": "#/components/schemas/EnrichedSignatureSchema", "nullable": true }, "user_type": { "type": "string", "const": "roaming", "title": "User Type", "description": "Тип пользователя", "default": "roaming" }, "agent_name": { "type": "string", "title": "Agent Name", "description": "Название роуминговой фирмы" }, "edo_user_id": { "type": "string", "title": "Edo User Id", "description": "ID участника ЭДО" }, "roaming_provider_id": { "type": "string", "title": "Roaming Provider Id", "description": "ID роумингового оператора" }, "roaming_provider_name": { "type": "string", "title": "Roaming Provider Name", "description": "Название роумингового оператора" } }, "type": "object", "required": [ "agent_name", "edo_user_id", "roaming_provider_id", "roaming_provider_name" ], "title": "EnrichedRoamingParticipantData" }, "EnrichedSignatureSchema": { "properties": { "certificate_id": { "type": "string", "title": "Certificate Id", "description": "ID сертификата в sign_checker-е" }, "mchd_id": { "type": "string", "nullable": true, "title": "Mchd Id", "description": "ID машиночитаемой доверенности" } }, "type": "object", "required": [ "certificate_id" ], "title": "EnrichedSignatureSchema" }, "HadesHistoryRecordData": { "properties": { "document_type": { "$ref": "#/components/schemas/DocumentTypeEnum", "description": "Какой документ изменялся" }, "action_type": { "$ref": "#/components/schemas/ActionTypeEnum", "description": "Какое действие было совершено" }, "actor_type": { "$ref": "#/components/schemas/ActorTypeEnum", "description": "Кто совершил действие" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "Временная отметка события" }, "is_annulment": { "type": "boolean", "title": "Is Annulment", "description": "Признак, который указывает на предложение об аннулировании", "default": true }, "comment": { "type": "string", "nullable": true, "title": "Comment" } }, "type": "object", "required": [ "document_type", "action_type", "actor_type" ], "title": "HadesHistoryRecordData" }, "HistoryRecordData": { "properties": { "document_type": { "$ref": "#/components/schemas/DocumentTypeEnum", "description": "Какой документ изменялся" }, "action_type": { "$ref": "#/components/schemas/ActionTypeEnum", "description": "Какое действие было совершено" }, "actor_type": { "$ref": "#/components/schemas/ActorTypeEnum", "description": "Кто совершил действие" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At", "description": "Временная отметка события" } }, "type": "object", "required": [ "document_type", "action_type", "actor_type" ], "title": "HistoryRecordData" }, "MCHDSchema": { "properties": { "mchd_id": { "type": "string", "maxLength": 36, "minLength": 36, "title": "Mchd Id", "description": "ID машиночитаемой доверенности" }, "mchd_issued_at": { "type": "string", "format": "date-time", "title": "Mchd Issued At", "description": "Дата выдачи доверенности" } }, "type": "object", "required": [ "mchd_id", "mchd_issued_at" ], "title": "MCHDSchema" }, "NativeParticipantInputSchema": { "properties": { "type": { "type": "string", "const": "native", "title": "Type", "default": "native" }, "account_id": { "type": "string", "title": "Account Id", "description": "ID аккаунта" }, "contact_id": { "type": "integer", "title": "Contact Id", "description": "ID контакта" }, "edo_user_id": { "type": "string", "nullable": true, "title": "Edo User Id", "description": "ID участника ЭДО" } }, "type": "object", "required": [ "account_id", "contact_id" ], "title": "NativeParticipantInputSchema" }, "RoamingParticipantInputSchema": { "properties": { "type": { "type": "string", "const": "roaming", "title": "Type", "default": "roaming" }, "edo_user_id": { "type": "string", "title": "Edo User Id", "description": "ID участника ЭДО" } }, "type": "object", "required": [ "edo_user_id" ], "title": "RoamingParticipantInputSchema" }, "SargonDoctypeEnum": { "type": "string", "enum": [ "upd_dop", "upd_schf", "upd_schfdop" ], "title": "SargonDoctypeEnum" }, "UPDBuyerTitleV501FullSchema": { "properties": { "ид_файл": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Ид Файл" }, "верс_форм": { "type": "string", "const": "5.01", "title": "Верс Форм", "default": "5.01" }, "верс_прог": { "type": "string", "maxLength": 40, "minLength": 1, "nullable": true, "title": "Верс Прог" }, "св_уч_док_обор": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01__________________1" }, "инф_пок": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01_____________4" } }, "type": "object", "required": [ "ид_файл", "св_уч_док_обор", "инф_пок" ], "title": "UPDBuyerTitleV501FullSchema", "description": "Параметры в соответствии с приказом ФНС РФ от 19.12.2018 N ММВ-7-15/820 (nalog.gov.ru, normativ.kontur.ru)" }, "UPDBuyerTitleV501NullableSchema": { "properties": { "верс_форм": { "type": "string", "const": "5.01", "title": "Верс Форм" }, "инф_пок": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01_____________4" } }, "type": "object", "required": [ "верс_форм" ], "title": "UPDBuyerTitleV501NullableSchema", "description": "Параметры в соответствии с приказом ФНС РФ от 19.12.2018 N ММВ-7-15/820 (nalog.gov.ru, normativ.kontur.ru)" }, "UPDBuyerTitleV503FullSchema": { "properties": { "ид_файл": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Ид Файл" }, "верс_форм": { "type": "string", "const": "5.03", "title": "Верс Форм", "default": "5.03" }, "верс_прог": { "type": "string", "maxLength": 40, "minLength": 1, "title": "Верс Прог" }, "документ": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_03_______________3" } }, "type": "object", "required": [ "ид_файл", "верс_прог", "документ" ], "title": "UPDBuyerTitleV503FullSchema", "description": "Параметры в соответствии с приказом ФНС РФ от 19.12.2023 N ЕД-7-26/970 (nalog.gov.ru, normativ.kontur.ru)" }, "UPDBuyerTitleV503NullableSchema": { "properties": { "верс_форм": { "type": "string", "const": "5.03", "title": "Верс Форм" }, "документ": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_03_______________2" } }, "type": "object", "required": [ "верс_форм" ], "title": "UPDBuyerTitleV503NullableSchema", "description": "Параметры в соответствии с приказом ФНС РФ от 19.12.2023 N ЕД-7-26/970 (nalog.gov.ru, normativ.kontur.ru)" }, "UPDFunctionEnum": { "type": "string", "enum": [ "ДОП", "СЧФ", "СЧФДОП" ], "title": "UPDFunctionEnum" }, "UPDSellerTitleV501FullSchema": { "properties": { "ид_файл": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Ид Файл" }, "верс_форм": { "type": "string", "const": "5.01", "title": "Верс Форм", "default": "5.01" }, "верс_прог": { "type": "string", "maxLength": 40, "minLength": 1, "title": "Верс Прог" }, "св_уч_док_обор": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01__________________1" }, "документ": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_______________11" } }, "type": "object", "required": [ "ид_файл", "верс_прог", "св_уч_док_обор", "документ" ], "title": "UPDSellerTitleV501FullSchema" }, "UPDSellerTitleV501NullableSchema": { "properties": { "верс_форм": { "type": "string", "const": "5.01", "title": "Верс Форм" }, "верс_прог": { "type": "string", "maxLength": 40, "minLength": 1, "nullable": true, "title": "Верс Прог" }, "св_уч_док_обор": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01__________________1" }, "документ": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_______________11" } }, "type": "object", "required": [ "верс_форм" ], "title": "UPDSellerTitleV501NullableSchema" }, "UPDSellerTitleV503FullSchema": { "properties": { "ид_файл": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Ид Файл" }, "верс_форм": { "type": "string", "const": "5.03", "title": "Верс Форм", "default": "5.03" }, "верс_прог": { "type": "string", "maxLength": 40, "minLength": 1, "title": "Верс Прог" }, "документ": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_______________9" } }, "type": "object", "required": [ "ид_файл", "верс_прог", "документ" ], "title": "UPDSellerTitleV503FullSchema" }, "UPDSellerTitleV503NullableSchema": { "properties": { "верс_форм": { "type": "string", "const": "5.03", "title": "Верс Форм" }, "верс_прог": { "type": "string", "maxLength": 40, "minLength": 1, "nullable": true, "title": "Верс Прог" }, "документ": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03_______________9" } }, "type": "object", "required": [ "верс_форм" ], "title": "UPDSellerTitleV503NullableSchema" }, "app__schemas__upd_full__buyer_title_5_01_______": { "properties": { "иннюл": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}", "title": "Иннюл" }, "наим_орг": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Наим Орг" }, "должн": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Должн" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________" } }, "type": "object", "required": [ "иннюл", "должн", "фио" ], "title": "ЮЛТип" }, "app__schemas__upd_full__buyer_title_5_01________": { "properties": { "фамилия": { "type": "string", "maxLength": 60, "minLength": 1, "title": "Фамилия" }, "имя": { "type": "string", "maxLength": 60, "minLength": 1, "title": "Имя" }, "отчество": { "type": "string", "maxLength": 60, "minLength": 1, "nullable": true, "title": "Отчество" } }, "type": "object", "required": [ "фамилия", "имя" ], "title": "ФИОТип", "description": "Фамилия, имя, отчество физического лица
• `фамилия`: Фамилия
• `имя`: Имя
• `отчество`: Отчество" }, "app__schemas__upd_full__buyer_title_5_01________4___": { "properties": { "наим_док_опр_пр": { "type": "string", "maxLength": 255, "minLength": 0, "nullable": true, "title": "Наим Док Опр Пр" }, "функция": { "$ref": "#/components/schemas/UPDFunctionEnum", "maxLength": 6, "minLength": 1 }, "ном_сч_ф_инф_пр": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Ном Сч Ф Инф Пр" }, "дата_сч_ф_инф_пр": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "title": "Дата Сч Ф Инф Пр" }, "вид_операции": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Вид Операции" }, "св_прин": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01_____________3" }, "инф_пол_фхж4": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01___________4___", "nullable": true } }, "type": "object", "required": [ "функция", "дата_сч_ф_инф_пр", "св_прин" ], "title": "СодФХЖ4Тип" }, "app__schemas__upd_full__buyer_title_5_01___________1": { "properties": { "иннфл": { "type": "string", "maxLength": 12, "minLength": 12, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}", "nullable": true, "title": "Иннфл" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________" } }, "type": "object", "required": [ "фио" ], "title": "СвФЛТип", "description": "Сведения о физическом лице
• `иннфл`: ИНН
• `иные_свед`: Иные сведения, идентифицирующие физическое лицо
• `фио`: Фамилия, имя, отчество" }, "app__schemas__upd_full__buyer_title_5_01___________2": { "properties": { "иннфл": { "type": "string", "maxLength": 12, "minLength": 12, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}", "title": "Иннфл" }, "св_гос_рег_ип": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Св Гос Рег Ип" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________" } }, "type": "object", "required": [ "иннфл", "фио" ], "title": "СвИПТип", "description": "Сведения о индивидуальном предпринимателе
• `иннфл`: ИНН
• `св_гос_рег_ип`: Реквизиты свидетельства о государственной регистрации индивидуального предпринимателя
• `иные_свед`: Иные сведения, идентифицирующие физическое лицо
• `фио`: Фамилия, имя, отчество" }, "app__schemas__upd_full__buyer_title_5_01___________4___": { "properties": { "ид_файл_инф_пол": { "type": "string", "maxLength": 36, "minLength": 36, "nullable": true, "title": "Ид Файл Инф Пол" }, "текст_инф": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01_____________" }, "type": "array", "title": "Текст Инф", "default": [] } }, "type": "object", "title": "ИнфПолФХЖ4Тип" }, "app__schemas__upd_full__buyer_title_5_01_____________": { "properties": { "идентиф": { "type": "string", "maxLength": 50, "minLength": 1, "title": "Идентиф" }, "значен": { "type": "string", "maxLength": 2000, "minLength": 1, "title": "Значен" } }, "type": "object", "required": [ "идентиф", "значен" ], "title": "ТекстИнфТип" }, "app__schemas__upd_full__buyer_title_5_01_____________1": { "properties": { "осн_довер_фл": { "type": "string", "maxLength": 120, "minLength": 1, "nullable": true, "title": "Осн Довер Фл" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________" } }, "type": "object", "required": [ "фио" ], "title": "ФЛПринТип" }, "app__schemas__upd_full__buyer_title_5_01_____________2": { "properties": { "пред_орг_прин": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01__________________2", "nullable": true }, "фл_прин": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01_____________1", "nullable": true } }, "type": "object", "title": "ИнЛицоТип" }, "app__schemas__upd_full__buyer_title_5_01_____________3": { "properties": { "сод_опер": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Сод Опер" }, "дата_прин": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Прин" }, "код_сод_опер": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01_______________", "nullable": true }, "св_лиц_прин": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________________4", "nullable": true } }, "type": "object", "title": "СвПринТип" }, "app__schemas__upd_full__buyer_title_5_01_____________4": { "properties": { "кнд": { "type": "string", "const": "1115132", "title": "Кнд", "default": "1115132" }, "дата_инф_пок": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "title": "Дата Инф Пок" }, "врем_инф_пок": { "type": "string", "maxLength": 8, "minLength": 8, "pattern": "([0-1]{1}[0-9]{1}|2[0-3]{1})\\.([0-5]{1}[0-9]{1})\\.([0-5]{1}[0-9]{1})", "title": "Врем Инф Пок" }, "наим_экон_суб_сост": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Наим Экон Суб Сост" }, "осн_довер_орг_сост": { "type": "string", "maxLength": 120, "minLength": 1, "nullable": true, "title": "Осн Довер Орг Сост" }, "ид_инф_прод": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________________2" }, "сод_фхж4": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________4___" }, "инф_пок_гос_зак_казн": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01_____________________", "nullable": true }, "подписант": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________________5" }, "type": "array", "title": "Подписант" } }, "type": "object", "required": [ "дата_инф_пок", "врем_инф_пок", "наим_экон_суб_сост", "ид_инф_прод", "сод_фхж4", "подписант" ], "title": "ИнфПокТип" }, "app__schemas__upd_full__buyer_title_5_01_______________": { "properties": { "код_итога": { "type": "string", "enum": [ "1", "2", "3" ], "title": "Код Итога" }, "наим_док_расх": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Док Расх" }, "вид_док_расх": { "type": "string", "enum": [ "2", "3" ], "nullable": true, "title": "Вид Док Расх" }, "ном_док_расх": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Ном Док Расх" }, "дата_док_расх": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Док Расх" }, "ид_файл_док_расх": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Ид Файл Док Расх" } }, "type": "object", "required": [ "код_итога" ], "title": "КодСодОперТип" }, "app__schemas__upd_full__buyer_title_5_01________________1": { "properties": { "наим_орг": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Наим Орг" }, "иннюл": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}", "title": "Иннюл" }, "ид_эдо": { "type": "string", "maxLength": 3, "minLength": 3, "title": "Ид Эдо" } }, "type": "object", "required": [ "наим_орг", "иннюл", "ид_эдо" ], "title": "СвОЭДОтпрТип" }, "app__schemas__upd_full__buyer_title_5_01________________2": { "properties": { "ид_файл_инф_пр": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Ид Файл Инф Пр" }, "дата_файл_инф_пр": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "title": "Дата Файл Инф Пр" }, "врем_файл_инф_пр": { "type": "string", "maxLength": 8, "minLength": 8, "pattern": "([0-1]{1}[0-9]{1}|2[0-3]{1})\\.([0-5]{1}[0-9]{1})\\.([0-5]{1}[0-9]{1})", "title": "Врем Файл Инф Пр" }, "эп": { "items": { "type": "string", "minLength": 1 }, "type": "array", "title": "Эп" } }, "type": "object", "required": [ "ид_файл_инф_пр", "дата_файл_инф_пр", "врем_файл_инф_пр", "эп" ], "title": "ИдИнфПродТип" }, "app__schemas__upd_full__buyer_title_5_01________________3": { "properties": { "должность": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Должность" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "осн_полн": { "type": "string", "maxLength": 120, "minLength": 1, "title": "Осн Полн" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________" } }, "type": "object", "required": [ "должность", "осн_полн", "фио" ], "title": "РабОргПокТип" }, "app__schemas__upd_full__buyer_title_5_01________________4": { "properties": { "раб_орг_пок": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________________3", "nullable": true }, "ин_лицо": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01_____________2", "nullable": true } }, "type": "object", "title": "СвЛицПринТип" }, "app__schemas__upd_full__buyer_title_5_01________________5": { "properties": { "обл_полн": { "type": "string", "enum": [ "1", "2", "3" ], "title": "Обл Полн" }, "статус": { "type": "string", "enum": [ "3", "4", "5", "6" ], "title": "Статус" }, "осн_полн": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Осн Полн" }, "осн_полн_орг": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Осн Полн Орг" }, "фл": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01___________1", "nullable": true }, "ип": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01___________2", "nullable": true }, "юл": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01_______", "nullable": true } }, "type": "object", "required": [ "обл_полн", "статус", "осн_полн" ], "title": "ПодписантТип" }, "app__schemas__upd_full__buyer_title_5_01__________________1": { "properties": { "ид_отпр": { "type": "string", "maxLength": 46, "minLength": 4, "title": "Ид Отпр" }, "ид_пол": { "type": "string", "maxLength": 46, "minLength": 4, "title": "Ид Пол" }, "св_оэд_отпр": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________________1", "nullable": true } }, "type": "object", "required": [ "ид_отпр", "ид_пол" ], "title": "СвУчДокОборТип" }, "app__schemas__upd_full__buyer_title_5_01__________________2": { "properties": { "должность": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Должность" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "наим_орг_прин": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Наим Орг Прин" }, "осн_довер_орг_прин": { "type": "string", "maxLength": 120, "minLength": 1, "nullable": true, "title": "Осн Довер Орг Прин" }, "осн_полн_пред_прин": { "type": "string", "maxLength": 120, "minLength": 1, "nullable": true, "title": "Осн Полн Пред Прин" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________" } }, "type": "object", "required": [ "должность", "наим_орг_прин", "фио" ], "title": "ПредОргПринТип" }, "app__schemas__upd_full__buyer_title_5_01___________________": { "properties": { "ном_стр": { "enum": [ "number", "string" ], "title": "Ном Стр" }, "код_объект_фаип": { "type": "string", "maxLength": 24, "minLength": 1, "nullable": true, "title": "Код Объект Фаип" }, "вид_средств": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6" ], "title": "Вид Средств" }, "код_пок_бюдж_класс": { "type": "string", "maxLength": 20, "minLength": 20, "title": "Код Пок Бюдж Класс" }, "код_цели_покуп": { "type": "string", "maxLength": 20, "minLength": 1, "nullable": true, "title": "Код Цели Покуп" }, "сум_аванс": { "enum": [ "number", "string" ], "title": "Сум Аванс" } }, "type": "object", "required": [ "ном_стр", "вид_средств", "код_пок_бюдж_класс", "сум_аванс" ], "title": "ИнфСведДенОбязТип" }, "app__schemas__upd_full__buyer_title_5_01_____________________": { "properties": { "ид_код_зак": { "type": "string", "maxLength": 36, "minLength": 1, "nullable": true, "title": "Ид Код Зак" }, "лиц_счет_пок": { "type": "string", "maxLength": 11, "minLength": 11, "title": "Лиц Счет Пок" }, "наим_фин_орг_пок": { "type": "string", "maxLength": 2000, "minLength": 1, "title": "Наим Фин Орг Пок" }, "ном_реестр_зап_пок": { "type": "string", "maxLength": 8, "minLength": 8, "title": "Ном Реестр Зап Пок" }, "уч_ном_бюд_обяз_пок": { "type": "string", "maxLength": 19, "minLength": 16, "nullable": true, "title": "Уч Ном Бюд Обяз Пок" }, "код_казнач_пок": { "type": "string", "maxLength": 4, "minLength": 4, "nullable": true, "title": "Код Казнач Пок" }, "наим_казнач_пок": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Наим Казнач Пок" }, "октмо_пок": { "type": "string", "maxLength": 11, "minLength": 8, "pattern": "(?:[0-9]{8})|(?:[0-9]{11})", "title": "Октмо Пок" }, "октмо_мес_пост": { "type": "string", "maxLength": 11, "minLength": 8, "pattern": "(?:[0-9]{8})|(?:[0-9]{11})", "nullable": true, "title": "Октмо Мес Пост" }, "дата_опл_пред": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Опл Пред" }, "уч_ном_ден_обяз": { "type": "string", "maxLength": 22, "minLength": 22, "nullable": true, "title": "Уч Ном Ден Обяз" }, "очер_плат": { "type": "string", "maxLength": 1, "minLength": 1, "nullable": true, "title": "Очер Плат" }, "вид_плат": { "type": "string", "enum": [ "0", "4" ], "nullable": true, "title": "Вид Плат" }, "инф_свед_ден_обяз": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01___________________" }, "type": "array", "title": "Инф Свед Ден Обяз" } }, "type": "object", "required": [ "лиц_счет_пок", "наим_фин_орг_пок", "ном_реестр_зап_пок", "октмо_пок", "инф_свед_ден_обяз" ], "title": "ИнфПокГосЗакКазнТип" }, "app__schemas__upd_full__buyer_title_5_03________4___": { "properties": { "наим_док_опр_пр": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Наим Док Опр Пр" }, "функция": { "$ref": "#/components/schemas/UPDFunctionEnum", "maxLength": 6, "minLength": 1 }, "пор_ном_док_инф_пр": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Пор Ном Док Инф Пр" }, "дата_док_инф_пр": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "title": "Дата Док Инф Пр" }, "вид_опер": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Вид Опер" }, "св_прин": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_03_____________3" }, "инф_пол_фхж4": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_03___________4___", "nullable": true } }, "type": "object", "required": [ "наим_док_опр_пр", "функция", "дата_док_инф_пр", "св_прин" ], "title": "СодФХЖ4Тип" }, "app__schemas__upd_full__buyer_title_5_03___________4___": { "properties": { "ид_файл_инф_пол": { "type": "string", "maxLength": 36, "minLength": 36, "nullable": true, "title": "Ид Файл Инф Пол" }, "текст_инф": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01_____________" }, "type": "array", "title": "Текст Инф", "default": [] } }, "type": "object", "title": "ИнфПолФХЖ4Тип" }, "app__schemas__upd_full__buyer_title_5_03____________": { "properties": { "рекв_наим_док": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Рекв Наим Док" }, "рекв_номер_док": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Рекв Номер Док" }, "рекв_дата_док": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "title": "Рекв Дата Док" }, "рекв_ид_файл_док": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Рекв Ид Файл Док" }, "рекв_ид_док": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Рекв Ид Док" }, "р_ид_сист_хран_д": { "type": "string", "maxLength": 500, "minLength": 1, "nullable": true, "title": "Р Ид Сист Хран Д" }, "рекв_урл_сист_док": { "type": "string", "maxLength": 500, "minLength": 1, "nullable": true, "title": "Рекв Урл Сист Док" }, "рекв_доп_свед_док": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Рекв Доп Свед Док" }, "рекв_ид_рек_сост": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_03________________1" }, "type": "array", "title": "Рекв Ид Рек Сост", "default": [] } }, "type": "object", "required": [ "рекв_наим_док", "рекв_номер_док", "рекв_дата_док" ], "title": "РеквДокТип", "description": "Реквизиты документа
• `рекв_наим_док`: Наименование документа
• `рекв_номер_док`: Номер документа
• `рекв_дата_док`: Дата документа
• `рекв_ид_файл_док`: Идентификатор файла обмена документа, подписанного первой стороной
• `рекв_ид_док`: Идентификатор документа
• `р_ид_сист_хран_д`: Идентифицирующая информация об информационной системе, в которой осуществляется хранение документа, необходимая для запроса информации из информационной системы
• `рекв_урл_сист_док`: Сведения в формате URL об информационной системе, которая предоставляет техническую возможность получения информации о документе
• `рекв_доп_свед_док`: Дополнительные сведения
• `рекв_ид_рек_сост`: Идентифицирующие реквизиты экономических субъектов, составивших (сформировавших) документ" }, "app__schemas__upd_full__buyer_title_5_03_____________1": { "properties": { "иннфл_прин": { "type": "string", "maxLength": 12, "minLength": 12, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}", "nullable": true, "title": "Иннфл Прин" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "осн_довер_фл": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_03____________", "nullable": true }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________" } }, "type": "object", "required": [ "фио" ], "title": "ФЛПринТип" }, "app__schemas__upd_full__buyer_title_5_03_____________2": { "properties": { "пред_орг_прин": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_03________________", "nullable": true }, "фл_прин": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_03_____________1", "nullable": true } }, "type": "object", "title": "ИнЛицоТип" }, "app__schemas__upd_full__buyer_title_5_03_____________3": { "properties": { "сод_опер": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Сод Опер" }, "дата_прин": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "title": "Дата Прин" }, "код_сод_опер": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_03_________________1" }, "св_лиц_прин": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_03________________4", "nullable": true } }, "type": "object", "required": [ "дата_прин", "код_сод_опер" ], "title": "СвПринТип" }, "app__schemas__upd_full__buyer_title_5_03_______________1": { "properties": { "ид_стат": { "type": "string", "enum": [ "ИО", "ИГ" ], "title": "Ид Стат" }, "код_стр": { "type": "string", "maxLength": 3, "minLength": 3, "pattern": "[0-9]{3}", "title": "Код Стр" }, "наим_стран": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Наим Стран" }, "наим": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Наим" }, "идентиф": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Идентиф" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" } }, "type": "object", "required": [ "ид_стат", "код_стр", "наим_стран", "наим" ], "title": "СвИнНеУчТип", "description": "Сведения об иностранной организации (иностранном гражданине), не состоящей на учете в налоговых органах
• `ид_стат`: Идентификация статуса
• `код_стр`: Код страны
• `наим_стран`: Наименование страны
• `наим`: Наименование иностранной организации полное/Фамилия, имя, отчество (при наличии) иностранного гражданина
• `идентиф`: Идентификатор иностранной организации (иностранного гражданина)
• `иные_свед`: Иные сведения для однозначной идентификации иностранной организации (иностранного гражданина)" }, "app__schemas__upd_full__buyer_title_5_03_______________3": { "properties": { "кнд": { "type": "string", "const": "1115132", "title": "Кнд", "default": "1115132" }, "уид": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Уид" }, "дата_инф_пок": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "title": "Дата Инф Пок" }, "врем_инф_пок": { "type": "string", "maxLength": 8, "minLength": 8, "pattern": "([0-1]{1}[0-9]{1}|2[0-3]{1})\\.([0-5]{1}[0-9]{1})\\.([0-5]{1}[0-9]{1})", "title": "Врем Инф Пок" }, "наим_экон_суб_сост": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Наим Экон Суб Сост" }, "ид_инф_прод": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________________2" }, "сод_фхж4": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_03________4___" }, "инф_пок_за_госк_казн": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_03_____________________", "nullable": true }, "подписант": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_03________________6" }, "type": "array", "title": "Подписант" }, "осн_довер_орг_сост": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_03____________", "nullable": true } }, "type": "object", "required": [ "дата_инф_пок", "врем_инф_пок", "ид_инф_прод", "сод_фхж4", "подписант" ], "title": "ДокументТип" }, "app__schemas__upd_full__buyer_title_5_03________________": { "properties": { "должность": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Должность" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "наим_орг_прин": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Наим Орг Прин" }, "инн_орг_прин": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}", "nullable": true, "title": "Инн Орг Прин" }, "осн_довер_орг_прин": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_03____________", "nullable": true }, "осн_полн_пред_прин": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_03____________", "nullable": true }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________" } }, "type": "object", "required": [ "должность", "наим_орг_прин", "фио" ], "title": "ПредОргПринТип" }, "app__schemas__upd_full__buyer_title_5_03________________1": { "properties": { "иннюл": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}", "nullable": true, "title": "Иннюл" }, "иннфл": { "type": "string", "maxLength": 12, "minLength": 12, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}", "nullable": true, "title": "Иннфл" }, "данн_ино": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_03_______________1", "nullable": true }, "наим_оив": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Оив" } }, "type": "object", "title": "ИдРекСостТип", "description": "Идентифицирующие реквизиты экономических субъектов, составивших (сформировавших) документ
• `иннюл`: ИНН организации, состоящей на учете в налоговом органе
• `иннфл`: ИНН физического лица, в том числе индивидуального предпринимателя
• `данн_ино`: Данные об иностранной организации (иностранном гражданине), не состоящей на учете в налоговых органах
• `наим_оив`: Краткое наименование органа исполнительной власти (специализированной уполномоченной организации), выдавшего документ" }, "app__schemas__upd_full__buyer_title_5_03________________3": { "properties": { "должность": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Должность" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________" } }, "type": "object", "required": [ "должность", "фио" ], "title": "РабОргПокТип" }, "app__schemas__upd_full__buyer_title_5_03________________4": { "properties": { "раб_орг_пок": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_03________________3", "nullable": true }, "ин_лицо": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_03_____________2", "nullable": true } }, "type": "object", "title": "СвЛицПринТип" }, "app__schemas__upd_full__buyer_title_5_03________________5": { "properties": { "ном_довер": { "type": "string", "maxLength": 36, "minLength": 36, "title": "Ном Довер" }, "дата_выд_довер": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "title": "Дата Выд Довер" }, "вн_ном_довер": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Вн Ном Довер" }, "дата_вн_рег_довер": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Вн Рег Довер" }, "ид_сист_хран": { "type": "string", "maxLength": 500, "minLength": 1, "title": "Ид Сист Хран" }, "урл_сист": { "type": "string", "nullable": true, "title": "Урл Сист" } }, "type": "object", "required": [ "ном_довер", "дата_выд_довер", "ид_сист_хран" ], "title": "СвДоверЭлТип" }, "app__schemas__upd_full__buyer_title_5_03________________6": { "properties": { "должн": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Должн" }, "тип_подпис": { "type": "string", "enum": [ "1", "2", "3" ], "nullable": true, "title": "Тип Подпис" }, "дата_под_док": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Под Док" }, "спос_подт_полном": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6" ], "title": "Спос Подт Полном" }, "доп_свед_подп": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Доп Свед Подп" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________" }, "св_довер_эл": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_03________________5" }, "type": "array", "title": "Св Довер Эл", "default": [] }, "св_довер_бум": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_03_________________2" }, "type": "array", "title": "Св Довер Бум", "default": [] } }, "type": "object", "required": [ "спос_подт_полном", "фио" ], "title": "ПодписантТип" }, "app__schemas__upd_full__buyer_title_5_03_________________1": { "properties": { "код_итога": { "type": "string", "enum": [ "1", "2", "3" ], "title": "Код Итога" }, "рекв_док_расх": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_03____________", "nullable": true } }, "type": "object", "required": [ "код_итога" ], "title": "КодСодОперТип" }, "app__schemas__upd_full__buyer_title_5_03_________________2": { "properties": { "дата_выд_довер": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "title": "Дата Выд Довер" }, "вн_ном_довер": { "type": "string", "maxLength": 50, "minLength": 1, "title": "Вн Ном Довер" }, "св_ид_довер": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Св Ид Довер" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________", "nullable": true } }, "type": "object", "required": [ "дата_выд_довер", "вн_ном_довер" ], "title": "СвДоверБумТип" }, "app__schemas__upd_full__buyer_title_5_03___________________": { "properties": { "ном_стр": { "enum": [ "number", "string" ], "title": "Ном Стр" }, "код_объект_фаип": { "type": "string", "maxLength": 24, "minLength": 1, "nullable": true, "title": "Код Объект Фаип" }, "вид_средств": { "type": "string", "enum": [ "1", "3", "4", "5", "6" ], "title": "Вид Средств" }, "код_пок_бюдж_класс": { "type": "string", "maxLength": 20, "minLength": 20, "title": "Код Пок Бюдж Класс" }, "код_цели_покуп": { "type": "string", "maxLength": 20, "minLength": 1, "nullable": true, "title": "Код Цели Покуп" }, "сум_аванс": { "enum": [ "number", "string" ], "title": "Сум Аванс" } }, "type": "object", "required": [ "ном_стр", "вид_средств", "код_пок_бюдж_класс", "сум_аванс" ], "title": "ИнфСведДенОбязТип" }, "app__schemas__upd_full__buyer_title_5_03_____________________": { "properties": { "ид_код_зак": { "type": "string", "maxLength": 36, "minLength": 1, "nullable": true, "title": "Ид Код Зак" }, "лиц_счет_пок": { "type": "string", "maxLength": 11, "minLength": 11, "title": "Лиц Счет Пок" }, "наим_фин_орг_пок": { "type": "string", "maxLength": 2000, "minLength": 1, "title": "Наим Фин Орг Пок" }, "ном_реестр_зап_пок": { "type": "string", "maxLength": 8, "minLength": 8, "title": "Ном Реестр Зап Пок" }, "уч_ном_бюд_обяз_пок": { "type": "string", "maxLength": 19, "minLength": 16, "nullable": true, "title": "Уч Ном Бюд Обяз Пок" }, "код_казнач_пок": { "type": "string", "maxLength": 4, "minLength": 4, "nullable": true, "title": "Код Казнач Пок" }, "наим_казнач_пок": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Наим Казнач Пок" }, "октмо_пок": { "type": "string", "maxLength": 11, "minLength": 8, "pattern": "(?:[0-9]{8})|(?:[0-9]{11})", "title": "Октмо Пок" }, "октмо_мес_пост": { "type": "string", "maxLength": 11, "minLength": 8, "pattern": "(?:[0-9]{8})|(?:[0-9]{11})", "nullable": true, "title": "Октмо Мес Пост" }, "дата_опл_пред": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Опл Пред" }, "уч_ном_ден_обяз": { "type": "string", "maxLength": 22, "minLength": 22, "nullable": true, "title": "Уч Ном Ден Обяз" }, "очер_плат": { "type": "string", "maxLength": 1, "minLength": 1, "nullable": true, "title": "Очер Плат" }, "вид_плат": { "type": "string", "enum": [ "0", "4" ], "nullable": true, "title": "Вид Плат" }, "инф_свед_ден_обяз": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_03___________________" }, "type": "array", "title": "Инф Свед Ден Обяз" } }, "type": "object", "required": [ "лиц_счет_пок", "наим_фин_орг_пок", "ном_реестр_зап_пок", "октмо_пок", "инф_свед_ден_обяз" ], "title": "ИнфПокЗаГоскКазнТип" }, "app__schemas__upd_full__seller_title_5_01_______": { "properties": { "гос_рег_ип_выд_дов": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Гос Рег Ип Выд Дов" }, "иннюл": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}", "title": "Иннюл" }, "наим_орг": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Наим Орг" }, "должн": { "type": "string", "maxLength": 128, "minLength": 0, "title": "Должн" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________" } }, "type": "object", "required": [ "иннюл", "должн", "фио" ], "title": "ЮЛТип" }, "app__schemas__upd_full__seller_title_5_01__________1___": { "properties": { "ид_гос_кон": { "type": "string", "maxLength": 25, "minLength": 20, "nullable": true, "title": "Ид Гос Кон" }, "наим_окв": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Наим Окв" }, "курс_вал": { "enum": [ "number", "string" ], "decimal_places": 4, "max_digits": 10, "nullable": true, "title": "Курс Вал" }, "обст_форм_счф": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6", "7", "8" ], "nullable": true, "title": "Обст Форм Счф" }, "инф_прод_гос_зак_казн": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01______________________", "nullable": true }, "св_фактор": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_______________2", "nullable": true }, "осн_уст_ден_треб": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01________________1", "nullable": true } }, "type": "object", "title": "ДопСвФХЖ1Тип" }, "app__schemas__upd_full__seller_title_5_01___________1": { "properties": { "св_ип": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01___________2", "nullable": true }, "св_юл_уч": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_____________1", "nullable": true }, "св_ин_не_уч": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_______________3", "nullable": true }, "св_фл_участ_фхж": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01___________3", "nullable": true } }, "type": "object", "title": "ИдСвТип" }, "app__schemas__upd_full__seller_title_5_01___________1___": { "properties": { "ид_файл_инф_пол": { "type": "string", "maxLength": 36, "minLength": 36, "nullable": true, "title": "Ид Файл Инф Пол" }, "текст_инф": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_______________4" }, "type": "array", "title": "Текст Инф", "default": [] } }, "type": "object", "title": "ИнфПолФХЖ1Тип" }, "app__schemas__upd_full__seller_title_5_01___________2": { "properties": { "иннфл": { "type": "string", "maxLength": 12, "minLength": 12, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}", "nullable": true, "title": "Иннфл" }, "деф_иннфл": { "type": "string", "const": "-", "nullable": true, "title": "Деф Иннфл" }, "св_гос_рег_ип": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Св Гос Рег Ип" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________" } }, "type": "object", "required": [ "фио" ], "title": "СвИПТип", "description": "Сведения об индивидуальном предпринимателе
• `иннфл`: ИНН
• `деф_иннфл`: ИНН при составлении документа с Функция=СЧФ или Функция=СЧФДОП налоговым агентом, указанным в пунктах 2 и 3 статьи 161 НК РФ, в части информации о продавце/грузоотправителе
• `св_гос_рег_ип`: Реквизиты свидетельства о государственной регистрации индивидуального предпринимателя
• `иные_свед`: Иные сведения, идентифицирующие физическое лицо
• `фио`: Фамилия, имя, отчество" }, "app__schemas__upd_full__seller_title_5_01___________3": { "properties": { "гос_рег_ип_выд_дов": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Гос Рег Ип Выд Дов" }, "иннфл": { "type": "string", "maxLength": 12, "minLength": 12, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}", "nullable": true, "title": "Иннфл" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________" } }, "type": "object", "required": [ "фио" ], "title": "СвФЛТип", "description": "Сведения о физическом лице
• `гос_рег_ип_выд_дов`: Реквизиты свидетельства о государственной регистрации индивидуального предпринимателя, выдавшего доверенность физическому лицу на подписание счета-фактуры
• `иннфл`: ИНН физического лица
• `иные_свед`: Иные сведения, идентифицирующие физическое лицо
• `фио`: Фамилия, имя, отчество" }, "app__schemas__upd_full__seller_title_5_01___________3___": { "properties": { "ид_файл_инф_пол": { "type": "string", "maxLength": 36, "minLength": 36, "nullable": true, "title": "Ид Файл Инф Пол" }, "текст_инф": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_______________4" }, "type": "array", "title": "Текст Инф", "default": [] } }, "type": "object", "title": "ИнфПолФХЖ3Тип" }, "app__schemas__upd_full__seller_title_5_01___________4": { "properties": { "код_происх": { "type": "string", "maxLength": 3, "minLength": 3, "pattern": "[0-9]{3}", "nullable": true, "title": "Код Происх" }, "деф_код_происх": { "type": "string", "const": "-", "nullable": true, "title": "Деф Код Происх" }, "номер_тд": { "type": "string", "maxLength": 29, "minLength": 1, "nullable": true, "title": "Номер Тд" } }, "type": "object", "title": "СвТДТип" }, "app__schemas__upd_full__seller_title_5_01____________1": { "properties": { "адр_рф": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01____________2", "nullable": true }, "адр_инф": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_____________2", "nullable": true }, "код_гар": { "type": "string", "maxLength": 36, "minLength": 1, "nullable": true, "title": "Код Гар" } }, "type": "object", "title": "АдресТип", "description": "Сведения об адресе
• `адр_рф`: Адрес, указанный в Едином государственном реестре юридических лиц/почтовый адрес/адрес места жительства индивидуального предпринимателя (реквизиты адреса на территории Российской Федерации)
• `адр_инф`: Адрес, указанный в Едином государственном реестре юридических лиц/почтовый адрес/адрес места жительства индивидуального предпринимателя (информация об адресе, в том числе об адресе за пределами территории Российской Федерации)
• `код_гар`: Уникальный номер адреса объекта адресации в государственном адресном реестре" }, "app__schemas__upd_full__seller_title_5_01____________2": { "properties": { "индекс": { "type": "string", "maxLength": 6, "minLength": 6, "pattern": "[0-9]{6}", "nullable": true, "title": "Индекс" }, "код_регион": { "type": "string", "maxLength": 2, "minLength": 2, "pattern": "[0-9]{2}", "title": "Код Регион" }, "район": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Район" }, "город": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Город" }, "насел_пункт": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Насел Пункт" }, "улица": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Улица" }, "дом": { "type": "string", "maxLength": 20, "minLength": 1, "nullable": true, "title": "Дом" }, "корпус": { "type": "string", "maxLength": 20, "minLength": 1, "nullable": true, "title": "Корпус" }, "кварт": { "type": "string", "maxLength": 20, "minLength": 1, "nullable": true, "title": "Кварт" } }, "type": "object", "required": [ "код_регион" ], "title": "АдрРФТип", "description": "Адрес в Российской Федерации
• `индекс`: Индекс
• `код_регион`: Код региона
• `район`: Район
• `город`: Город
• `насел_пункт`: Населенный пункт
• `улица`: Улица
• `дом`: Дом
• `корпус`: Корпус
• `кварт`: Квартира" }, "app__schemas__upd_full__seller_title_5_01____________3": { "properties": { "номер_прд": { "type": "string", "maxLength": 30, "minLength": 1, "title": "Номер Прд" }, "дата_прд": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "title": "Дата Прд" }, "сумма_прд": { "enum": [ "number", "string" ], "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Сумма Прд" } }, "type": "object", "required": [ "номер_прд", "дата_прд" ], "title": "СвПРДТип" }, "app__schemas__upd_full__seller_title_5_01____________4": { "properties": { "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "осн_довер_фл": { "type": "string", "maxLength": 120, "minLength": 1, "nullable": true, "title": "Осн Довер Фл" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________" } }, "type": "object", "required": [ "фио" ], "title": "ФЛПерТип" }, "app__schemas__upd_full__seller_title_5_01____________5": { "properties": { "сод_опер": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Сод Опер" }, "вид_опер": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Вид Опер" }, "дата_пер": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Пер" }, "дата_нач": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Нач" }, "дата_окон": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Окон" }, "осн_пер": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01________________1" }, "type": "array", "title": "Осн Пер" }, "св_лиц_пер": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_______________8", "nullable": true }, "тран_груз": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_______________10", "nullable": true }, "св_пер_вещи": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01________________3", "nullable": true } }, "type": "object", "required": [ "сод_опер", "осн_пер" ], "title": "СвПерТип" }, "app__schemas__upd_full__seller_title_5_01_____________1": { "properties": { "наим_орг": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Наим Орг" }, "иннюл": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}", "nullable": true, "title": "Иннюл" }, "деф_иннюл": { "type": "string", "const": "-", "nullable": true, "title": "Деф Иннюл" }, "кпп": { "type": "string", "maxLength": 9, "minLength": 9, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})([0-9]{2})([0-9A-Z]{2})([0-9]{3})", "nullable": true, "title": "Кпп" } }, "type": "object", "required": [ "наим_орг" ], "title": "СвЮЛУчТип" }, "app__schemas__upd_full__seller_title_5_01_____________2": { "properties": { "код_стр": { "type": "string", "maxLength": 3, "minLength": 3, "pattern": "[0-9]{3}", "title": "Код Стр" }, "адр_текст": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Адр Текст" } }, "type": "object", "required": [ "код_стр", "адр_текст" ], "title": "АдрИнфТип", "description": "Информация об адресе, в том числе об адресе за пределами территории Российской Федерации
• `код_стр`: Код страны
• `адр_текст`: Адрес" }, "app__schemas__upd_full__seller_title_5_01_____________3": { "properties": { "наим_банк": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Наим Банк" }, "бик": { "type": "string", "maxLength": 9, "minLength": 9, "pattern": "[0-9]{9}", "nullable": true, "title": "Бик" }, "кор_счет": { "type": "string", "maxLength": 20, "minLength": 1, "nullable": true, "title": "Кор Счет" } }, "type": "object", "title": "СвБанкТип" }, "app__schemas__upd_full__seller_title_5_01_____________4": { "properties": { "сум_нал": { "enum": [ "number", "string" ], "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Сум Нал" }, "без_ндс": { "type": "string", "const": "без НДС", "nullable": true, "title": "Без Ндс" }, "деф_ндс": { "type": "string", "const": "-", "nullable": true, "title": "Деф Ндс" } }, "type": "object", "title": "СумНДСТип", "description": "Сумма НДС
• `сум_нал`: Значение
• `без_ндс`: Без НДС
• `деф_ндс`: Знак прочерка" }, "app__schemas__upd_full__seller_title_5_01_____________5": { "properties": { "груз_отпр": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_______________2", "nullable": true }, "он_же": { "type": "string", "const": "он же", "nullable": true, "title": "Он Же" } }, "type": "object", "title": "ГрузОтТип" }, "app__schemas__upd_full__seller_title_5_01_____________6": { "properties": { "пред_орг_пер": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_________________4", "nullable": true }, "фл_пер": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01____________4", "nullable": true } }, "type": "object", "title": "ИнЛицоТип" }, "app__schemas__upd_full__seller_title_5_01______________1": { "properties": { "тлф": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Тлф" }, "эл_почта": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Эл Почта" } }, "type": "object", "title": "КонтактТип", "description": "Контактные данные
• `тлф`: Номер контактного телефона/факс
• `эл_почта`: Адрес электронной почты" }, "app__schemas__upd_full__seller_title_5_01______________2": { "properties": { "ном_испр_сч_ф": { "enum": [ "number", "string" ], "decimal_places": 0, "max_digits": 3, "nullable": true, "title": "Ном Испр Сч Ф" }, "деф_ном_испр_сч_ф": { "type": "string", "const": "-", "nullable": true, "title": "Деф Ном Испр Сч Ф" }, "дата_испр_сч_ф": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Испр Сч Ф" }, "деф_дата_испр_сч_ф": { "type": "string", "const": "-", "nullable": true, "title": "Деф Дата Испр Сч Ф" } }, "type": "object", "title": "ИспрСчФТип" }, "app__schemas__upd_full__seller_title_5_01______________3": { "properties": { "ном_стр": { "enum": [ "number", "string" ], "title": "Ном Стр" }, "наим_тов": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Наим Тов" }, "океи__тов": { "type": "string", "maxLength": 4, "minLength": 3, "pattern": "(?:[0-9]{3})|(?:[0-9]{4})", "nullable": true, "title": "Океи Тов" }, "деф_океи__тов": { "type": "string", "const": "-", "nullable": true, "title": "Деф Океи Тов" }, "кол_тов": { "enum": [ "number", "string" ], "decimal_places": 11, "max_digits": 26, "nullable": true, "title": "Кол Тов" }, "цена_тов": { "enum": [ "number", "string" ], "decimal_places": 11, "max_digits": 26, "nullable": true, "title": "Цена Тов" }, "ст_тов_без_ндс": { "enum": [ "number", "string" ], "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Ст Тов Без Ндс" }, "нал_ст": { "type": "string", "enum": [ "0%", "5%", "7%", "9,09%", "10%", "16,67%", "18,03%", "20%", "22%", "5/105", "7/107", "10/110", "20/120", "22/122", "без НДС", "НДС исчисляется налоговым агентом" ], "title": "Нал Ст" }, "ст_тов_уч_нал": { "enum": [ "number", "string" ], "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Ст Тов Уч Нал" }, "деф_ст_тов_уч_нал": { "type": "string", "const": "-", "nullable": true, "title": "Деф Ст Тов Уч Нал" }, "акциз": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_______________6" }, "сум_нал": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_____________4" }, "св_тд": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01___________4" }, "type": "array", "title": "Св Тд", "default": [] }, "доп_свед_тов": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_________________1", "nullable": true }, "инф_пол_фхж2": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_______________4" }, "type": "array", "title": "Инф Пол Фхж2", "default": [] } }, "type": "object", "required": [ "ном_стр", "нал_ст", "акциз", "сум_нал" ], "title": "СведТовТип" }, "app__schemas__upd_full__seller_title_5_01_______________1": { "properties": { "номер_счета": { "type": "string", "maxLength": 20, "minLength": 1, "nullable": true, "title": "Номер Счета" }, "св_банк": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_____________3", "nullable": true } }, "type": "object", "title": "БанкРеквТип" }, "app__schemas__upd_full__seller_title_5_01_______________10": { "properties": { "св_тран_груз": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Св Тран Груз" }, "тран_накл": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_______________9" }, "type": "array", "title": "Тран Накл", "default": [] }, "перевозчик": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_______________2", "nullable": true } }, "type": "object", "title": "ТранГрузТип" }, "app__schemas__upd_full__seller_title_5_01_______________11": { "properties": { "кнд": { "type": "string", "const": "1115131", "title": "Кнд", "default": "1115131" }, "функция": { "$ref": "#/components/schemas/UPDFunctionEnum" }, "по_факт_хж": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "По Факт Хж" }, "наим_док_опр": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Док Опр" }, "дата_инф_пр": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "title": "Дата Инф Пр" }, "врем_инф_пр": { "type": "string", "maxLength": 8, "minLength": 8, "pattern": "([0-1]{1}[0-9]{1}|2[0-3]{1})\\.([0-5]{1}[0-9]{1})\\.([0-5]{1}[0-9]{1})", "title": "Врем Инф Пр" }, "наим_экон_суб_сост": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Наим Экон Суб Сост" }, "осн_довер_орг_сост": { "type": "string", "maxLength": 120, "minLength": 1, "nullable": true, "title": "Осн Довер Орг Сост" }, "согл_стр_доп_инф": { "type": "string", "maxLength": 14, "minLength": 14, "nullable": true, "title": "Согл Стр Доп Инф" }, "св_сч_факт": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_______________5" }, "табл_сч_факт": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_________________2", "nullable": true }, "св_прод_пер": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01________________4", "nullable": true }, "подписант": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01________________5" }, "type": "array", "title": "Подписант" } }, "type": "object", "required": [ "функция", "дата_инф_пр", "врем_инф_пр", "наим_экон_суб_сост", "св_сч_факт", "подписант" ], "title": "ДокументТип" }, "app__schemas__upd_full__seller_title_5_01_______________2": { "properties": { "окпо": { "type": "string", "maxLength": 10, "minLength": 1, "nullable": true, "title": "Окпо" }, "структ_подр": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Структ Подр" }, "инф_для_участ": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Инф Для Участ" }, "кратк_назв": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Кратк Назв" }, "ид_св": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01___________1" }, "адрес": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01____________1", "nullable": true }, "контакт": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01______________1", "nullable": true }, "банк_рекв": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_______________1", "nullable": true } }, "type": "object", "required": [ "ид_св" ], "title": "УчастникТип", "description": "Сведения об участнике факта хозяйственной жизни
• `окпо`: Код в общероссийском классификаторе предприятий и организаций
• `структ_подр`: Структурное подразделение
• `инф_для_участ`: Информация для участника документооборота
• `кратк_назв`: Краткое название
• `ид_св`: Идентификационные сведения
• `адрес`: Адрес
• `контакт`: Контактные данные
• `банк_рекв`: Банковские реквизиты" }, "app__schemas__upd_full__seller_title_5_01_______________3": { "properties": { "наим_орг": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Наим Орг" }, "идентиф": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Идентиф" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" } }, "type": "object", "required": [ "наим_орг" ], "title": "СвИнНеУчТип" }, "app__schemas__upd_full__seller_title_5_01_______________4": { "properties": { "идентиф": { "type": "string", "maxLength": 50, "minLength": 1, "title": "Идентиф" }, "значен": { "type": "string", "maxLength": 2000, "minLength": 1, "title": "Значен" } }, "type": "object", "required": [ "идентиф", "значен" ], "title": "ТекстИнфТип", "description": "Текстовая информация
• `идентиф`: Идентификатор
• `значен`: Значение" }, "app__schemas__upd_full__seller_title_5_01_______________5": { "properties": { "номер_сч_ф": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Номер Сч Ф" }, "дата_сч_ф": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "title": "Дата Сч Ф" }, "код_окв": { "type": "string", "maxLength": 3, "minLength": 3, "pattern": "[0-9]{3}", "title": "Код Окв" }, "испр_сч_ф": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01______________2", "nullable": true }, "св_прод": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_______________2" }, "type": "array", "title": "Св Прод" }, "груз_от": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_____________5" }, "type": "array", "title": "Груз От", "default": [] }, "груз_получ": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_______________2" }, "type": "array", "title": "Груз Получ", "default": [] }, "св_прд": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01____________3" }, "type": "array", "title": "Св Прд", "default": [] }, "св_покуп": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_______________2" }, "type": "array", "title": "Св Покуп" }, "доп_св_фхж1": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01__________1___", "nullable": true }, "док_подтв_отгр": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_________________" }, "type": "array", "title": "Док Подтв Отгр", "default": [] }, "инф_пол_фхж1": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01___________1___", "nullable": true } }, "type": "object", "required": [ "номер_сч_ф", "дата_сч_ф", "код_окв", "св_прод", "св_покуп" ], "title": "СвСчФактТип" }, "app__schemas__upd_full__seller_title_5_01_______________6": { "properties": { "сум_акциз": { "enum": [ "number", "string" ], "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Сум Акциз" }, "без_акциз": { "type": "string", "const": "без акциза", "nullable": true, "title": "Без Акциз" } }, "type": "object", "title": "СумАкцизТип", "description": "Сумма акциза:
• `сум_акциз`: Сумма акциза
• `без_акциз`: Без акциза" }, "app__schemas__upd_full__seller_title_5_01_______________7": { "properties": { "ст_тов_без_ндс_всего": { "enum": [ "number", "string" ], "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Ст Тов Без Ндс Всего" }, "ст_тов_уч_нал_всего": { "enum": [ "number", "string" ], "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Ст Тов Уч Нал Всего" }, "деф_ст_тов_уч_нал_всего": { "type": "string", "const": "-", "nullable": true, "title": "Деф Ст Тов Уч Нал Всего" }, "сум_нал_всего": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_____________4" }, "кол_нетто_вс": { "enum": [ "number", "string" ], "decimal_places": 11, "max_digits": 26, "nullable": true, "title": "Кол Нетто Вс" } }, "type": "object", "required": [ "сум_нал_всего" ], "title": "ВсегоОплТип" }, "app__schemas__upd_full__seller_title_5_01_______________8": { "properties": { "раб_орг_прод": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_________________3", "nullable": true }, "ин_лицо": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_____________6", "nullable": true } }, "type": "object", "title": "СвЛицПерТип" }, "app__schemas__upd_full__seller_title_5_01_______________9": { "properties": { "ном_тран_накл": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Ном Тран Накл" }, "дата_тран_накл": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "title": "Дата Тран Накл" } }, "type": "object", "required": [ "ном_тран_накл", "дата_тран_накл" ], "title": "ТранНаклТип" }, "app__schemas__upd_full__seller_title_5_01________________1": { "properties": { "наим_осн": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Наим Осн" }, "ном_осн": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Ном Осн" }, "дата_осн": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Осн" }, "доп_св_осн": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Доп Св Осн" }, "идент_осн": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Идент Осн" } }, "type": "object", "required": [ "наим_осн" ], "title": "ОснованиеТип", "description": "Основание отгрузки (передачи, уступки)
• `наим_осн`: Наименование документа - основания
• `ном_осн`: Номер документа - основания
• `дата_осн`: Дата документа - основания
• `доп_св_осн`: Дополнительные сведения
• `идент_осн`: Идентификатор документа - основания" }, "app__schemas__upd_full__seller_title_5_01________________3": { "properties": { "дата_пер_вещ": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Пер Вещ" }, "св_пер_вещ": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Св Пер Вещ" } }, "type": "object", "title": "СвПерВещиТип" }, "app__schemas__upd_full__seller_title_5_01________________4": { "properties": { "св_пер": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01____________5" }, "инф_пол_фхж3": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01___________3___", "nullable": true } }, "type": "object", "required": [ "св_пер" ], "title": "СвПродПерТип" }, "app__schemas__upd_full__seller_title_5_01________________5": { "properties": { "обл_полн": { "type": "string", "enum": [ "0", "1", "2", "3", "4", "5", "6" ], "title": "Обл Полн" }, "статус": { "type": "string", "enum": [ "1", "2", "3", "4" ], "title": "Статус" }, "осн_полн": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Осн Полн" }, "осн_полн_орг": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Осн Полн Орг" }, "фл": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01___________3", "nullable": true }, "ип": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01___________2", "nullable": true }, "юл": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_______", "nullable": true } }, "type": "object", "required": [ "обл_полн", "статус", "осн_полн" ], "title": "ПодписантТип" }, "app__schemas__upd_full__seller_title_5_01_________________": { "properties": { "наим_док_отгр": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Наим Док Отгр" }, "ном_док_отгр": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Ном Док Отгр" }, "дата_док_отгр": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Док Отгр" } }, "type": "object", "required": [ "наим_док_отгр", "ном_док_отгр" ], "title": "ДокПодтвОтгрТип" }, "app__schemas__upd_full__seller_title_5_01_________________1": { "properties": { "пр_тов_раб": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "nullable": true, "title": "Пр Тов Раб" }, "доп_призн": { "type": "string", "maxLength": 4, "minLength": 1, "nullable": true, "title": "Доп Призн" }, "наим_ед_изм": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Ед Изм" }, "кр_наим_стр_пр": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Кр Наим Стр Пр" }, "надл_отп": { "enum": [ "number", "string" ], "decimal_places": 11, "max_digits": 26, "nullable": true, "title": "Надл Отп" }, "характер_тов": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Характер Тов" }, "сорт_тов": { "type": "string", "maxLength": 10, "minLength": 1, "nullable": true, "title": "Сорт Тов" }, "артикул_тов": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Артикул Тов" }, "код_тов": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Код Тов" }, "код_кат": { "type": "string", "maxLength": 27, "minLength": 27, "nullable": true, "title": "Код Кат" }, "код_вид_тов": { "type": "string", "maxLength": 10, "minLength": 10, "nullable": true, "title": "Код Вид Тов" }, "свед_прослеж": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01__________________2" }, "type": "array", "title": "Свед Прослеж", "default": [] }, "ном_сред_идент_тов": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01____________________" }, "type": "array", "title": "Ном Сред Идент Тов", "default": [] } }, "type": "object", "title": "ДопСведТовТип" }, "app__schemas__upd_full__seller_title_5_01_________________2": { "properties": { "свед_тов": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01______________3" }, "type": "array", "title": "Свед Тов" }, "всего_опл": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_______________7" } }, "type": "object", "required": [ "свед_тов", "всего_опл" ], "title": "ТаблСчФактТип" }, "app__schemas__upd_full__seller_title_5_01_________________3": { "properties": { "должность": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Должность" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "осн_полн": { "type": "string", "maxLength": 120, "minLength": 1, "nullable": true, "title": "Осн Полн" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________" } }, "type": "object", "required": [ "должность", "фио" ], "title": "РабОргПродТип" }, "app__schemas__upd_full__seller_title_5_01_________________4": { "properties": { "должность": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Должность" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "наим_орг_пер": { "type": "string", "maxLength": 128, "minLength": 1, "title": "Наим Орг Пер" }, "осн_довер_орг_пер": { "type": "string", "maxLength": 120, "minLength": 1, "nullable": true, "title": "Осн Довер Орг Пер" }, "осн_полн_пред_пер": { "type": "string", "maxLength": 120, "minLength": 1, "nullable": true, "title": "Осн Полн Пред Пер" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________" } }, "type": "object", "required": [ "должность", "наим_орг_пер", "фио" ], "title": "ПредОргПерТип" }, "app__schemas__upd_full__seller_title_5_01__________________2": { "properties": { "ном_тов_прослеж": { "type": "string", "maxLength": 29, "minLength": 1, "title": "Ном Тов Прослеж" }, "ед_изм_прослеж": { "type": "string", "maxLength": 4, "minLength": 3, "pattern": "(?:[0-9]{3})|(?:[0-9]{4})", "title": "Ед Изм Прослеж" }, "наим_ед_изм_прослеж": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Наим Ед Изм Прослеж" }, "кол_в_ед_прослеж": { "enum": [ "number", "string" ], "title": "Кол В Ед Прослеж" }, "доп_прослеж": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Доп Прослеж" } }, "type": "object", "required": [ "ном_тов_прослеж", "ед_изм_прослеж", "наим_ед_изм_прослеж", "кол_в_ед_прослеж" ], "title": "СведПрослежТип" }, "app__schemas__upd_full__seller_title_5_01____________________": { "properties": { "идент_транс_упак": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Идент Транс Упак" }, "киз": { "items": { "type": "string", "maxLength": 255, "minLength": 1 }, "type": "array", "title": "Киз", "default": [] }, "ном_упак": { "items": { "type": "string", "maxLength": 255, "minLength": 1 }, "type": "array", "title": "Ном Упак", "default": [] } }, "type": "object", "title": "НомСредИдентТовТип" }, "app__schemas__upd_full__seller_title_5_01______________________": { "properties": { "дата_гос_конт": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "title": "Дата Гос Конт" }, "номер_гос_конт": { "type": "string", "maxLength": 100, "minLength": 1, "title": "Номер Гос Конт" }, "лиц_счет_прод": { "type": "string", "maxLength": 11, "minLength": 11, "nullable": true, "title": "Лиц Счет Прод" }, "код_прод_бюдж_класс": { "type": "string", "maxLength": 20, "minLength": 20, "nullable": true, "title": "Код Прод Бюдж Класс" }, "код_цели_прод": { "type": "string", "maxLength": 20, "minLength": 20, "nullable": true, "title": "Код Цели Прод" }, "код_казнач_прод": { "type": "string", "maxLength": 4, "minLength": 1, "nullable": true, "title": "Код Казнач Прод" }, "наим_казнач_прод": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Наим Казнач Прод" } }, "type": "object", "required": [ "дата_гос_конт", "номер_гос_конт" ], "title": "ИнфПродГосЗакКазнТип" }, "app__schemas__upd_full__seller_title_5_03__________1___": { "properties": { "ид_гос_кон": { "type": "string", "maxLength": 25, "minLength": 20, "nullable": true, "title": "Ид Гос Кон" }, "сп_обст_фсчф": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6" ], "nullable": true, "title": "Сп Обст Фсчф" }, "сп_обст_фсчфдоп": { "type": "string", "maxLength": 5, "minLength": 5, "nullable": true, "title": "Сп Обст Фсчфдоп" }, "сп_обст_фдоп": { "type": "string", "maxLength": 5, "minLength": 5, "nullable": true, "title": "Сп Обст Фдоп" }, "вид_обяз": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03______________6" }, "type": "array", "title": "Вид Обяз", "default": [] }, "инф_прод_за_госк_казн": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03______________________", "nullable": true }, "св_фактор": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_______________2", "nullable": true }, "осн_уст_ден_треб": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03______________4", "nullable": true }, "сопр_док_фхж": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03______________4" }, "type": "array", "title": "Сопр Док Фхж", "default": [] } }, "type": "object", "title": "ДопСвФХЖ1Тип" }, "app__schemas__upd_full__seller_title_5_03___________1": { "properties": { "св_ип": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03___________2", "nullable": true }, "св_юл_уч": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_____________1", "nullable": true }, "св_ин_не_уч": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_03_______________1", "nullable": true }, "св_фл_уч": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_____________2", "nullable": true } }, "type": "object", "title": "ИдСвТип" }, "app__schemas__upd_full__seller_title_5_03___________1___": { "properties": { "ид_файл_инф_пол": { "type": "string", "maxLength": 36, "minLength": 36, "nullable": true, "title": "Ид Файл Инф Пол" }, "текст_инф": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_______________4" }, "type": "array", "title": "Текст Инф", "default": [] } }, "type": "object", "title": "ИнфПолФХЖ1Тип" }, "app__schemas__upd_full__seller_title_5_03___________2": { "properties": { "иннфл": { "type": "string", "maxLength": 12, "minLength": 12, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}", "title": "Иннфл" }, "св_гос_рег_ип": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Св Гос Рег Ип" }, "огрнип": { "type": "string", "maxLength": 15, "minLength": 15, "pattern": "[0-9]{15}", "nullable": true, "title": "Огрнип" }, "дата_огрнип": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Огрнип" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________" } }, "type": "object", "required": [ "иннфл", "фио" ], "title": "СвИПТип" }, "app__schemas__upd_full__seller_title_5_03___________3": { "properties": { "код_происх": { "type": "string", "maxLength": 3, "minLength": 3, "pattern": "[0-9]{3}", "nullable": true, "title": "Код Происх" }, "номер_дт": { "type": "string", "maxLength": 29, "minLength": 1, "nullable": true, "title": "Номер Дт" } }, "type": "object", "title": "СвДТТип" }, "app__schemas__upd_full__seller_title_5_03___________3___": { "properties": { "ид_файл_инф_пол": { "type": "string", "maxLength": 36, "minLength": 36, "nullable": true, "title": "Ид Файл Инф Пол" }, "текст_инф": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_______________4" }, "type": "array", "title": "Текст Инф", "default": [] } }, "type": "object", "title": "ИнфПолФХЖ3Тип" }, "app__schemas__upd_full__seller_title_5_03___________4": { "properties": { "св_тран": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Св Тран" }, "инкотермс": { "type": "string", "maxLength": 3, "minLength": 3, "nullable": true, "title": "Инкотермс" }, "вер_инкотермс": { "type": "string", "maxLength": 4, "minLength": 4, "nullable": true, "title": "Вер Инкотермс" } }, "type": "object", "title": "ТранТип" }, "app__schemas__upd_full__seller_title_5_03____________1": { "properties": { "тип": { "type": "string", "maxLength": 50, "minLength": 1, "title": "Тип" }, "номер": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Номер" } }, "type": "object", "required": [ "тип", "номер" ], "title": "НомерТип", "description": "Сведения о номере адресного элемента
• `тип`: Тип элемента
• `номер`: Номер элемента" }, "app__schemas__upd_full__seller_title_5_03____________2": { "properties": { "глн_места": { "type": "string", "maxLength": 13, "minLength": 13, "nullable": true, "title": "Глн Места" }, "адр_рф": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03____________3", "nullable": true }, "адр_гар": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_____________3", "nullable": true }, "адр_инф": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_____________4", "nullable": true } }, "type": "object", "title": "АдресТип", "description": "Сведения об адресе (месте нахождения)
• `глн_места`: Глобальный номер места нахождения (GLN места)
• `адр_рф`: Адрес, указанный в Едином государственном реестре юридических лиц/почтовый адрес/адрес регистрации по месту жительства (по месту пребывания) индивидуального предпринимателя, указанный в Едином государственном реестре индивидуальных предпринимателей (реквизиты адреса на территории Российской Федерации)
• `адр_гар`: Адрес в соответствии с государственным адресным реестром, указанный в Едином государственном реестре юридических лиц/почтовый адрес/адрес места жительстварегистрации по месту жительства (по месту пребывания) индивидуального предпринимателя, указанный в Едином государственном реестре индивидуальных предпринимателей (реквизиты адреса на территории Российской Федерации)
• `адр_инф`: Адрес, указанный в Едином государственном реестре юридических лиц/почтовый адрес/адрес места жительстварегистрации по месту жительства (по месту пребывания) индивидуального предпринимателя, указанный в Едином государственном реестре индивидуальных предпринимателей (информация об адресе, в том числе об адресе за пределами территории Российской Федерации)" }, "app__schemas__upd_full__seller_title_5_03____________3": { "properties": { "индекс": { "type": "string", "maxLength": 6, "minLength": 6, "pattern": "[0-9]{6}", "nullable": true, "title": "Индекс" }, "код_регион": { "type": "string", "maxLength": 2, "minLength": 2, "pattern": "[0-9]{2}", "title": "Код Регион" }, "наим_регион": { "type": "string", "maxLength": 51, "minLength": 1, "title": "Наим Регион" }, "район": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Район" }, "город": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Город" }, "насел_пункт": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Насел Пункт" }, "улица": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Улица" }, "дом": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Дом" }, "корпус": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Корпус" }, "кварт": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Кварт" }, "иные_свед": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Иные Свед" } }, "type": "object", "required": [ "код_регион", "наим_регион" ], "title": "АдрРФТип", "description": "Сведения об адресе в Российской Федерации, содержащиеся в ЕГРЮЛ
• `индекс`: Почтовый индекс
• `код_регион`: Код субъекта Российской Федерации
• `наим_регион`: Наименование субъекта Российской Федерации
• `район`: Район
• `город`: Город
• `насел_пункт`: Населенный пункт
• `улица`: Улица
• `дом`: Дом
• `корпус`: Корпус
• `кварт`: Квартира
• `иные_свед`: Иные сведения об адресе в Российской Федерации" }, "app__schemas__upd_full__seller_title_5_03____________4": { "properties": { "номер_прд": { "type": "string", "maxLength": 30, "minLength": 1, "nullable": true, "title": "Номер Прд" }, "дата_прд": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Прд" }, "сумма_прд": { "enum": [ "number", "string" ], "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Сумма Прд" } }, "type": "object", "title": "СвПРДТип" }, "app__schemas__upd_full__seller_title_5_03____________5": { "properties": { "иннфл_пер": { "type": "string", "maxLength": 12, "minLength": 12, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}", "nullable": true, "title": "Иннфл Пер" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "осн_довер_фл": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03______________4", "nullable": true }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________" } }, "type": "object", "required": [ "фио" ], "title": "ФЛПерТип" }, "app__schemas__upd_full__seller_title_5_03____________6": { "properties": { "сод_опер": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Сод Опер" }, "вид_опер": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Вид Опер" }, "дата_пер": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Пер" }, "дата_нач_пер": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Нач Пер" }, "дата_окон_пер": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Окон Пер" }, "осн_пер": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03______________4" }, "type": "array", "title": "Осн Пер", "default": [] }, "без_док_осн_пер": { "type": "string", "const": "1", "nullable": true, "title": "Без Док Осн Пер" }, "св_лиц_пер": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_______________8", "nullable": true }, "тран": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03___________4", "nullable": true }, "св_пер_вещи": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03________________3", "nullable": true } }, "type": "object", "required": [ "сод_опер" ], "title": "СвПерТип" }, "app__schemas__upd_full__seller_title_5_03_____________1": { "properties": { "наим_орг": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Наим Орг" }, "иннюл": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}", "title": "Иннюл" }, "кпп": { "type": "string", "maxLength": 9, "minLength": 9, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})([0-9]{2})([0-9A-Z]{2})([0-9]{3})", "nullable": true, "title": "Кпп" } }, "type": "object", "required": [ "наим_орг", "иннюл" ], "title": "СвЮЛУчТип" }, "app__schemas__upd_full__seller_title_5_03_____________2": { "properties": { "иннфл": { "type": "string", "maxLength": 12, "minLength": 12, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}", "nullable": true, "title": "Иннфл" }, "ид_стат_л": { "type": "string", "enum": [ "0", "1" ], "nullable": true, "title": "Ид Стат Л" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________", "nullable": true } }, "type": "object", "title": "СвФЛУчТип" }, "app__schemas__upd_full__seller_title_5_03_____________3": { "properties": { "ид_ном": { "type": "string", "maxLength": 36, "minLength": 36, "title": "Ид Ном" }, "индекс": { "type": "string", "maxLength": 6, "minLength": 6, "nullable": true, "title": "Индекс" }, "регион": { "type": "string", "maxLength": 2, "minLength": 2, "pattern": "[0-9]{2}", "title": "Регион" }, "наим_регион": { "type": "string", "maxLength": 51, "minLength": 1, "title": "Наим Регион" }, "муницип_район": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_________________1", "nullable": true }, "город_сел_поселен": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_________________1", "nullable": true }, "населен_пункт": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03______________3", "nullable": true }, "эл_план_структур": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03______________1", "nullable": true }, "эл_ул_дор_сети": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03______________1", "nullable": true }, "земел_участок": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Земел Участок" }, "здание": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03____________1" }, "type": "array", "title": "Здание", "default": [] }, "помещ_здания": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03____________1", "nullable": true }, "помещ_квартиры": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03____________1", "nullable": true } }, "type": "object", "required": [ "ид_ном", "регион", "наим_регион" ], "title": "АдрГАРТип", "description": "Адрес в соответствии с государственным адресным реестром
• `ид_ном`: Уникальный номер адреса объекта адресации в государственном адресном реестре
• `индекс`: Почтовый индекс
• `регион`: Субъект Российской Федерации (код)
• `наим_регион`: Наименование субъекта Российской Федерации
• `муницип_район`: Муниципальный район/ городской округ/ внутригородская территория города федерального значения/ муниципальный округ/ федеральная территория
• `город_сел_поселен`: Городское поселение/ сельское поселение/ межселенная территория в составе муниципального района/ внутригородской район городского округа
• `населен_пункт`: Населенный пункт (город, деревня, село и прочее)
• `эл_план_структур`: Элемент планировочной структуры
• `эл_ул_дор_сети`: Элемент улично-дорожной сети
• `земел_участок`: Земельный участок (номер)
• `здание`: Здание (строение), сооружение/ объект незавершенного строительства
• `помещ_здания`: Помещение в пределах здания (строения), сооружения/ машино-место
• `помещ_квартиры`: Помещение в пределах квартиры" }, "app__schemas__upd_full__seller_title_5_03_____________4": { "properties": { "код_стр": { "type": "string", "maxLength": 3, "minLength": 3, "pattern": "[0-9]{3}", "title": "Код Стр" }, "наим_стран": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Наим Стран" }, "адр_текст": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Адр Текст" } }, "type": "object", "required": [ "код_стр", "наим_стран", "адр_текст" ], "title": "АдрИнфТип", "description": "Информация об адресе, в том числе об адресе за пределами территории Российской Федерации
• `код_стр`: Код страны
• `наим_стран`: Наименование страны
• `адр_текст`: Адрес" }, "app__schemas__upd_full__seller_title_5_03_____________5": { "properties": { "наим_банк": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Наим Банк" }, "бик": { "type": "string", "maxLength": 9, "minLength": 9, "pattern": "[0-9]{9}", "nullable": true, "title": "Бик" }, "кор_счет": { "type": "string", "maxLength": 34, "minLength": 1, "nullable": true, "title": "Кор Счет" } }, "type": "object", "title": "СвБанкТип" }, "app__schemas__upd_full__seller_title_5_03_____________6": { "properties": { "сум_нал": { "enum": [ "number", "string" ], "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Сум Нал" }, "без_ндс": { "type": "string", "const": "без НДС", "nullable": true, "title": "Без Ндс" } }, "type": "object", "title": "СумНДСТип", "description": "Сумма НДС
• `сум_нал`: Значение
• `без_ндс`: Без НДС" }, "app__schemas__upd_full__seller_title_5_03_____________7": { "properties": { "груз_отпр": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_______________2", "nullable": true }, "он_же": { "type": "string", "const": "он же", "nullable": true, "title": "Он Же" } }, "type": "object", "title": "ГрузОтТип" }, "app__schemas__upd_full__seller_title_5_03_____________8": { "properties": { "код_окв": { "type": "string", "maxLength": 3, "minLength": 3, "pattern": "[0-9]{3}", "title": "Код Окв" }, "наим_окв": { "type": "string", "maxLength": 100, "minLength": 1, "title": "Наим Окв" }, "курс_вал": { "enum": [ "number", "string" ], "decimal_places": 4, "max_digits": 10, "nullable": true, "title": "Курс Вал" } }, "type": "object", "required": [ "код_окв", "наим_окв" ], "title": "ДенИзмТип" }, "app__schemas__upd_full__seller_title_5_03_____________9": { "properties": { "пред_орг_пер": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_________________6", "nullable": true }, "фл_пер": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03____________5", "nullable": true } }, "type": "object", "title": "ИнЛицоТип" }, "app__schemas__upd_full__seller_title_5_03______________1": { "properties": { "тип": { "type": "string", "maxLength": 50, "minLength": 1, "title": "Тип" }, "наим": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Наим" } }, "type": "object", "required": [ "тип", "наим" ], "title": "ТипНаимТип", "description": "Сведения о типе и наименовании адресного элемента
• `тип`: Тип элемента
• `наим`: Наименование элемента" }, "app__schemas__upd_full__seller_title_5_03______________2": { "properties": { "ин_конт": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Ин Конт" }, "тлф": { "items": { "type": "string", "maxLength": 255, "minLength": 1 }, "type": "array", "title": "Тлф", "default": [] }, "эл_почта": { "items": { "type": "string", "maxLength": 255, "minLength": 1 }, "type": "array", "title": "Эл Почта", "default": [] } }, "type": "object", "title": "КонтактТип", "description": "Контактные данные
• `ин_конт`: Иные контактные данные
• `тлф`: Номер контактного телефона/факс
• `эл_почта`: Адрес электронной почты" }, "app__schemas__upd_full__seller_title_5_03______________3": { "properties": { "вид": { "type": "string", "maxLength": 50, "minLength": 1, "title": "Вид" }, "наим": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Наим" } }, "type": "object", "required": [ "вид", "наим" ], "title": "ВидНаимТип", "description": "Сведения о виде и наименовании адресного элемента
• `вид`: Вид элемента
• `наим`: Наименование элемента" }, "app__schemas__upd_full__seller_title_5_03______________4": { "properties": { "рекв_наим_док": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Рекв Наим Док" }, "рекв_номер_док": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Рекв Номер Док" }, "рекв_дата_док": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "title": "Рекв Дата Док" }, "рекв_ид_файл_док": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Рекв Ид Файл Док" }, "рекв_ид_док": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Рекв Ид Док" }, "р_ид_сист_хран_д": { "type": "string", "maxLength": 500, "minLength": 1, "nullable": true, "title": "Р Ид Сист Хран Д" }, "рекв_урл_сист_док": { "type": "string", "maxLength": 500, "minLength": 1, "nullable": true, "title": "Рекв Урл Сист Док" }, "рекв_доп_свед_док": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Рекв Доп Свед Док" }, "рекв_ид_рек_сост": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_03________________1" }, "type": "array", "title": "Рекв Ид Рек Сост", "default": [] } }, "type": "object", "required": [ "рекв_наим_док", "рекв_номер_док", "рекв_дата_док" ], "title": "РеквДокТип", "description": "Реквизиты документа
• `рекв_наим_док`: Наименование документа
• `рекв_номер_док`: Номер документа
• `рекв_дата_док`: Дата документа
• `рекв_ид_файл_док`: Идентификатор файла обмена документа, подписанного первой стороной
• `рекв_ид_док`: Идентификатор документа
• `р_ид_сист_хран_д`: Идентифицирующая информация об информационной системе, в которой осуществляется хранение документа, необходимая для запроса информации из информационной системы
• `рекв_урл_сист_док`: Сведения в формате URL об информационной системе, которая предоставляет техническую возможность получения информации о документе
• `рекв_доп_свед_док`: Дополнительные сведения
• `рекв_ид_рек_сост`: Идентифицирующие реквизиты экономических субъектов, составивших (сформировавших) документ" }, "app__schemas__upd_full__seller_title_5_03______________5": { "properties": { "ном_испр": { "enum": [ "number", "string" ], "title": "Ном Испр" }, "дата_испр": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "title": "Дата Испр" } }, "type": "object", "required": [ "ном_испр", "дата_испр" ], "title": "ИспрДокТип" }, "app__schemas__upd_full__seller_title_5_03______________6": { "properties": { "код_вид_обяз": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Код Вид Обяз" }, "наим_вид_обяз": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Вид Обяз" } }, "type": "object", "title": "ВидОбязТип" }, "app__schemas__upd_full__seller_title_5_03______________7": { "properties": { "ном_стр": { "enum": [ "number", "string" ], "title": "Ном Стр" }, "наим_тов": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Наим Тов" }, "океи__тов": { "type": "string", "maxLength": 4, "minLength": 3, "pattern": "(?:[0-9]{3})|(?:[0-9]{4})", "nullable": true, "title": "Океи Тов" }, "наим_ед_изм": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Ед Изм" }, "кол_тов": { "enum": [ "number", "string" ], "decimal_places": 11, "gt": 0, "max_digits": 26, "nullable": true, "title": "Кол Тов" }, "цена_тов": { "enum": [ "number", "string" ], "decimal_places": 11, "gt": 0, "max_digits": 26, "nullable": true, "title": "Цена Тов" }, "ст_тов_без_ндс": { "enum": [ "number", "string" ], "decimal_places": 2, "ge": 0, "max_digits": 19, "nullable": true, "title": "Ст Тов Без Ндс" }, "нал_ст": { "type": "string", "enum": [ "0%", "5%", "7%", "9,09%", "10%", "16,67%", "18%", "18,03%", "20%", "22%", "5/105", "7/107", "10/110", "18/118", "20/120", "22/122", "без НДС", "НДС исчисляется налоговым агентом" ], "title": "Нал Ст" }, "ст_тов_уч_нал": { "enum": [ "number", "string" ], "decimal_places": 2, "ge": 0, "max_digits": 19, "nullable": true, "title": "Ст Тов Уч Нал" }, "св_дт": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03___________3" }, "type": "array", "title": "Св Дт", "default": [] }, "доп_свед_тов": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_________________3", "nullable": true }, "акциз": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_______________6", "nullable": true }, "сум_нал": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_____________6" }, "инф_пол_фхж2": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_______________4" }, "type": "array", "title": "Инф Пол Фхж2", "default": [] } }, "type": "object", "required": [ "ном_стр", "нал_ст", "сум_нал" ], "title": "СведТовТип" }, "app__schemas__upd_full__seller_title_5_03_______________1": { "properties": { "номер_счета": { "type": "string", "maxLength": 34, "minLength": 1, "nullable": true, "title": "Номер Счета" }, "св_банк": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_____________5", "nullable": true } }, "type": "object", "title": "БанкРеквТип" }, "app__schemas__upd_full__seller_title_5_03_______________2": { "properties": { "окпо": { "type": "string", "maxLength": 10, "minLength": 1, "nullable": true, "title": "Окпо" }, "код_опф": { "type": "string", "maxLength": 5, "minLength": 2, "nullable": true, "title": "Код Опф" }, "полн_наим_опф": { "type": "string", "maxLength": 255, "minLength": 4, "nullable": true, "title": "Полн Наим Опф" }, "структ_подр": { "type": "string", "maxLength": 500, "minLength": 1, "nullable": true, "title": "Структ Подр" }, "инф_для_участ": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Инф Для Участ" }, "сокр_наим": { "type": "string", "maxLength": 510, "minLength": 1, "nullable": true, "title": "Сокр Наим" }, "ид_св": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03___________1" }, "адрес": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03____________2", "nullable": true }, "банк_рекв": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_______________1", "nullable": true }, "контакт": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03______________2", "nullable": true } }, "type": "object", "required": [ "ид_св" ], "title": "УчастникТип", "description": "Сведения об участнике факта хозяйственной жизни
• `окпо`: Код в общероссийском классификаторе предприятий и организаций
• `код_опф`: Код по Общероссийскому классификатору организационно-правовых форм об организационно-правовой форме
• `полн_наим_опф`: Полное наименование организационно-правовой формы
• `структ_подр`: Структурное подразделение
• `инф_для_участ`: Информация для участника документооборота
• `сокр_наим`: Сокращенное наименование
• `ид_св`: Идентификационные сведения
• `адрес`: Адрес
• `банк_рекв`: Банковские реквизиты
• `контакт`: Контактные данные" }, "app__schemas__upd_full__seller_title_5_03_______________5": { "properties": { "номер_док": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Номер Док" }, "дата_док": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "title": "Дата Док" }, "имя_файл_испр_прод": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Имя Файл Испр Прод" }, "имя_файл_испр_пок": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Имя Файл Испр Пок" }, "испр_док": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03______________5", "nullable": true }, "св_прод": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_______________2" }, "type": "array", "title": "Св Прод" }, "груз_от": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_____________7" }, "type": "array", "title": "Груз От", "default": [] }, "груз_получ": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_______________2" }, "type": "array", "title": "Груз Получ", "default": [] }, "св_прд": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03____________4" }, "type": "array", "title": "Св Прд", "default": [] }, "док_подтв_отгр_ном": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03______________4" }, "type": "array", "title": "Док Подтв Отгр Ном", "default": [] }, "св_покуп": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_______________2" }, "type": "array", "title": "Св Покуп" }, "ден_изм": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_____________8" }, "доп_св_фхж1": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03__________1___", "nullable": true }, "инф_пол_фхж1": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03___________1___", "nullable": true } }, "type": "object", "required": [ "номер_док", "дата_док", "св_прод", "св_покуп", "ден_изм" ], "title": "СвСчФактТип" }, "app__schemas__upd_full__seller_title_5_03_______________7": { "properties": { "ст_тов_без_ндс_всего": { "enum": [ "number", "string" ], "decimal_places": 2, "ge": 0, "max_digits": 19, "nullable": true, "title": "Ст Тов Без Ндс Всего" }, "ст_тов_уч_нал_всего": { "enum": [ "number", "string" ], "decimal_places": 2, "ge": 0, "max_digits": 19, "nullable": true, "title": "Ст Тов Уч Нал Всего" }, "кол_нетто_вс": { "enum": [ "number", "string" ], "decimal_places": 11, "max_digits": 26, "nullable": true, "title": "Кол Нетто Вс" }, "сум_нал_всего": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_____________6" } }, "type": "object", "required": [ "сум_нал_всего" ], "title": "ВсегоОплТип" }, "app__schemas__upd_full__seller_title_5_03_______________8": { "properties": { "раб_орг_прод": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_________________5", "nullable": true }, "ин_лицо": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_____________9", "nullable": true } }, "type": "object", "title": "СвЛицПерТип" }, "app__schemas__upd_full__seller_title_5_03_______________9": { "properties": { "кнд": { "type": "string", "const": "1115131", "title": "Кнд", "default": "1115131" }, "уид": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Уид" }, "функция": { "$ref": "#/components/schemas/UPDFunctionEnum" }, "по_факт_хж": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "По Факт Хж" }, "наим_док_опр": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Док Опр" }, "дата_инф_пр": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "title": "Дата Инф Пр" }, "врем_инф_пр": { "type": "string", "maxLength": 8, "minLength": 8, "pattern": "([0-1]{1}[0-9]{1}|2[0-3]{1})\\.([0-5]{1}[0-9]{1})\\.([0-5]{1}[0-9]{1})", "title": "Врем Инф Пр" }, "наим_экон_суб_сост": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Наим Экон Суб Сост" }, "согл_стр_доп_инф": { "type": "string", "maxLength": 14, "minLength": 14, "nullable": true, "title": "Согл Стр Доп Инф" }, "св_сч_факт": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_______________5" }, "табл_сч_факт": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_________________4", "nullable": true }, "св_прод_пер": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03________________4", "nullable": true }, "подписант": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03________________6" }, "type": "array", "title": "Подписант" }, "осн_довер_орг_сост": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03______________4", "nullable": true } }, "type": "object", "required": [ "функция", "дата_инф_пр", "врем_инф_пр", "св_сч_факт", "подписант" ], "title": "ДокументТип" }, "app__schemas__upd_full__seller_title_5_03________________": { "properties": { "ном_тов_прослеж": { "type": "string", "maxLength": 29, "minLength": 25, "title": "Ном Тов Прослеж" }, "ед_изм_прослеж": { "type": "string", "maxLength": 4, "minLength": 3, "pattern": "(?:[0-9]{3})|(?:[0-9]{4})", "title": "Ед Изм Прослеж" }, "наим_ед_изм_прослеж": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Наим Ед Изм Прослеж" }, "кол_в_ед_прослеж": { "enum": [ "number", "string" ], "title": "Кол В Ед Прослеж" }, "ст_тов_без_ндс_прослеж": { "enum": [ "number", "string" ], "title": "Ст Тов Без Ндс Прослеж" }, "доп_инф_прослеж": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Доп Инф Прослеж" } }, "type": "object", "required": [ "ном_тов_прослеж", "ед_изм_прослеж", "наим_ед_изм_прослеж", "кол_в_ед_прослеж", "ст_тов_без_ндс_прослеж" ], "title": "СведПрослежТип" }, "app__schemas__upd_full__seller_title_5_03________________2": { "properties": { "наим_гос_сист": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Наим Гос Сист" }, "учет_ед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Учет Ед" }, "иная_инф": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Иная Инф" }, "ид_ном_учет_ед": { "items": { "type": "string", "maxLength": 255, "minLength": 1 }, "type": "array", "title": "Ид Ном Учет Ед" } }, "type": "object", "required": [ "наим_гос_сист", "ид_ном_учет_ед" ], "title": "СвГосСистТип" }, "app__schemas__upd_full__seller_title_5_03________________3": { "properties": { "дата_пер_вещ": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Пер Вещ" }, "св_пер_вещ": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Св Пер Вещ" }, "док_пер_вещ": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03______________4", "nullable": true } }, "type": "object", "title": "СвПерВещиТип" }, "app__schemas__upd_full__seller_title_5_03________________4": { "properties": { "св_пер": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03____________6" }, "инф_пол_фхж3": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03___________3___", "nullable": true } }, "type": "object", "required": [ "св_пер" ], "title": "СвПродПерТип" }, "app__schemas__upd_full__seller_title_5_03________________6": { "properties": { "должн": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Должн" }, "тип_подпис": { "type": "string", "enum": [ "1", "2", "3" ], "nullable": true, "title": "Тип Подпис" }, "дата_под_док": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Под Док" }, "спос_подт_полном": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6" ], "title": "Спос Подт Полном" }, "доп_свед_подп": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Доп Свед Подп" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________" }, "св_довер_эл": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_03________________5" }, "type": "array", "title": "Св Довер Эл", "default": [] }, "св_довер_бум": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_03_________________2" }, "type": "array", "title": "Св Довер Бум", "default": [] } }, "type": "object", "required": [ "спос_подт_полном", "фио" ], "title": "ПодписантТип" }, "app__schemas__upd_full__seller_title_5_03_________________1": { "properties": { "вид_код": { "type": "string", "maxLength": 1, "minLength": 1, "title": "Вид Код" }, "наим": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Наим" } }, "type": "object", "required": [ "вид_код", "наим" ], "title": "ВидНаимКодТип", "description": "Сведения о виде (коде) и наименовании адресного элемента
• `вид_код`: Вид (код) элемента
• `наим`: Наименование элемента" }, "app__schemas__upd_full__seller_title_5_03_________________2": { "properties": { "ам_группа": { "type": "string", "maxLength": 2, "minLength": 1, "title": "Ам Группа" }, "код_окоф": { "type": "string", "maxLength": 16, "minLength": 1, "title": "Код Окоф" }, "ср_пол_исп_ос": { "type": "string", "maxLength": 3, "minLength": 1, "title": "Ср Пол Исп Ос" }, "факт_срок_исп": { "enum": [ "number", "string" ], "title": "Факт Срок Исп" } }, "type": "object", "required": [ "ам_группа", "код_окоф", "ср_пол_исп_ос", "факт_срок_исп" ], "title": "НалУчАмортТип" }, "app__schemas__upd_full__seller_title_5_03_________________3": { "properties": { "пр_тов_раб": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "nullable": true, "title": "Пр Тов Раб" }, "доп_призн": { "type": "string", "maxLength": 4, "minLength": 1, "nullable": true, "title": "Доп Призн" }, "надл_отп": { "enum": [ "number", "string" ], "decimal_places": 11, "max_digits": 26, "nullable": true, "title": "Надл Отп" }, "характер_тов": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Характер Тов" }, "сорт_тов": { "type": "string", "maxLength": 10, "minLength": 1, "nullable": true, "title": "Сорт Тов" }, "серия_тов": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Серия Тов" }, "артикул_тов": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Артикул Тов" }, "код_тов": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Код Тов" }, "гтин": { "type": "string", "maxLength": 14, "minLength": 14, "nullable": true, "title": "Гтин" }, "код_кат": { "type": "string", "maxLength": 27, "minLength": 27, "nullable": true, "title": "Код Кат" }, "код_вид_тов": { "type": "string", "maxLength": 10, "minLength": 10, "nullable": true, "title": "Код Вид Тов" }, "код_вид_пр": { "enum": [ "number", "string" ], "decimal_places": 0, "max_digits": 3, "nullable": true, "title": "Код Вид Пр" }, "код_тов_окпд2": { "type": "string", "maxLength": 12, "minLength": 2, "nullable": true, "title": "Код Тов Окпд2" }, "доп_инф_п_вид_о": { "type": "string", "maxLength": 5, "minLength": 5, "nullable": true, "title": "Доп Инф П Вид О" }, "кр_наим_стр_пр": { "items": { "type": "string", "maxLength": 255, "minLength": 1 }, "type": "array", "title": "Кр Наим Стр Пр", "default": [] }, "сопр_док_тов": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03______________4" }, "type": "array", "title": "Сопр Док Тов", "default": [] }, "нал_уч_аморт": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_________________2", "nullable": true }, "сум_нал_восст": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_____________6", "nullable": true }, "свед_прослеж": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03________________" }, "type": "array", "title": "Свед Прослеж", "default": [] }, "ном_сред_идент_тов": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03____________________" }, "type": "array", "title": "Ном Сред Идент Тов", "default": [] }, "св_гос_сист": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03________________2" }, "type": "array", "title": "Св Гос Сист", "default": [] } }, "type": "object", "title": "ДопСведТовТип" }, "app__schemas__upd_full__seller_title_5_03_________________4": { "properties": { "свед_тов": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03______________7" }, "type": "array", "title": "Свед Тов" }, "всего_опл": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_______________7" } }, "type": "object", "required": [ "свед_тов", "всего_опл" ], "title": "ТаблСчФактТип" }, "app__schemas__upd_full__seller_title_5_03_________________5": { "properties": { "должность": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Должность" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________" } }, "type": "object", "required": [ "должность", "фио" ], "title": "РабОргПродТип" }, "app__schemas__upd_full__seller_title_5_03_________________6": { "properties": { "должность": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Должность" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "наим_орг_пер": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Наим Орг Пер" }, "иннюл_пер": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}", "nullable": true, "title": "Иннюл Пер" }, "осн_довер_орг_пер": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03______________4", "nullable": true }, "осн_полн_пред_пер": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03______________4", "nullable": true }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________" } }, "type": "object", "required": [ "должность", "наим_орг_пер", "фио" ], "title": "ПредОргПерТип" }, "app__schemas__upd_full__seller_title_5_03____________________": { "properties": { "идент_транс_упак": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Идент Транс Упак" }, "кол_вед_марк": { "enum": [ "number", "string" ], "decimal_places": 0, "max_digits": 26, "nullable": true, "title": "Кол Вед Марк" }, "пр_парт_марк": { "type": "string", "maxLength": 55, "minLength": 1, "nullable": true, "title": "Пр Парт Марк" }, "киз": { "items": { "type": "string", "maxLength": 255, "minLength": 1 }, "type": "array", "title": "Киз", "default": [] }, "ном_упак": { "items": { "type": "string", "maxLength": 255, "minLength": 1 }, "type": "array", "title": "Ном Упак", "default": [] } }, "type": "object", "title": "НомСредИдентТовТип" }, "app__schemas__upd_full__seller_title_5_03______________________": { "properties": { "дата_гос_конт": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "title": "Дата Гос Конт" }, "номер_гос_конт": { "type": "string", "maxLength": 100, "minLength": 1, "title": "Номер Гос Конт" }, "лиц_счет_прод": { "type": "string", "maxLength": 11, "minLength": 11, "nullable": true, "title": "Лиц Счет Прод" }, "код_прод_бюдж_класс": { "type": "string", "maxLength": 20, "minLength": 20, "nullable": true, "title": "Код Прод Бюдж Класс" }, "код_цели_прод": { "type": "string", "maxLength": 20, "minLength": 20, "nullable": true, "title": "Код Цели Прод" }, "код_казнач_прод": { "type": "string", "maxLength": 4, "minLength": 1, "nullable": true, "title": "Код Казнач Прод" }, "наим_казнач_прод": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Наим Казнач Прод" } }, "type": "object", "required": [ "дата_гос_конт", "номер_гос_конт" ], "title": "ИнфПродЗаГоскКазнТип" }, "app__schemas__upd_nullable__buyer_title_5_01_______": { "properties": { "наим_орг": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Наим Орг" }, "должн": { "type": "string", "maxLength": 128, "minLength": 1, "nullable": true, "title": "Должн" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________", "nullable": true } }, "type": "object", "title": "ЮЛТип" }, "app__schemas__upd_nullable__buyer_title_5_01________": { "properties": { "фамилия": { "type": "string", "maxLength": 60, "minLength": 1, "nullable": true, "title": "Фамилия" }, "имя": { "type": "string", "maxLength": 60, "minLength": 1, "nullable": true, "title": "Имя" }, "отчество": { "type": "string", "maxLength": 60, "minLength": 1, "nullable": true, "title": "Отчество" } }, "type": "object", "title": "ФИОТип", "description": "Фамилия, имя, отчество физического лица
• `фамилия`: Фамилия
• `имя`: Имя
• `отчество`: Отчество" }, "app__schemas__upd_nullable__buyer_title_5_01________4___": { "properties": { "св_прин": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01_____________3" }, "инф_пол_фхж4": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01___________4___", "nullable": true } }, "type": "object", "title": "СодФХЖ4Тип" }, "app__schemas__upd_nullable__buyer_title_5_01___________1": { "properties": { "иннфл": { "type": "string", "maxLength": 12, "minLength": 12, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}", "nullable": true, "title": "Иннфл" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________" } }, "type": "object", "title": "СвФЛТип", "description": "Сведения о физическом лице
• `иннфл`: ИНН
• `иные_свед`: Иные сведения, идентифицирующие физическое лицо
• `фио`: Фамилия, имя, отчество" }, "app__schemas__upd_nullable__buyer_title_5_01___________2": { "properties": { "св_гос_рег_ип": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Св Гос Рег Ип" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________" } }, "type": "object", "title": "СвИПТип", "description": "Сведения о индивидуальном предпринимателе
• `иннфл`: ИНН
• `св_гос_рег_ип`: Реквизиты свидетельства о государственной регистрации индивидуального предпринимателя
• `иные_свед`: Иные сведения, идентифицирующие физическое лицо
• `фио`: Фамилия, имя, отчество" }, "app__schemas__upd_nullable__buyer_title_5_01___________4___": { "properties": { "ид_файл_инф_пол": { "type": "string", "maxLength": 36, "minLength": 36, "nullable": true, "title": "Ид Файл Инф Пол" }, "текст_инф": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01_____________" }, "type": "array", "title": "Текст Инф", "default": [] } }, "type": "object", "title": "ИнфПолФХЖ4Тип" }, "app__schemas__upd_nullable__buyer_title_5_01_____________": { "properties": { "идентиф": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Идентиф" }, "значен": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Значен" } }, "type": "object", "title": "ТекстИнфТип" }, "app__schemas__upd_nullable__buyer_title_5_01_____________1": { "properties": { "осн_довер_фл": { "type": "string", "maxLength": 120, "minLength": 1, "nullable": true, "title": "Осн Довер Фл" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________", "nullable": true } }, "type": "object", "title": "ФЛПринТип" }, "app__schemas__upd_nullable__buyer_title_5_01_____________2": { "properties": { "пред_орг_прин": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________________", "nullable": true }, "фл_прин": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01_____________1", "nullable": true } }, "type": "object", "title": "ИнЛицоТип" }, "app__schemas__upd_nullable__buyer_title_5_01_____________3": { "properties": { "сод_опер": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Сод Опер" }, "дата_прин": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Прин" }, "код_сод_опер": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01_______________", "nullable": true }, "св_лиц_прин": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________________2", "nullable": true } }, "type": "object", "title": "СвПринТип" }, "app__schemas__upd_nullable__buyer_title_5_01_____________4": { "properties": { "наим_экон_суб_сост": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Наим Экон Суб Сост" }, "сод_фхж4": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________4___" }, "подписант": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________________3" }, "type": "array", "title": "Подписант", "default": [] } }, "type": "object", "title": "ИнфПокТип" }, "app__schemas__upd_nullable__buyer_title_5_01_______________": { "properties": { "код_итога": { "type": "string", "enum": [ "1", "2", "3" ], "nullable": true, "title": "Код Итога" }, "наим_док_расх": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Док Расх" }, "вид_док_расх": { "type": "string", "enum": [ "2", "3" ], "nullable": true, "title": "Вид Док Расх" }, "ном_док_расх": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Ном Док Расх" }, "дата_док_расх": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Док Расх" } }, "type": "object", "title": "КодСодОперТип" }, "app__schemas__upd_nullable__buyer_title_5_01________________": { "properties": { "должность": { "type": "string", "maxLength": 128, "minLength": 1, "nullable": true, "title": "Должность" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "наим_орг_прин": { "type": "string", "maxLength": 128, "minLength": 1, "nullable": true, "title": "Наим Орг Прин" }, "осн_довер_орг_прин": { "type": "string", "maxLength": 120, "minLength": 1, "nullable": true, "title": "Осн Довер Орг Прин" }, "осн_полн_пред_прин": { "type": "string", "maxLength": 120, "minLength": 1, "nullable": true, "title": "Осн Полн Пред Прин" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________", "nullable": true } }, "type": "object", "title": "ПредОргПринТип" }, "app__schemas__upd_nullable__buyer_title_5_01________________1": { "properties": { "должность": { "type": "string", "maxLength": 128, "minLength": 1, "nullable": true, "title": "Должность" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "осн_полн": { "type": "string", "maxLength": 120, "minLength": 1, "nullable": true, "title": "Осн Полн" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________", "nullable": true } }, "type": "object", "title": "РабОргПокТип" }, "app__schemas__upd_nullable__buyer_title_5_01________________2": { "properties": { "раб_орг_пок": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________________1", "nullable": true }, "ин_лицо": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01_____________2", "nullable": true } }, "type": "object", "title": "СвЛицПринТип" }, "app__schemas__upd_nullable__buyer_title_5_01________________3": { "properties": { "обл_полн": { "type": "string", "enum": [ "1", "2", "3" ], "nullable": true, "title": "Обл Полн" }, "статус": { "type": "string", "enum": [ "3", "4", "5", "6" ], "nullable": true, "title": "Статус" }, "осн_полн": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Осн Полн" }, "осн_полн_орг": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Осн Полн Орг" }, "фл": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01___________1", "nullable": true }, "ип": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01___________2", "nullable": true }, "юл": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01_______", "nullable": true } }, "type": "object", "title": "ПодписантТип" }, "app__schemas__upd_nullable__buyer_title_5_03________4___": { "properties": { "св_прин": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_03_____________3" } }, "type": "object", "title": "СодФХЖ4Тип" }, "app__schemas__upd_nullable__buyer_title_5_03____________": { "properties": { "рекв_наим_док": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Рекв Наим Док" }, "рекв_номер_док": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Рекв Номер Док" }, "рекв_дата_док": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Рекв Дата Док" }, "рекв_ид_файл_док": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Рекв Ид Файл Док" }, "рекв_ид_док": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Рекв Ид Док" }, "р_ид_сист_хран_д": { "type": "string", "maxLength": 500, "minLength": 1, "nullable": true, "title": "Р Ид Сист Хран Д" }, "рекв_урл_сист_док": { "type": "string", "maxLength": 500, "minLength": 1, "nullable": true, "title": "Рекв Урл Сист Док" }, "рекв_доп_свед_док": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Рекв Доп Свед Док" }, "рекв_ид_рек_сост": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_03________________1" }, "type": "array", "title": "Рекв Ид Рек Сост", "default": [] } }, "type": "object", "title": "РеквДокТип", "description": "Реквизиты документа
• `рекв_наим_док`: Наименование документа
• `рекв_номер_док`: Номер документа
• `рекв_дата_док`: Дата документа
• `рекв_ид_файл_док`: Идентификатор файла обмена документа, подписанного первой стороной
• `рекв_ид_док`: Идентификатор документа
• `р_ид_сист_хран_д`: Идентифицирующая информация об информационной системе, в которой осуществляется хранение документа, необходимая для запроса информации из информационной системы
• `рекв_урл_сист_док`: Сведения в формате URL об информационной системе, которая предоставляет техническую возможность получения информации о документе
• `рекв_доп_свед_док`: Дополнительные сведения
• `рекв_ид_рек_сост`: Идентифицирующие реквизиты экономических субъектов, составивших (сформировавших) документ" }, "app__schemas__upd_nullable__buyer_title_5_03_____________1": { "properties": { "иннфл_прин": { "type": "string", "maxLength": 12, "minLength": 12, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}", "nullable": true, "title": "Иннфл Прин" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "осн_довер_фл": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_03____________", "nullable": true }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________", "nullable": true } }, "type": "object", "title": "ФЛПринТип" }, "app__schemas__upd_nullable__buyer_title_5_03_____________2": { "properties": { "пред_орг_прин": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_03________________", "nullable": true }, "фл_прин": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_03_____________1", "nullable": true } }, "type": "object", "title": "ИнЛицоТип" }, "app__schemas__upd_nullable__buyer_title_5_03_____________3": { "properties": { "сод_опер": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Сод Опер" }, "дата_прин": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Прин" }, "код_сод_опер": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_03_________________1" }, "св_лиц_прин": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_03________________3", "nullable": true } }, "type": "object", "title": "СвПринТип" }, "app__schemas__upd_nullable__buyer_title_5_03_______________1": { "properties": { "ид_стат": { "type": "string", "enum": [ "ИО", "ИГ" ], "nullable": true, "title": "Ид Стат" }, "код_стр": { "type": "string", "maxLength": 3, "minLength": 3, "pattern": "[0-9]{3}", "nullable": true, "title": "Код Стр" }, "наим_стран": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Стран" }, "наим": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Наим" }, "идентиф": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Идентиф" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" } }, "type": "object", "title": "СвИнНеУчТип", "description": "Сведения об иностранной организации (иностранном гражданине), не состоящей на учете в налоговых органах
• `ид_стат`: Идентификация статуса
• `код_стр`: Код страны
• `наим_стран`: Наименование страны
• `наим`: Наименование иностранной организации полное/Фамилия, имя, отчество (при наличии) иностранного гражданина
• `идентиф`: Идентификатор иностранной организации (иностранного гражданина)
• `иные_свед`: Иные сведения для однозначной идентификации иностранной организации (иностранного гражданина)" }, "app__schemas__upd_nullable__buyer_title_5_03_______________2": { "properties": { "наим_экон_суб_сост": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Наим Экон Суб Сост" }, "сод_фхж4": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_03________4___" }, "подписант": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_03________________5" }, "type": "array", "title": "Подписант", "default": [] } }, "type": "object", "title": "ДокументТип" }, "app__schemas__upd_nullable__buyer_title_5_03________________": { "properties": { "должность": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Должность" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "наим_орг_прин": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Орг Прин" }, "инн_орг_прин": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}", "nullable": true, "title": "Инн Орг Прин" }, "осн_довер_орг_прин": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_03____________", "nullable": true }, "осн_полн_пред_прин": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_03____________", "nullable": true }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________", "nullable": true } }, "type": "object", "title": "ПредОргПринТип" }, "app__schemas__upd_nullable__buyer_title_5_03________________1": { "properties": { "иннюл": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}", "nullable": true, "title": "Иннюл" }, "иннфл": { "type": "string", "maxLength": 12, "minLength": 12, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}", "nullable": true, "title": "Иннфл" }, "данн_ино": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_03_______________1", "nullable": true }, "наим_оив": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Оив" } }, "type": "object", "title": "ИдРекСостТип", "description": "Идентифицирующие реквизиты экономических субъектов, составивших (сформировавших) документ
• `иннюл`: ИНН организации, состоящей на учете в налоговом органе
• `иннфл`: ИНН физического лица, в том числе индивидуального предпринимателя
• `данн_ино`: Данные об иностранной организации (иностранном гражданине), не состоящей на учете в налоговых органах
• `наим_оив`: Краткое наименование органа исполнительной власти (специализированной уполномоченной организации), выдавшего документ" }, "app__schemas__upd_nullable__buyer_title_5_03________________2": { "properties": { "должность": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Должность" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________", "nullable": true } }, "type": "object", "title": "РабОргПокТип" }, "app__schemas__upd_nullable__buyer_title_5_03________________3": { "properties": { "раб_орг_пок": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_03________________2", "nullable": true }, "ин_лицо": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_03_____________2", "nullable": true } }, "type": "object", "title": "СвЛицПринТип" }, "app__schemas__upd_nullable__buyer_title_5_03________________4": { "properties": { "ном_довер": { "type": "string", "maxLength": 36, "minLength": 36, "nullable": true, "title": "Ном Довер" }, "дата_выд_довер": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Выд Довер" }, "вн_ном_довер": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Вн Ном Довер" }, "дата_вн_рег_довер": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Вн Рег Довер" } }, "type": "object", "title": "СвДоверЭлТип" }, "app__schemas__upd_nullable__buyer_title_5_03________________5": { "properties": { "должн": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Должн" }, "спос_подт_полном": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6" ], "nullable": true, "title": "Спос Подт Полном" }, "доп_свед_подп": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Доп Свед Подп" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________", "nullable": true }, "св_довер_эл": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_03________________4" }, "type": "array", "title": "Св Довер Эл", "default": [] }, "св_довер_бум": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_03_________________2" }, "type": "array", "title": "Св Довер Бум", "default": [] } }, "type": "object", "title": "ПодписантТип" }, "app__schemas__upd_nullable__buyer_title_5_03_________________1": { "properties": { "код_итога": { "type": "string", "enum": [ "1", "2", "3" ], "nullable": true, "title": "Код Итога" }, "рекв_док_расх": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_03____________", "nullable": true } }, "type": "object", "title": "КодСодОперТип" }, "app__schemas__upd_nullable__buyer_title_5_03_________________2": { "properties": { "дата_выд_довер": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Выд Довер" }, "вн_ном_довер": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Вн Ном Довер" }, "св_ид_довер": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Св Ид Довер" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________", "nullable": true } }, "type": "object", "title": "СвДоверБумТип" }, "app__schemas__upd_nullable__seller_title_5_01_______": { "properties": { "гос_рег_ип_выд_дов": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Гос Рег Ип Выд Дов" }, "иннюл": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}", "nullable": true, "title": "Иннюл" }, "наим_орг": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Наим Орг" }, "должн": { "type": "string", "maxLength": 128, "minLength": 0, "nullable": true, "title": "Должн" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________", "nullable": true } }, "type": "object", "title": "ЮЛТип" }, "app__schemas__upd_nullable__seller_title_5_01__________1___": { "properties": { "ид_гос_кон": { "type": "string", "maxLength": 25, "minLength": 0, "nullable": true, "title": "Ид Гос Кон" }, "наим_окв": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Наим Окв" }, "курс_вал": { "enum": [ "number", "string" ], "decimal_places": 4, "max_digits": 10, "nullable": true, "title": "Курс Вал" }, "обст_форм_счф": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6", "7", "8" ], "nullable": true, "title": "Обст Форм Счф" }, "инф_прод_гос_зак_казн": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01______________________", "nullable": true }, "св_фактор": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_______________2", "nullable": true }, "осн_уст_ден_треб": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01________________1", "nullable": true } }, "type": "object", "title": "ДопСвФХЖ1Тип" }, "app__schemas__upd_nullable__seller_title_5_01___________1": { "properties": { "св_ип": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01___________2", "nullable": true }, "св_юл_уч": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_____________1", "nullable": true }, "св_ин_не_уч": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_______________3", "nullable": true }, "св_фл_участ_фхж": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01___________3", "nullable": true } }, "type": "object", "title": "ИдСвТип" }, "app__schemas__upd_nullable__seller_title_5_01___________1___": { "properties": { "ид_файл_инф_пол": { "type": "string", "maxLength": 36, "minLength": 36, "nullable": true, "title": "Ид Файл Инф Пол" }, "текст_инф": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_______________4" }, "type": "array", "title": "Текст Инф", "default": [] } }, "type": "object", "title": "ИнфПолФХЖ1Тип" }, "app__schemas__upd_nullable__seller_title_5_01___________2": { "properties": { "иннфл": { "type": "string", "maxLength": 12, "minLength": 12, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}", "nullable": true, "title": "Иннфл" }, "деф_иннфл": { "type": "string", "const": "-", "nullable": true, "title": "Деф Иннфл" }, "св_гос_рег_ип": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Св Гос Рег Ип" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________" } }, "type": "object", "title": "СвИПТип", "description": "Сведения об индивидуальном предпринимателе
• `иннфл`: ИНН
• `деф_иннфл`: ИНН при составлении документа с Функция=СЧФ или Функция=СЧФДОП налоговым агентом, указанным в пунктах 2 и 3 статьи 161 НК РФ, в части информации о продавце/грузоотправителе
• `св_гос_рег_ип`: Реквизиты свидетельства о государственной регистрации индивидуального предпринимателя
• `иные_свед`: Иные сведения, идентифицирующие физическое лицо
• `фио`: Фамилия, имя, отчество" }, "app__schemas__upd_nullable__seller_title_5_01___________3": { "properties": { "гос_рег_ип_выд_дов": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Гос Рег Ип Выд Дов" }, "иннфл": { "type": "string", "maxLength": 12, "minLength": 12, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}", "nullable": true, "title": "Иннфл" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________" } }, "type": "object", "title": "СвФЛТип", "description": "Сведения о физическом лице
• `гос_рег_ип_выд_дов`: Реквизиты свидетельства о государственной регистрации индивидуального предпринимателя, выдавшего доверенность физическому лицу на подписание счета-фактуры
• `иннфл`: ИНН физического лица
• `иные_свед`: Иные сведения, идентифицирующие физическое лицо
• `фио`: Фамилия, имя, отчество" }, "app__schemas__upd_nullable__seller_title_5_01___________3___": { "properties": { "ид_файл_инф_пол": { "type": "string", "maxLength": 36, "minLength": 36, "nullable": true, "title": "Ид Файл Инф Пол" }, "текст_инф": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_______________4" }, "type": "array", "title": "Текст Инф", "default": [] } }, "type": "object", "title": "ИнфПолФХЖ3Тип" }, "app__schemas__upd_nullable__seller_title_5_01____________1": { "properties": { "адр_рф": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01____________2", "nullable": true }, "адр_инф": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_____________2", "nullable": true }, "код_гар": { "type": "string", "maxLength": 36, "minLength": 1, "nullable": true, "title": "Код Гар" } }, "type": "object", "title": "АдресТип", "description": "Сведения об адресе
• `адр_рф`: Адрес, указанный в Едином государственном реестре юридических лиц/почтовый адрес/адрес места жительства индивидуального предпринимателя (реквизиты адреса на территории Российской Федерации)
• `адр_инф`: Адрес, указанный в Едином государственном реестре юридических лиц/почтовый адрес/адрес места жительства индивидуального предпринимателя (информация об адресе, в том числе об адресе за пределами территории Российской Федерации)
• `код_гар`: Уникальный номер адреса объекта адресации в государственном адресном реестре" }, "app__schemas__upd_nullable__seller_title_5_01____________2": { "properties": { "индекс": { "type": "string", "maxLength": 6, "minLength": 6, "pattern": "[0-9]{6}", "nullable": true, "title": "Индекс" }, "код_регион": { "type": "string", "maxLength": 2, "minLength": 2, "pattern": "[0-9]{2}", "nullable": true, "title": "Код Регион" }, "район": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Район" }, "город": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Город" }, "насел_пункт": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Насел Пункт" }, "улица": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Улица" }, "дом": { "type": "string", "maxLength": 20, "minLength": 1, "nullable": true, "title": "Дом" }, "корпус": { "type": "string", "maxLength": 20, "minLength": 1, "nullable": true, "title": "Корпус" }, "кварт": { "type": "string", "maxLength": 20, "minLength": 1, "nullable": true, "title": "Кварт" } }, "type": "object", "title": "АдрРФТип", "description": "Адрес в Российской Федерации
• `индекс`: Индекс
• `код_регион`: Код региона
• `район`: Район
• `город`: Город
• `насел_пункт`: Населенный пункт
• `улица`: Улица
• `дом`: Дом
• `корпус`: Корпус
• `кварт`: Квартира" }, "app__schemas__upd_nullable__seller_title_5_01____________4": { "properties": { "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "осн_довер_фл": { "type": "string", "maxLength": 120, "minLength": 1, "nullable": true, "title": "Осн Довер Фл" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________", "nullable": true } }, "type": "object", "title": "ФЛПерТип" }, "app__schemas__upd_nullable__seller_title_5_01____________5": { "properties": { "сод_опер": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Сод Опер" }, "вид_опер": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Вид Опер" }, "дата_пер": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Пер" }, "дата_нач": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Нач" }, "дата_окон": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Окон" }, "осн_пер": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01________________1" }, "type": "array", "title": "Осн Пер", "default": [] }, "св_лиц_пер": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_______________8", "nullable": true }, "тран_груз": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_______________10", "nullable": true }, "св_пер_вещи": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01________________3", "nullable": true } }, "type": "object", "title": "СвПерТип" }, "app__schemas__upd_nullable__seller_title_5_01_____________1": { "properties": { "наим_орг": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Наим Орг" }, "иннюл": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}", "nullable": true, "title": "Иннюл" }, "деф_иннюл": { "type": "string", "const": "-", "nullable": true, "title": "Деф Иннюл" }, "кпп": { "type": "string", "maxLength": 9, "minLength": 9, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})([0-9]{2})([0-9A-Z]{2})([0-9]{3})", "nullable": true, "title": "Кпп" } }, "type": "object", "title": "СвЮЛУчТип" }, "app__schemas__upd_nullable__seller_title_5_01_____________2": { "properties": { "код_стр": { "type": "string", "maxLength": 3, "minLength": 3, "pattern": "[0-9]{3}", "nullable": true, "title": "Код Стр" }, "адр_текст": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Адр Текст" } }, "type": "object", "title": "АдрИнфТип", "description": "Информация об адресе, в том числе об адресе за пределами территории Российской Федерации
• `код_стр`: Код страны
• `адр_текст`: Адрес" }, "app__schemas__upd_nullable__seller_title_5_01_____________5": { "properties": { "груз_отпр": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_______________2", "nullable": true }, "он_же": { "type": "string", "const": "он же", "nullable": true, "title": "Он Же" } }, "type": "object", "title": "ГрузОтТип" }, "app__schemas__upd_nullable__seller_title_5_01_____________6": { "properties": { "пред_орг_пер": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_________________4", "nullable": true }, "фл_пер": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01____________4", "nullable": true } }, "type": "object", "title": "ИнЛицоТип" }, "app__schemas__upd_nullable__seller_title_5_01______________3": { "properties": { "ном_стр": { "enum": [ "number", "string" ], "decimal_places": 0, "max_digits": 6, "nullable": true, "title": "Ном Стр" }, "наим_тов": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Наим Тов" }, "океи__тов": { "type": "string", "maxLength": 4, "minLength": 3, "pattern": "(?:[0-9]{3})|(?:[0-9]{4})", "nullable": true, "title": "Океи Тов" }, "деф_океи__тов": { "type": "string", "const": "-", "nullable": true, "title": "Деф Океи Тов" }, "кол_тов": { "enum": [ "number", "string" ], "decimal_places": 11, "max_digits": 26, "nullable": true, "title": "Кол Тов" }, "цена_тов": { "enum": [ "number", "string" ], "decimal_places": 11, "max_digits": 26, "nullable": true, "title": "Цена Тов" }, "ст_тов_без_ндс": { "enum": [ "number", "string" ], "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Ст Тов Без Ндс" }, "нал_ст": { "type": "string", "enum": [ "0%", "5%", "7%", "9,09%", "10%", "16,67%", "18,03%", "20%", "22%", "5/105", "7/107", "10/110", "20/120", "22/122", "без НДС", "НДС исчисляется налоговым агентом" ], "nullable": true, "title": "Нал Ст" }, "ст_тов_уч_нал": { "enum": [ "number", "string" ], "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Ст Тов Уч Нал" }, "деф_ст_тов_уч_нал": { "type": "string", "const": "-", "nullable": true, "title": "Деф Ст Тов Уч Нал" }, "акциз": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_______________6", "nullable": true }, "сум_нал": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_____________4", "nullable": true }, "св_тд": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01___________4" }, "type": "array", "title": "Св Тд", "default": [] }, "доп_свед_тов": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_________________1", "nullable": true }, "инф_пол_фхж2": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_______________4" }, "type": "array", "title": "Инф Пол Фхж2", "default": [] } }, "type": "object", "title": "СведТовТип" }, "app__schemas__upd_nullable__seller_title_5_01_______________10": { "properties": { "св_тран_груз": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Св Тран Груз" }, "тран_накл": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_______________9" }, "type": "array", "title": "Тран Накл", "default": [] }, "перевозчик": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_______________2", "nullable": true } }, "type": "object", "title": "ТранГрузТип" }, "app__schemas__upd_nullable__seller_title_5_01_______________11": { "properties": { "функция": { "$ref": "#/components/schemas/UPDFunctionEnum" }, "по_факт_хж": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "По Факт Хж" }, "наим_док_опр": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Док Опр" }, "наим_экон_суб_сост": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Наим Экон Суб Сост" }, "осн_довер_орг_сост": { "type": "string", "maxLength": 120, "minLength": 1, "nullable": true, "title": "Осн Довер Орг Сост" }, "согл_стр_доп_инф": { "type": "string", "maxLength": 14, "minLength": 14, "nullable": true, "title": "Согл Стр Доп Инф" }, "св_сч_факт": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_______________5" }, "табл_сч_факт": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_________________2", "nullable": true }, "св_прод_пер": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01________________4", "nullable": true }, "подписант": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01________________5" }, "type": "array", "title": "Подписант", "default": [] } }, "type": "object", "title": "ДокументТип" }, "app__schemas__upd_nullable__seller_title_5_01_______________2": { "properties": { "окпо": { "type": "string", "maxLength": 10, "minLength": 1, "nullable": true, "title": "Окпо" }, "структ_подр": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Структ Подр" }, "инф_для_участ": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Инф Для Участ" }, "кратк_назв": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Кратк Назв" }, "ид_св": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01___________1" }, "адрес": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01____________1", "nullable": true }, "контакт": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01______________1", "nullable": true }, "банк_рекв": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_______________1", "nullable": true } }, "type": "object", "title": "УчастникТип", "description": "Сведения об участнике факта хозяйственной жизни
• `окпо`: Код в общероссийском классификаторе предприятий и организаций
• `структ_подр`: Структурное подразделение
• `инф_для_участ`: Информация для участника документооборота
• `кратк_назв`: Краткое название
• `ид_св`: Идентификационные сведения
• `адрес`: Адрес
• `контакт`: Контактные данные
• `банк_рекв`: Банковские реквизиты" }, "app__schemas__upd_nullable__seller_title_5_01_______________3": { "properties": { "наим_орг": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Наим Орг" }, "идентиф": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Идентиф" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" } }, "type": "object", "title": "СвИнНеУчТип" }, "app__schemas__upd_nullable__seller_title_5_01_______________4": { "properties": { "идентиф": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Идентиф" }, "значен": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Значен" } }, "type": "object", "title": "ТекстИнфТип", "description": "Текстовая информация
• `идентиф`: Идентификатор
• `значен`: Значение" }, "app__schemas__upd_nullable__seller_title_5_01_______________5": { "properties": { "номер_сч_ф": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Номер Сч Ф" }, "дата_сч_ф": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Сч Ф" }, "код_окв": { "type": "string", "maxLength": 3, "minLength": 3, "pattern": "[0-9]{3}", "nullable": true, "title": "Код Окв" }, "испр_сч_ф": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01______________2", "nullable": true }, "св_прод": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_______________2" }, "type": "array", "title": "Св Прод", "default": [] }, "груз_от": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_____________5" }, "type": "array", "title": "Груз От", "default": [] }, "груз_получ": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_______________2" }, "type": "array", "title": "Груз Получ", "default": [] }, "св_прд": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03____________4" }, "type": "array", "title": "Св Прд", "default": [] }, "св_покуп": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_______________2" }, "type": "array", "title": "Св Покуп", "default": [] }, "доп_св_фхж1": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01__________1___", "nullable": true }, "док_подтв_отгр": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_________________" }, "type": "array", "title": "Док Подтв Отгр", "default": [] }, "инф_пол_фхж1": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01___________1___", "nullable": true } }, "type": "object", "title": "СвСчФактТип" }, "app__schemas__upd_nullable__seller_title_5_01_______________7": { "properties": { "ст_тов_без_ндс_всего": { "enum": [ "number", "string" ], "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Ст Тов Без Ндс Всего" }, "ст_тов_уч_нал_всего": { "enum": [ "number", "string" ], "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Ст Тов Уч Нал Всего" }, "деф_ст_тов_уч_нал_всего": { "type": "string", "const": "-", "nullable": true, "title": "Деф Ст Тов Уч Нал Всего" }, "сум_нал_всего": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_____________4", "nullable": true }, "кол_нетто_вс": { "enum": [ "number", "string" ], "decimal_places": 11, "max_digits": 26, "nullable": true, "title": "Кол Нетто Вс" } }, "type": "object", "title": "ВсегоОплТип" }, "app__schemas__upd_nullable__seller_title_5_01_______________8": { "properties": { "раб_орг_прод": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_________________3", "nullable": true }, "ин_лицо": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_____________6", "nullable": true } }, "type": "object", "title": "СвЛицПерТип" }, "app__schemas__upd_nullable__seller_title_5_01_______________9": { "properties": { "ном_тран_накл": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Ном Тран Накл" }, "дата_тран_накл": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Тран Накл" } }, "type": "object", "title": "ТранНаклТип" }, "app__schemas__upd_nullable__seller_title_5_01________________1": { "properties": { "наим_осн": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Осн" }, "ном_осн": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Ном Осн" }, "дата_осн": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Осн" }, "доп_св_осн": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Доп Св Осн" }, "идент_осн": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Идент Осн" } }, "type": "object", "title": "ОснованиеТип", "description": "Основание отгрузки (передачи, уступки)
• `наим_осн`: Наименование документа - основания
• `ном_осн`: Номер документа - основания
• `дата_осн`: Дата документа - основания
• `доп_св_осн`: Дополнительные сведения
• `идент_осн`: Идентификатор документа - основания" }, "app__schemas__upd_nullable__seller_title_5_01________________2": { "properties": { "наим_орг": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Наим Орг" }, "иннюл": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}", "nullable": true, "title": "Иннюл" }, "ид_эдо": { "type": "string", "maxLength": 3, "minLength": 3, "nullable": true, "title": "Ид Эдо" } }, "type": "object", "title": "СвОЭДОтпрТип" }, "app__schemas__upd_nullable__seller_title_5_01________________4": { "properties": { "св_пер": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01____________5" }, "инф_пол_фхж3": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01___________3___", "nullable": true } }, "type": "object", "title": "СвПродПерТип" }, "app__schemas__upd_nullable__seller_title_5_01________________5": { "properties": { "обл_полн": { "type": "string", "enum": [ "0", "1", "2", "3", "4", "5", "6" ], "nullable": true, "title": "Обл Полн" }, "статус": { "type": "string", "enum": [ "1", "2", "3", "4" ], "nullable": true, "title": "Статус" }, "осн_полн": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Осн Полн" }, "осн_полн_орг": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Осн Полн Орг" }, "фл": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01___________3", "nullable": true }, "ип": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01___________2", "nullable": true }, "юл": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_______", "nullable": true } }, "type": "object", "title": "ПодписантТип" }, "app__schemas__upd_nullable__seller_title_5_01_________________": { "properties": { "наим_док_отгр": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Док Отгр" }, "ном_док_отгр": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Ном Док Отгр" }, "дата_док_отгр": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Док Отгр" } }, "type": "object", "title": "ДокПодтвОтгрТип" }, "app__schemas__upd_nullable__seller_title_5_01_________________1": { "properties": { "пр_тов_раб": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "nullable": true, "title": "Пр Тов Раб" }, "доп_призн": { "type": "string", "maxLength": 4, "minLength": 1, "nullable": true, "title": "Доп Призн" }, "наим_ед_изм": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Ед Изм" }, "кр_наим_стр_пр": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Кр Наим Стр Пр" }, "надл_отп": { "enum": [ "number", "string" ], "decimal_places": 11, "max_digits": 26, "nullable": true, "title": "Надл Отп" }, "характер_тов": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Характер Тов" }, "сорт_тов": { "type": "string", "maxLength": 10, "minLength": 1, "nullable": true, "title": "Сорт Тов" }, "артикул_тов": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Артикул Тов" }, "код_тов": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Код Тов" }, "код_кат": { "type": "string", "maxLength": 27, "minLength": 27, "nullable": true, "title": "Код Кат" }, "код_вид_тов": { "type": "string", "maxLength": 10, "minLength": 10, "nullable": true, "title": "Код Вид Тов" }, "свед_прослеж": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01__________________2" }, "type": "array", "title": "Свед Прослеж", "default": [] }, "ном_сред_идент_тов": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01____________________" }, "type": "array", "title": "Ном Сред Идент Тов", "default": [] } }, "type": "object", "title": "ДопСведТовТип" }, "app__schemas__upd_nullable__seller_title_5_01_________________2": { "properties": { "свед_тов": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01______________3" }, "type": "array", "title": "Свед Тов", "default": [] }, "всего_опл": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_______________7" } }, "type": "object", "title": "ТаблСчФактТип" }, "app__schemas__upd_nullable__seller_title_5_01_________________3": { "properties": { "должность": { "type": "string", "maxLength": 128, "minLength": 1, "nullable": true, "title": "Должность" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "осн_полн": { "type": "string", "maxLength": 120, "minLength": 1, "nullable": true, "title": "Осн Полн" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________", "nullable": true } }, "type": "object", "title": "РабОргПродТип" }, "app__schemas__upd_nullable__seller_title_5_01_________________4": { "properties": { "должность": { "type": "string", "maxLength": 128, "minLength": 1, "nullable": true, "title": "Должность" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "наим_орг_пер": { "type": "string", "maxLength": 128, "minLength": 1, "nullable": true, "title": "Наим Орг Пер" }, "осн_довер_орг_пер": { "type": "string", "maxLength": 120, "minLength": 1, "nullable": true, "title": "Осн Довер Орг Пер" }, "осн_полн_пред_пер": { "type": "string", "maxLength": 120, "minLength": 1, "nullable": true, "title": "Осн Полн Пред Пер" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________", "nullable": true } }, "type": "object", "title": "ПредОргПерТип" }, "app__schemas__upd_nullable__seller_title_5_01__________________1": { "properties": { "ид_отпр": { "type": "string", "maxLength": 46, "minLength": 4, "nullable": true, "title": "Ид Отпр" }, "ид_пол": { "type": "string", "maxLength": 46, "minLength": 4, "nullable": true, "title": "Ид Пол" }, "св_оэд_отпр": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01________________2", "nullable": true } }, "type": "object", "title": "СвУчДокОборТип" }, "app__schemas__upd_nullable__seller_title_5_01__________________2": { "properties": { "ном_тов_прослеж": { "type": "string", "maxLength": 29, "minLength": 1, "nullable": true, "title": "Ном Тов Прослеж" }, "ед_изм_прослеж": { "type": "string", "maxLength": 4, "minLength": 3, "pattern": "(?:[0-9]{3})|(?:[0-9]{4})", "nullable": true, "title": "Ед Изм Прослеж" }, "наим_ед_изм_прослеж": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Ед Изм Прослеж" }, "кол_в_ед_прослеж": { "enum": [ "number", "string" ], "decimal_places": 11, "max_digits": 26, "nullable": true, "title": "Кол В Ед Прослеж" }, "доп_прослеж": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Доп Прослеж" } }, "type": "object", "title": "СведПрослежТип" }, "app__schemas__upd_nullable__seller_title_5_01______________________": { "properties": { "дата_гос_конт": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Гос Конт" }, "номер_гос_конт": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Номер Гос Конт" }, "лиц_счет_прод": { "type": "string", "maxLength": 11, "minLength": 11, "nullable": true, "title": "Лиц Счет Прод" }, "код_прод_бюдж_класс": { "type": "string", "maxLength": 20, "minLength": 20, "nullable": true, "title": "Код Прод Бюдж Класс" }, "код_цели_прод": { "type": "string", "maxLength": 20, "minLength": 20, "nullable": true, "title": "Код Цели Прод" }, "код_казнач_прод": { "type": "string", "maxLength": 4, "minLength": 1, "nullable": true, "title": "Код Казнач Прод" }, "наим_казнач_прод": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Наим Казнач Прод" } }, "type": "object", "title": "ИнфПродГосЗакКазнТип" }, "app__schemas__upd_nullable__seller_title_5_03__________1___": { "properties": { "ид_гос_кон": { "type": "string", "maxLength": 25, "minLength": 0, "nullable": true, "title": "Ид Гос Кон" }, "сп_обст_фсчф": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6" ], "nullable": true, "title": "Сп Обст Фсчф" }, "сп_обст_фсчфдоп": { "type": "string", "maxLength": 5, "minLength": 5, "nullable": true, "title": "Сп Обст Фсчфдоп" }, "сп_обст_фдоп": { "type": "string", "maxLength": 5, "minLength": 5, "nullable": true, "title": "Сп Обст Фдоп" }, "вид_обяз": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03______________6" }, "type": "array", "title": "Вид Обяз", "default": [] }, "инф_прод_за_госк_казн": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03______________________", "nullable": true }, "св_фактор": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03_______________2", "nullable": true }, "осн_уст_ден_треб": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03______________4", "nullable": true }, "сопр_док_фхж": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03______________4" }, "type": "array", "title": "Сопр Док Фхж", "default": [] } }, "type": "object", "title": "ДопСвФХЖ1Тип" }, "app__schemas__upd_nullable__seller_title_5_03___________1": { "properties": { "св_ип": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03___________2", "nullable": true }, "св_юл_уч": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03_____________1", "nullable": true }, "св_ин_не_уч": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_03_______________1", "nullable": true }, "св_фл_уч": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03_____________2", "nullable": true } }, "type": "object", "title": "ИдСвТип" }, "app__schemas__upd_nullable__seller_title_5_03___________1___": { "properties": { "ид_файл_инф_пол": { "type": "string", "maxLength": 36, "minLength": 36, "nullable": true, "title": "Ид Файл Инф Пол" }, "текст_инф": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_______________4" }, "type": "array", "title": "Текст Инф", "default": [] } }, "type": "object", "title": "ИнфПолФХЖ1Тип" }, "app__schemas__upd_nullable__seller_title_5_03___________2": { "properties": { "иннфл": { "type": "string", "maxLength": 12, "minLength": 12, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}", "nullable": true, "title": "Иннфл" }, "св_гос_рег_ип": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Св Гос Рег Ип" }, "огрнип": { "type": "string", "maxLength": 15, "minLength": 15, "pattern": "[0-9]{15}", "nullable": true, "title": "Огрнип" }, "дата_огрнип": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Огрнип" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________" } }, "type": "object", "title": "СвИПТип" }, "app__schemas__upd_nullable__seller_title_5_03___________3___": { "properties": { "ид_файл_инф_пол": { "type": "string", "maxLength": 36, "minLength": 36, "nullable": true, "title": "Ид Файл Инф Пол" }, "текст_инф": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_______________4" }, "type": "array", "title": "Текст Инф", "default": [] } }, "type": "object", "title": "ИнфПолФХЖ3Тип" }, "app__schemas__upd_nullable__seller_title_5_03____________1": { "properties": { "тип": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Тип" }, "номер": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Номер" } }, "type": "object", "title": "НомерТип", "description": "Сведения о номере адресного элемента
• `тип`: Тип элемента
• `номер`: Номер элемента" }, "app__schemas__upd_nullable__seller_title_5_03____________2": { "properties": { "глн_места": { "type": "string", "maxLength": 13, "minLength": 13, "nullable": true, "title": "Глн Места" }, "адр_рф": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03____________3", "nullable": true }, "адр_гар": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03_____________3", "nullable": true }, "адр_инф": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03_____________4", "nullable": true } }, "type": "object", "title": "АдресТип", "description": "Сведения об адресе (месте нахождения)
• `глн_места`: Глобальный номер места нахождения (GLN места)
• `адр_рф`: Адрес, указанный в Едином государственном реестре юридических лиц/почтовый адрес/адрес регистрации по месту жительства (по месту пребывания) индивидуального предпринимателя, указанный в Едином государственном реестре индивидуальных предпринимателей (реквизиты адреса на территории Российской Федерации)
• `адр_гар`: Адрес в соответствии с государственным адресным реестром, указанный в Едином государственном реестре юридических лиц/почтовый адрес/адрес места жительстварегистрации по месту жительства (по месту пребывания) индивидуального предпринимателя, указанный в Едином государственном реестре индивидуальных предпринимателей (реквизиты адреса на территории Российской Федерации)
• `адр_инф`: Адрес, указанный в Едином государственном реестре юридических лиц/почтовый адрес/адрес места жительстварегистрации по месту жительства (по месту пребывания) индивидуального предпринимателя, указанный в Едином государственном реестре индивидуальных предпринимателей (информация об адресе, в том числе об адресе за пределами территории Российской Федерации)" }, "app__schemas__upd_nullable__seller_title_5_03____________3": { "properties": { "индекс": { "type": "string", "maxLength": 6, "minLength": 6, "pattern": "[0-9]{6}", "nullable": true, "title": "Индекс" }, "код_регион": { "type": "string", "maxLength": 2, "minLength": 2, "pattern": "[0-9]{2}", "nullable": true, "title": "Код Регион" }, "наим_регион": { "type": "string", "maxLength": 51, "minLength": 1, "nullable": true, "title": "Наим Регион" }, "район": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Район" }, "город": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Город" }, "насел_пункт": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Насел Пункт" }, "улица": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Улица" }, "дом": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Дом" }, "корпус": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Корпус" }, "кварт": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Кварт" }, "иные_свед": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Иные Свед" } }, "type": "object", "title": "АдрРФТип", "description": "Сведения об адресе в Российской Федерации, содержащиеся в ЕГРЮЛ
• `индекс`: Почтовый индекс
• `код_регион`: Код субъекта Российской Федерации
• `наим_регион`: Наименование субъекта Российской Федерации
• `район`: Район
• `город`: Город
• `насел_пункт`: Населенный пункт
• `улица`: Улица
• `дом`: Дом
• `корпус`: Корпус
• `кварт`: Квартира
• `иные_свед`: Иные сведения об адресе в Российской Федерации" }, "app__schemas__upd_nullable__seller_title_5_03____________5": { "properties": { "иннфл_пер": { "type": "string", "maxLength": 12, "minLength": 0, "pattern": "[0-9]{0,12}", "nullable": true, "title": "Иннфл Пер" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "осн_довер_фл": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03______________4", "nullable": true }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________", "nullable": true } }, "type": "object", "title": "ФЛПерТип" }, "app__schemas__upd_nullable__seller_title_5_03____________6": { "properties": { "сод_опер": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Сод Опер" }, "вид_опер": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Вид Опер" }, "дата_пер": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Пер" }, "дата_нач_пер": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Нач Пер" }, "дата_окон_пер": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Окон Пер" }, "осн_пер": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03______________4" }, "type": "array", "title": "Осн Пер", "default": [] }, "без_док_осн_пер": { "type": "string", "const": "1", "nullable": true, "title": "Без Док Осн Пер" }, "св_лиц_пер": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03_______________8", "nullable": true }, "тран": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03___________4", "nullable": true }, "св_пер_вещи": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03________________3", "nullable": true } }, "type": "object", "title": "СвПерТип" }, "app__schemas__upd_nullable__seller_title_5_03_____________1": { "properties": { "наим_орг": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Наим Орг" }, "иннюл": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}", "nullable": true, "title": "Иннюл" }, "кпп": { "type": "string", "maxLength": 9, "minLength": 9, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})([0-9]{2})([0-9A-Z]{2})([0-9]{3})", "nullable": true, "title": "Кпп" } }, "type": "object", "title": "СвЮЛУчТип" }, "app__schemas__upd_nullable__seller_title_5_03_____________2": { "properties": { "иннфл": { "type": "string", "maxLength": 12, "minLength": 12, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}", "nullable": true, "title": "Иннфл" }, "ид_стат_л": { "type": "string", "enum": [ "0", "1" ], "nullable": true, "title": "Ид Стат Л" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________", "nullable": true } }, "type": "object", "title": "СвФЛУчТип" }, "app__schemas__upd_nullable__seller_title_5_03_____________3": { "properties": { "ид_ном": { "type": "string", "maxLength": 36, "minLength": 36, "nullable": true, "title": "Ид Ном" }, "индекс": { "type": "string", "maxLength": 6, "minLength": 6, "nullable": true, "title": "Индекс" }, "регион": { "type": "string", "maxLength": 2, "minLength": 2, "pattern": "[0-9]{2}", "nullable": true, "title": "Регион" }, "наим_регион": { "type": "string", "maxLength": 51, "minLength": 1, "nullable": true, "title": "Наим Регион" }, "муницип_район": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03_________________1", "nullable": true }, "город_сел_поселен": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03_________________1", "nullable": true }, "населен_пункт": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03______________3", "nullable": true }, "эл_план_структур": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03______________1", "nullable": true }, "эл_ул_дор_сети": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03______________1", "nullable": true }, "земел_участок": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Земел Участок" }, "здание": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03____________1" }, "type": "array", "title": "Здание", "default": [] }, "помещ_здания": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03____________1", "nullable": true }, "помещ_квартиры": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03____________1", "nullable": true } }, "type": "object", "title": "АдрГАРТип", "description": "Адрес в соответствии с государственным адресным реестром
• `ид_ном`: Уникальный номер адреса объекта адресации в государственном адресном реестре
• `индекс`: Почтовый индекс
• `регион`: Субъект Российской Федерации (код)
• `наим_регион`: Наименование субъекта Российской Федерации
• `муницип_район`: Муниципальный район/ городской округ/ внутригородская территория города федерального значения/ муниципальный округ/ федеральная территория
• `город_сел_поселен`: Городское поселение/ сельское поселение/ межселенная территория в составе муниципального района/ внутригородской район городского округа
• `населен_пункт`: Населенный пункт (город, деревня, село и прочее)
• `эл_план_структур`: Элемент планировочной структуры
• `эл_ул_дор_сети`: Элемент улично-дорожной сети
• `земел_участок`: Земельный участок (номер)
• `здание`: Здание (строение), сооружение/ объект незавершенного строительства
• `помещ_здания`: Помещение в пределах здания (строения), сооружения/ машино-место
• `помещ_квартиры`: Помещение в пределах квартиры" }, "app__schemas__upd_nullable__seller_title_5_03_____________4": { "properties": { "код_стр": { "type": "string", "maxLength": 3, "minLength": 3, "pattern": "[0-9]{3}", "nullable": true, "title": "Код Стр" }, "наим_стран": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Стран" }, "адр_текст": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Адр Текст" } }, "type": "object", "title": "АдрИнфТип", "description": "Информация об адресе, в том числе об адресе за пределами территории Российской Федерации
• `код_стр`: Код страны
• `наим_стран`: Наименование страны
• `адр_текст`: Адрес" }, "app__schemas__upd_nullable__seller_title_5_03_____________7": { "properties": { "груз_отпр": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03_______________2", "nullable": true }, "он_же": { "type": "string", "const": "он же", "nullable": true, "title": "Он Же" } }, "type": "object", "title": "ГрузОтТип" }, "app__schemas__upd_nullable__seller_title_5_03_____________8": { "properties": { "код_окв": { "type": "string", "maxLength": 3, "minLength": 3, "pattern": "[0-9]{3}", "nullable": true, "title": "Код Окв" }, "наим_окв": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Наим Окв" }, "курс_вал": { "enum": [ "number", "string" ], "decimal_places": 4, "max_digits": 10, "nullable": true, "title": "Курс Вал" } }, "type": "object", "title": "ДенИзмТип" }, "app__schemas__upd_nullable__seller_title_5_03_____________9": { "properties": { "пред_орг_пер": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03_________________6", "nullable": true }, "фл_пер": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03____________5", "nullable": true } }, "type": "object", "title": "ИнЛицоТип" }, "app__schemas__upd_nullable__seller_title_5_03______________1": { "properties": { "тип": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Тип" }, "наим": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим" } }, "type": "object", "title": "ТипНаимТип", "description": "Сведения о типе и наименовании адресного элемента
• `тип`: Тип элемента
• `наим`: Наименование элемента" }, "app__schemas__upd_nullable__seller_title_5_03______________3": { "properties": { "вид": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Вид" }, "наим": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим" } }, "type": "object", "title": "ВидНаимТип", "description": "Сведения о виде и наименовании адресного элемента
• `вид`: Вид элемента
• `наим`: Наименование элемента" }, "app__schemas__upd_nullable__seller_title_5_03______________4": { "properties": { "рекв_наим_док": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Рекв Наим Док" }, "рекв_номер_док": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Рекв Номер Док" }, "рекв_дата_док": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Рекв Дата Док" }, "рекв_ид_файл_док": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Рекв Ид Файл Док" }, "рекв_ид_док": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Рекв Ид Док" }, "р_ид_сист_хран_д": { "type": "string", "maxLength": 500, "minLength": 1, "nullable": true, "title": "Р Ид Сист Хран Д" }, "рекв_урл_сист_док": { "type": "string", "maxLength": 500, "minLength": 1, "nullable": true, "title": "Рекв Урл Сист Док" }, "рекв_доп_свед_док": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Рекв Доп Свед Док" }, "рекв_ид_рек_сост": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_03________________1" }, "type": "array", "title": "Рекв Ид Рек Сост", "default": [] } }, "type": "object", "title": "РеквДокТип", "description": "Реквизиты документа
• `рекв_наим_док`: Наименование документа
• `рекв_номер_док`: Номер документа
• `рекв_дата_док`: Дата документа
• `рекв_ид_файл_док`: Идентификатор файла обмена документа, подписанного первой стороной
• `рекв_ид_док`: Идентификатор документа
• `р_ид_сист_хран_д`: Идентифицирующая информация об информационной системе, в которой осуществляется хранение документа, необходимая для запроса информации из информационной системы
• `рекв_урл_сист_док`: Сведения в формате URL об информационной системе, которая предоставляет техническую возможность получения информации о документе
• `рекв_доп_свед_док`: Дополнительные сведения
• `рекв_ид_рек_сост`: Идентифицирующие реквизиты экономических субъектов, составивших (сформировавших) документ" }, "app__schemas__upd_nullable__seller_title_5_03______________5": { "properties": { "ном_испр": { "enum": [ "number", "string" ], "decimal_places": 0, "max_digits": 3, "nullable": true, "title": "Ном Испр" }, "дата_испр": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Испр" } }, "type": "object", "title": "ИспрДокТип" }, "app__schemas__upd_nullable__seller_title_5_03______________7": { "properties": { "ном_стр": { "enum": [ "number", "string" ], "decimal_places": 0, "max_digits": 6, "nullable": true, "title": "Ном Стр" }, "наим_тов": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Наим Тов" }, "океи__тов": { "type": "string", "maxLength": 4, "minLength": 3, "pattern": "(?:[0-9]{3})|(?:[0-9]{4})", "nullable": true, "title": "Океи Тов" }, "наим_ед_изм": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Ед Изм" }, "кол_тов": { "enum": [ "number", "string" ], "decimal_places": 11, "max_digits": 26, "nullable": true, "title": "Кол Тов" }, "цена_тов": { "enum": [ "number", "string" ], "decimal_places": 11, "max_digits": 26, "nullable": true, "title": "Цена Тов" }, "ст_тов_без_ндс": { "enum": [ "number", "string" ], "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Ст Тов Без Ндс" }, "нал_ст": { "type": "string", "enum": [ "0%", "5%", "7%", "9,09%", "10%", "16,67%", "18%", "18,03%", "20%", "22%", "5/105", "7/107", "10/110", "18/118", "20/120", "22/122", "без НДС", "НДС исчисляется налоговым агентом" ], "nullable": true, "title": "Нал Ст" }, "ст_тов_уч_нал": { "enum": [ "number", "string" ], "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Ст Тов Уч Нал" }, "св_дт": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03___________3" }, "type": "array", "title": "Св Дт", "default": [] }, "доп_свед_тов": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03_________________3", "nullable": true }, "акциз": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_______________6", "nullable": true }, "сум_нал": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_____________6", "nullable": true }, "инф_пол_фхж2": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_______________4" }, "type": "array", "title": "Инф Пол Фхж2", "default": [] } }, "type": "object", "title": "СведТовТип" }, "app__schemas__upd_nullable__seller_title_5_03_______________2": { "properties": { "окпо": { "type": "string", "maxLength": 10, "minLength": 1, "nullable": true, "title": "Окпо" }, "код_опф": { "type": "string", "maxLength": 5, "minLength": 2, "nullable": true, "title": "Код Опф" }, "полн_наим_опф": { "type": "string", "maxLength": 255, "minLength": 4, "nullable": true, "title": "Полн Наим Опф" }, "структ_подр": { "type": "string", "maxLength": 500, "minLength": 1, "nullable": true, "title": "Структ Подр" }, "инф_для_участ": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Инф Для Участ" }, "сокр_наим": { "type": "string", "maxLength": 510, "minLength": 1, "nullable": true, "title": "Сокр Наим" }, "ид_св": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03___________1" }, "адрес": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03____________2", "nullable": true }, "банк_рекв": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_______________1", "nullable": true }, "контакт": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03______________2", "nullable": true } }, "type": "object", "title": "УчастникТип", "description": "Сведения об участнике факта хозяйственной жизни
• `окпо`: Код в общероссийском классификаторе предприятий и организаций
• `код_опф`: Код по Общероссийскому классификатору организационно-правовых форм об организационно-правовой форме
• `полн_наим_опф`: Полное наименование организационно-правовой формы
• `структ_подр`: Структурное подразделение
• `инф_для_участ`: Информация для участника документооборота
• `сокр_наим`: Сокращенное наименование
• `ид_св`: Идентификационные сведения
• `адрес`: Адрес
• `банк_рекв`: Банковские реквизиты
• `контакт`: Контактные данные" }, "app__schemas__upd_nullable__seller_title_5_03_______________5": { "properties": { "номер_док": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Номер Док" }, "дата_док": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Док" }, "имя_файл_испр_прод": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Имя Файл Испр Прод" }, "имя_файл_испр_пок": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Имя Файл Испр Пок" }, "испр_док": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03______________5", "nullable": true }, "св_прод": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03_______________2" }, "type": "array", "title": "Св Прод", "default": [] }, "груз_от": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03_____________7" }, "type": "array", "title": "Груз От", "default": [] }, "груз_получ": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03_______________2" }, "type": "array", "title": "Груз Получ", "default": [] }, "св_прд": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03____________4" }, "type": "array", "title": "Св Прд", "default": [] }, "док_подтв_отгр_ном": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03______________4" }, "type": "array", "title": "Док Подтв Отгр Ном", "default": [] }, "св_покуп": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03_______________2" }, "type": "array", "title": "Св Покуп", "default": [] }, "ден_изм": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03_____________8" }, "доп_св_фхж1": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03__________1___", "nullable": true }, "инф_пол_фхж1": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03___________1___", "nullable": true } }, "type": "object", "title": "СвСчФактТип" }, "app__schemas__upd_nullable__seller_title_5_03_______________7": { "properties": { "ст_тов_без_ндс_всего": { "enum": [ "number", "string" ], "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Ст Тов Без Ндс Всего" }, "ст_тов_уч_нал_всего": { "enum": [ "number", "string" ], "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Ст Тов Уч Нал Всего" }, "кол_нетто_вс": { "enum": [ "number", "string" ], "decimal_places": 11, "max_digits": 26, "nullable": true, "title": "Кол Нетто Вс" }, "сум_нал_всего": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_____________6", "nullable": true } }, "type": "object", "title": "ВсегоОплТип" }, "app__schemas__upd_nullable__seller_title_5_03_______________8": { "properties": { "раб_орг_прод": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03_________________5", "nullable": true }, "ин_лицо": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03_____________9", "nullable": true } }, "type": "object", "title": "СвЛицПерТип" }, "app__schemas__upd_nullable__seller_title_5_03_______________9": { "properties": { "уид": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Уид" }, "функция": { "$ref": "#/components/schemas/UPDFunctionEnum", "nullable": true }, "по_факт_хж": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "По Факт Хж" }, "наим_док_опр": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Док Опр" }, "наим_экон_суб_сост": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Наим Экон Суб Сост" }, "согл_стр_доп_инф": { "type": "string", "maxLength": 14, "minLength": 14, "nullable": true, "title": "Согл Стр Доп Инф" }, "св_сч_факт": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03_______________5" }, "табл_сч_факт": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03_________________4", "nullable": true }, "св_прод_пер": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03________________4", "nullable": true }, "подписант": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03________________6" }, "type": "array", "title": "Подписант", "default": [] }, "осн_довер_орг_сост": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03______________4", "nullable": true } }, "type": "object", "title": "ДокументТип" }, "app__schemas__upd_nullable__seller_title_5_03________________": { "properties": { "ном_тов_прослеж": { "type": "string", "maxLength": 29, "minLength": 25, "nullable": true, "title": "Ном Тов Прослеж" }, "ед_изм_прослеж": { "type": "string", "maxLength": 4, "minLength": 3, "pattern": "(?:[0-9]{3})|(?:[0-9]{4})", "nullable": true, "title": "Ед Изм Прослеж" }, "наим_ед_изм_прослеж": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Ед Изм Прослеж" }, "кол_в_ед_прослеж": { "enum": [ "number", "string" ], "decimal_places": 11, "max_digits": 26, "nullable": true, "title": "Кол В Ед Прослеж" }, "ст_тов_без_ндс_прослеж": { "enum": [ "number", "string" ], "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Ст Тов Без Ндс Прослеж" }, "доп_инф_прослеж": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Доп Инф Прослеж" } }, "type": "object", "title": "СведПрослежТип" }, "app__schemas__upd_nullable__seller_title_5_03________________2": { "properties": { "наим_гос_сист": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Гос Сист" }, "учет_ед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Учет Ед" }, "иная_инф": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Иная Инф" }, "ид_ном_учет_ед": { "items": { "type": "string", "maxLength": 255, "minLength": 1 }, "type": "array", "title": "Ид Ном Учет Ед", "default": [] } }, "type": "object", "title": "СвГосСистТип" }, "app__schemas__upd_nullable__seller_title_5_03________________3": { "properties": { "дата_пер_вещ": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Пер Вещ" }, "св_пер_вещ": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Св Пер Вещ" }, "док_пер_вещ": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03______________4", "nullable": true } }, "type": "object", "title": "СвПерВещиТип" }, "app__schemas__upd_nullable__seller_title_5_03________________4": { "properties": { "св_пер": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03____________6" }, "инф_пол_фхж3": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03___________3___", "nullable": true } }, "type": "object", "title": "СвПродПерТип" }, "app__schemas__upd_nullable__seller_title_5_03________________6": { "properties": { "должн": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Должн" }, "тип_подпис": { "type": "string", "enum": [ "1", "2", "3" ], "nullable": true, "title": "Тип Подпис" }, "дата_под_док": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Под Док" }, "спос_подт_полном": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6" ], "nullable": true, "title": "Спос Подт Полном" }, "доп_свед_подп": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Доп Свед Подп" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________", "nullable": true }, "св_довер_эл": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_03________________4" }, "type": "array", "title": "Св Довер Эл", "default": [] }, "св_довер_бум": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_03_________________2" }, "type": "array", "title": "Св Довер Бум", "default": [] } }, "type": "object", "title": "ПодписантТип" }, "app__schemas__upd_nullable__seller_title_5_03_________________1": { "properties": { "вид_код": { "type": "string", "maxLength": 1, "minLength": 1, "nullable": true, "title": "Вид Код" }, "наим": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим" } }, "type": "object", "title": "ВидНаимКодТип", "description": "Сведения о виде (коде) и наименовании адресного элемента
• `вид_код`: Вид (код) элемента
• `наим`: Наименование элемента" }, "app__schemas__upd_nullable__seller_title_5_03_________________2": { "properties": { "ам_группа": { "type": "string", "maxLength": 2, "minLength": 1, "nullable": true, "title": "Ам Группа" }, "код_окоф": { "type": "string", "maxLength": 16, "minLength": 1, "nullable": true, "title": "Код Окоф" }, "ср_пол_исп_ос": { "type": "string", "maxLength": 3, "minLength": 1, "nullable": true, "title": "Ср Пол Исп Ос" }, "факт_срок_исп": { "enum": [ "number", "string" ], "decimal_places": 0, "max_digits": 3, "nullable": true, "title": "Факт Срок Исп" } }, "type": "object", "title": "НалУчАмортТип" }, "app__schemas__upd_nullable__seller_title_5_03_________________3": { "properties": { "пр_тов_раб": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "nullable": true, "title": "Пр Тов Раб" }, "доп_призн": { "type": "string", "maxLength": 4, "minLength": 1, "nullable": true, "title": "Доп Призн" }, "надл_отп": { "enum": [ "number", "string" ], "decimal_places": 11, "max_digits": 26, "nullable": true, "title": "Надл Отп" }, "характер_тов": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Характер Тов" }, "сорт_тов": { "type": "string", "maxLength": 10, "minLength": 1, "nullable": true, "title": "Сорт Тов" }, "серия_тов": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Серия Тов" }, "артикул_тов": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Артикул Тов" }, "код_тов": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Код Тов" }, "гтин": { "type": "string", "maxLength": 14, "minLength": 14, "nullable": true, "title": "Гтин" }, "код_кат": { "type": "string", "maxLength": 27, "minLength": 27, "nullable": true, "title": "Код Кат" }, "код_вид_тов": { "type": "string", "maxLength": 10, "minLength": 10, "nullable": true, "title": "Код Вид Тов" }, "код_вид_пр": { "enum": [ "number", "string" ], "decimal_places": 0, "max_digits": 3, "nullable": true, "title": "Код Вид Пр" }, "код_тов_окпд2": { "type": "string", "maxLength": 12, "minLength": 2, "nullable": true, "title": "Код Тов Окпд2" }, "доп_инф_п_вид_о": { "type": "string", "maxLength": 5, "minLength": 5, "nullable": true, "title": "Доп Инф П Вид О" }, "кр_наим_стр_пр": { "items": { "type": "string", "maxLength": 255, "minLength": 1 }, "type": "array", "title": "Кр Наим Стр Пр", "default": [] }, "сопр_док_тов": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03______________4" }, "type": "array", "title": "Сопр Док Тов", "default": [] }, "нал_уч_аморт": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03_________________2", "nullable": true }, "сум_нал_восст": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_____________6", "nullable": true }, "свед_прослеж": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03________________" }, "type": "array", "title": "Свед Прослеж", "default": [] }, "ном_сред_идент_тов": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03____________________" }, "type": "array", "title": "Ном Сред Идент Тов", "default": [] }, "св_гос_сист": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03________________2" }, "type": "array", "title": "Св Гос Сист", "default": [] } }, "type": "object", "title": "ДопСведТовТип" }, "app__schemas__upd_nullable__seller_title_5_03_________________4": { "properties": { "свед_тов": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03______________7" }, "type": "array", "title": "Свед Тов", "default": [] }, "всего_опл": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03_______________7" } }, "type": "object", "title": "ТаблСчФактТип" }, "app__schemas__upd_nullable__seller_title_5_03_________________5": { "properties": { "должность": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Должность" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________", "nullable": true } }, "type": "object", "title": "РабОргПродТип" }, "app__schemas__upd_nullable__seller_title_5_03_________________6": { "properties": { "должность": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Должность" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "наим_орг_пер": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Орг Пер" }, "иннюл_пер": { "type": "string", "maxLength": 10, "minLength": 0, "pattern": "[0-9]{0,10}", "nullable": true, "title": "Иннюл Пер" }, "осн_довер_орг_пер": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03______________4", "nullable": true }, "осн_полн_пред_пер": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03______________4", "nullable": true }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________", "nullable": true } }, "type": "object", "title": "ПредОргПерТип" }, "app__schemas__upd_nullable__seller_title_5_03______________________": { "properties": { "дата_гос_конт": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Гос Конт" }, "номер_гос_конт": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Номер Гос Конт" }, "лиц_счет_прод": { "type": "string", "maxLength": 11, "minLength": 11, "nullable": true, "title": "Лиц Счет Прод" }, "код_прод_бюдж_класс": { "type": "string", "maxLength": 20, "minLength": 20, "nullable": true, "title": "Код Прод Бюдж Класс" }, "код_цели_прод": { "type": "string", "maxLength": 20, "minLength": 20, "nullable": true, "title": "Код Цели Прод" }, "код_казнач_прод": { "type": "string", "maxLength": 4, "minLength": 1, "nullable": true, "title": "Код Казнач Прод" }, "наим_казнач_прод": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Наим Казнач Прод" } }, "type": "object", "title": "ИнфПродЗаГоскКазнТип" }, "Body_send_fs_title_1_clarification_notification_v4_docflow_types_fs_docflows__docflow_id__documents_title_1_clarification_notification_send_post": { "properties": { "signature": { "type": "string", "format": "binary", "nullable": true, "title": "Signature" }, "mchd_id": { "type": "string", "nullable": true, "title": "Mchd Id", "description": "ID машиночитаемой доверенности" } }, "type": "object", "title": "Body_send_fs_title_1_clarification_notification_v4_docflow_types_fs_docflows__docflow_id__documents_title_1_clarification_notification_send_post" }, "Body_send_fs_title_1_document_v4_docflow_types_fs_docflows__docflow_id__documents_title_1_send_post": { "properties": { "signature": { "type": "string", "format": "binary", "title": "Signature", "description": " Подпись документа в формате base64" }, "mchd_id": { "type": "string", "nullable": true, "title": "Mchd Id", "description": "ID машиночитаемой доверенности" } }, "type": "object", "required": [ "signature" ], "title": "Body_send_fs_title_1_document_v4_docflow_types_fs_docflows__docflow_id__documents_title_1_send_post" }, "Body_send_fs_title_1_read_confirmation_document_v4_docflow_types_fs_docflows__docflow_id__documents_title_1_read_confirmation_send_post": { "properties": { "signature": { "type": "string", "format": "binary", "nullable": true, "title": "Signature" }, "mchd_id": { "type": "string", "nullable": true, "title": "Mchd Id", "description": "ID машиночитаемой доверенности" } }, "type": "object", "title": "Body_send_fs_title_1_read_confirmation_document_v4_docflow_types_fs_docflows__docflow_id__documents_title_1_read_confirmation_send_post" }, "Body_send_rnf_title_1_clarification_notification_document_v4_docflow_types_nf_docflows__docflow_id__documents_title_1_clarification_notification_send_post": { "properties": { "signature": { "type": "string", "format": "binary", "nullable": true, "title": "Signature" }, "mchd_id": { "type": "string", "nullable": true, "title": "Mchd Id", "description": "ID машиночитаемой доверенности" } }, "type": "object", "title": "Body_send_rnf_title_1_clarification_notification_document_v4_docflow_types_nf_docflows__docflow_id__documents_title_1_clarification_notification_send_post" }, "Body_send_rnf_title_1_document_v4_docflow_types_nf_docflows__docflow_id__documents_title_1_send_post": { "properties": { "signature": { "type": "string", "format": "binary", "title": "Signature", "description": " Подпись документа в формате base64" }, "mchd_id": { "type": "string", "nullable": true, "title": "Mchd Id", "description": "ID машиночитаемой доверенности" } }, "type": "object", "required": [ "signature" ], "title": "Body_send_rnf_title_1_document_v4_docflow_types_nf_docflows__docflow_id__documents_title_1_send_post" }, "Body_send_rnf_title_1_read_confirmation_document_v4_docflow_types_nf_docflows__docflow_id__documents_title_1_read_confirmation_send_post": { "properties": { "signature": { "type": "string", "format": "binary", "nullable": true, "title": "Signature" }, "mchd_id": { "type": "string", "nullable": true, "title": "Mchd Id", "description": "ID машиночитаемой доверенности" } }, "type": "object", "title": "Body_send_rnf_title_1_read_confirmation_document_v4_docflow_types_nf_docflows__docflow_id__documents_title_1_read_confirmation_send_post" }, "Body_send_rnf_title_2_document_v4_docflow_types_nf_docflows__docflow_id__documents_title_2_send_post": { "properties": { "signature": { "type": "string", "format": "binary", "title": "Signature", "description": " Подпись документа в формате base64" }, "mchd_id": { "type": "string", "nullable": true, "title": "Mchd Id", "description": "ID машиночитаемой доверенности" } }, "type": "object", "required": [ "signature" ], "title": "Body_send_rnf_title_2_document_v4_docflow_types_nf_docflows__docflow_id__documents_title_2_send_post" }, "Body_send_upd_title_1_clarification_notification_v4_docflow_types_upd_docflows__docflow_id__documents_title_1_clarification_notification_send_post": { "properties": { "signature": { "type": "string", "format": "binary", "nullable": true, "title": "Signature" }, "mchd_id": { "type": "string", "nullable": true, "title": "Mchd Id", "description": "ID машиночитаемой доверенности" } }, "type": "object", "title": "Body_send_upd_title_1_clarification_notification_v4_docflow_types_upd_docflows__docflow_id__documents_title_1_clarification_notification_send_post" }, "Body_send_upd_title_1_document_v4_docflow_types_upd_docflows__docflow_id__documents_title_1_send_post": { "properties": { "signature": { "type": "string", "format": "binary", "title": "Signature", "description": " Подпись документа в формате base64" }, "mchd_id": { "type": "string", "nullable": true, "title": "Mchd Id", "description": "ID MЧД, если подпись с МЧД" } }, "type": "object", "required": [ "signature" ], "title": "Body_send_upd_title_1_document_v4_docflow_types_upd_docflows__docflow_id__documents_title_1_send_post" }, "Body_send_upd_title_1_read_confirmation_v4_docflow_types_upd_docflows__docflow_id__documents_title_1_read_confirmation_send_post": { "properties": { "signature": { "type": "string", "format": "binary", "nullable": true, "title": "Signature" }, "mchd_id": { "type": "string", "nullable": true, "title": "Mchd Id", "description": "ID машиночитаемой доверенности" } }, "type": "object", "title": "Body_send_upd_title_1_read_confirmation_v4_docflow_types_upd_docflows__docflow_id__documents_title_1_read_confirmation_send_post" }, "Body_send_upd_title_2_document_v4_docflow_types_upd_docflows__docflow_id__documents_title_2_send_post": { "properties": { "signature": { "type": "string", "format": "binary", "title": "Signature", "description": " Подпись документа в формате base64" }, "mchd_id": { "type": "string", "nullable": true, "title": "Mchd Id", "description": "ID машиночитаемой доверенности" } }, "type": "object", "required": [ "signature" ], "title": "Body_send_upd_title_2_document_v4_docflow_types_upd_docflows__docflow_id__documents_title_2_send_post" }, "InvoiceFunctionEnum": { "type": "string", "enum": [ "0", "1" ], "title": "InvoiceFunctionEnum" }, "TitleV501FullSchema": { "properties": { "ид_файл": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Ид Файл" }, "верс_форм": { "type": "string", "const": "5.01", "title": "Верс Форм", "default": "5.01" }, "верс_прог": { "type": "string", "maxLength": 40, "minLength": 1, "title": "Верс Прог" }, "документ": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema_______________6" } }, "type": "object", "required": [ "ид_файл", "верс_прог", "документ" ], "title": "TitleV501FullSchema", "description": "Параметры в соответствии с приказом ФНС РФ от 20.01.2025 N ЕД-7-26/29@ (nalog.gov.ru, normativ.kontur.ru)" }, "TitleV501NullableSchema-Input": { "properties": { "верс_форм": { "type": "string", "const": "5.01", "title": "Верс Форм", "default": "5.01" }, "документ": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_____________-Input__5" } }, "type": "object", "title": "TitleV501NullableSchema", "description": "Параметры в соответствии с приказом ФНС РФ от 20.01.2025 N ЕД-7-26/29@ (nalog.gov.ru, normativ.kontur.ru)" }, "TitleV501NullableSchema-Output": { "properties": { "верс_форм": { "type": "string", "const": "5.01", "title": "Верс Форм", "default": "5.01" }, "документ": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_____________-Output__5" } }, "type": "object", "title": "TitleV501NullableSchema", "description": "Параметры в соответствии с приказом ФНС РФ от 19.12.2018 N ММВ-7-15/820 (nalog.gov.ru, normativ.kontur.ru)" }, "________________-Input": { "properties": { "ном_стр": { "enum": [ "number", "string" ], "decimal_places": 0, "max_digits": 6, "nullable": true, "title": "Ном Стр" }, "наим_тов": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Наим Тов" }, "кол_тов": { "enum": [ "number", "string" ], "decimal_places": 11, "max_digits": 26, "nullable": true, "title": "Кол Тов" }, "океи_тов": { "type": "string", "maxLength": 4, "minLength": 3, "pattern": "(?:[0-9]{3})|(?:[0-9]{4})", "nullable": true, "title": "Океи Тов" }, "наим_ед_изм": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Ед Изм" }, "цена_тов": { "enum": [ "number", "string" ], "decimal_places": 11, "max_digits": 26, "nullable": true, "title": "Цена Тов" }, "ст_тов_без_ндс": { "enum": [ "number", "string" ], "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Ст Тов Без Ндс" }, "ст_тов_уч_нал": { "enum": [ "number", "string" ], "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Ст Тов Уч Нал" }, "цена_тов_без_ски": { "enum": [ "number", "string" ], "decimal_places": 11, "max_digits": 26, "nullable": true, "title": "Цена Тов Без Ски" }, "ст_тов_без_ндс_ски": { "enum": [ "number", "string" ], "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Ст Тов Без Ндс Ски" }, "ст_тов_уч_нал_без_ски": { "enum": [ "number", "string" ], "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Ст Тов Уч Нал Без Ски" }, "нал_ст": { "type": "string", "enum": [ "0%", "5%", "7%", "9.09%", "10%", "16.67%", "18.03%", "20%", "22%", "5/105", "7/107", "10/110", "20/120", "22/122", "без НДС", "НДС исчисляется налоговым агентом" ], "nullable": true, "title": "Нал Ст" }, "нал_ст_ин": { "type": "string", "maxLength": 35, "minLength": 1, "nullable": true, "title": "Нал Ст Ин" }, "сум_ски": { "enum": [ "number", "string" ], "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Сум Ски" }, "процент_ски": { "enum": [ "number", "string" ], "decimal_places": 0, "max_digits": 2, "nullable": true, "title": "Процент Ски" }, "сум_нал": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema___________-Input__1", "nullable": true }, "сум_нал_без_ски": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema___________-Input__1", "nullable": true }, "доп_свед_тов": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_________________2", "nullable": true }, "инф_пол": { "items": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_____________2" }, "type": "array", "title": "Инф Пол", "default": [] } }, "type": "object", "title": "СведТовЦенПокТип" }, "app__schemas__invoice_full__title_v_501_xml_schema___________1": { "properties": { "св_ип": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03___________2", "nullable": true }, "св_юл_уч": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema_____________3", "nullable": true }, "св_фл_уч": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema_____________4", "nullable": true }, "св_ин_не_уч": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema_______________1", "nullable": true } }, "type": "object", "title": "ИдСвТип" }, "app__schemas__invoice_full__title_v_501_xml_schema____________2": { "properties": { "глн_места": { "type": "string", "maxLength": 13, "minLength": 13, "nullable": true, "title": "Глн Места" }, "адр_рф": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03____________3", "nullable": true }, "адр_гар": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema_____________5", "nullable": true }, "адр_инф": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03_____________4", "nullable": true } }, "type": "object", "title": "АдресТип", "description": "Сведения об адресе (месте нахождения)
• `глн_места`: Глобальный номер места нахождения (GLN места)
• `адр_рф`: Адрес, указанный в Едином государственном реестре юридических лиц/почтовый адрес/адрес регистрации по месту жительства индивидуального предпринимателя, указанный в Едином государственном реестре индивидуальных предпринимателей (реквизиты адреса на территории Российской Федерации)
• `адр_гар`: Адрес в соответствии с государственным адресным реестром, указанный в Едином государственном реестре юридических лиц/почтовый адрес/адрес регистрации по месту жительства индивидуального предпринимателя, указанный в Едином государственном реестре индивидуальных предпринимателей (реквизиты адреса на территории Российской Федерации)
• `адр_инф`: Адрес, указанный в Едином государственном реестре юридических лиц/почтовый адрес/адрес регистрации по месту жительства индивидуального предпринимателя, указанный в Едином государственном реестре индивидуальных предпринимателей (информация об адресе, в том числе об адресе за пределами территории Российской Федерации)" }, "app__schemas__invoice_full__title_v_501_xml_schema____________4": { "properties": { "дата_нач_тов": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Нач Тов" }, "назн_пл": { "type": "string", "maxLength": 210, "minLength": 1, "title": "Назн Пл" }, "уник_инф": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Уник Инф" }, "способ_опл": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Способ Опл" }, "огран_оп_дат": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Огран Оп Дат" }, "огран_оп_дат_вр": { "type": "string", "maxLength": 25, "minLength": 25, "pattern": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+|-]([01][0-9])[:]([0-5][0-9])))", "nullable": true, "title": "Огран Оп Дат Вр" }, "усл_опл": { "items": { "type": "string", "maxLength": 1000, "minLength": 1 }, "type": "array", "title": "Усл Опл", "default": [] }, "усл_оказ_пост": { "items": { "type": "string", "maxLength": 1000, "minLength": 1 }, "type": "array", "title": "Усл Оказ Пост", "default": [] }, "инф_пол": { "items": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema_____________2" }, "type": "array", "title": "Инф Пол", "default": [] } }, "type": "object", "required": [ "назн_пл" ], "title": "ДопСвТип" }, "app__schemas__invoice_full__title_v_501_xml_schema____________5": { "properties": { "дата_док": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "title": "Дата Док" }, "номер_док": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Номер Док" }, "всего_наим": { "type": "string", "decimal_places": 0, "max_digits": 6, "nullable": true, "title": "Всего Наим" }, "основание": { "items": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema________________2" }, "type": "array", "title": "Основание", "default": [] }, "свед_тов_цен_пок": { "items": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema__________________" }, "type": "array", "minItems": 1, "title": "Свед Тов Цен Пок" }, "всего_опл": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema_______________5" }, "доп_св": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema____________4", "nullable": true }, "ден_изм": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema_____________7" }, "получ_дн_ср": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema_______________4", "nullable": true }, "св_плат": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema_______________4", "nullable": true }, "св_прод": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema_______________4" }, "св_покуп": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema_______________4" }, "груз_от": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema_______________4", "nullable": true }, "груз_получ": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema_______________4", "nullable": true }, "вид_обяз": { "items": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema______________5" }, "type": "array", "title": "Вид Обяз", "default": [] } }, "type": "object", "required": [ "дата_док", "номер_док", "свед_тов_цен_пок", "всего_опл", "ден_изм", "св_прод", "св_покуп" ], "title": "СодСчТип" }, "app__schemas__invoice_full__title_v_501_xml_schema_____________1": { "properties": { "сум_нал": { "type": "string", "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Сум Нал" }, "без_ндс": { "type": "string", "const": "без НДС", "nullable": true, "title": "Без Ндс" } }, "type": "object", "title": "СумНДСТип", "description": "Сумма налога
• `сум_нал`: Значение
• `без_ндс`: Без налога на добавленную стоимость (НДС)" }, "app__schemas__invoice_full__title_v_501_xml_schema_____________2": { "properties": { "ид_файл_инф_пол": { "type": "string", "maxLength": 36, "minLength": 36, "nullable": true, "title": "Ид Файл Инф Пол" }, "текст_инф": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_01_______________4" }, "type": "array", "title": "Текст Инф", "default": [] } }, "type": "object", "title": "ИнфПолТип", "description": "Информационное поле
• `ид_файл_инф_пол`: Идентификатор файла информационного поля
• `текст_инф`: Текстовая информация" }, "app__schemas__invoice_full__title_v_501_xml_schema_____________3": { "properties": { "наим_орг": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Наим Орг" }, "иннюл": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}", "title": "Иннюл" }, "огрн": { "type": "string", "maxLength": 13, "minLength": 13, "pattern": "[0-9]{13}", "nullable": true, "title": "Огрн" }, "кпп": { "type": "string", "maxLength": 9, "minLength": 9, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})([0-9]{2})([0-9A-Z]{2})([0-9]{3})", "nullable": true, "title": "Кпп" } }, "type": "object", "required": [ "наим_орг", "иннюл" ], "title": "СвЮЛУчТип" }, "app__schemas__invoice_full__title_v_501_xml_schema_____________4": { "properties": { "снилс": { "type": "string", "maxLength": 14, "minLength": 14, "pattern": "(?:[0-9]{3}\\-[0-9]{3}\\-[0-9]{3}\\-[0-9]{2})|(?:[0-9]{3}\\-[0-9]{3}\\-[0-9]{3} [0-9]{2})", "nullable": true, "title": "Снилс" }, "иннфл": { "type": "string", "maxLength": 12, "minLength": 12, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}", "nullable": true, "title": "Иннфл" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "ид_стат_л": { "type": "string", "enum": [ "0", "1" ], "nullable": true, "title": "Ид Стат Л" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________", "nullable": true } }, "type": "object", "title": "СвФЛУчТип" }, "app__schemas__invoice_full__title_v_501_xml_schema_____________5": { "properties": { "ид_ном": { "type": "string", "maxLength": 36, "minLength": 36, "title": "Ид Ном" }, "индекс": { "type": "string", "maxLength": 6, "minLength": 6, "nullable": true, "title": "Индекс" }, "код_регион": { "type": "string", "maxLength": 2, "minLength": 2, "pattern": "[0-9]{2}", "title": "Код Регион" }, "наим_регион": { "type": "string", "maxLength": 51, "minLength": 1, "title": "Наим Регион" }, "муницип_район": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema_________________1", "nullable": true }, "город_сел_поселен": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema_________________1", "nullable": true }, "населен_пункт": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03______________3", "nullable": true }, "эл_план_структур": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03______________1", "nullable": true }, "эл_ул_дор_сети": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03______________1", "nullable": true }, "земел_участок": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Земел Участок" }, "здание": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03____________1" }, "type": "array", "title": "Здание", "default": [] }, "помещ_здания": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03____________1", "nullable": true }, "помещ_квартиры": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03____________1", "nullable": true } }, "type": "object", "required": [ "ид_ном", "код_регион", "наим_регион" ], "title": "АдрГАРТип", "description": "Адрес в соответствии с государственным адресным реестром
• `ид_ном`: Уникальный номер адреса объекта адресации в государственном адресном реестре
• `индекс`: Почтовый индекс
• `код_регион`: Код субъекта Российской Федерации
• `наим_регион`: Наименование субъекта Российской Федерации
• `муницип_район`: Муниципальный район/городской округ/внутригородская территория города федерального значения/муниципальный округ/федеральная территория
• `город_сел_поселен`: Городское поселение/сельское поселение/межселенная территория в составе муниципального района/внутригородской район городского округа
• `населен_пункт`: Населенный пункт (город, деревня, село и прочее)
• `эл_план_структур`: Элемент планировочной структуры
• `эл_ул_дор_сети`: Элемент улично-дорожной сети
• `земел_участок`: Земельный участок (номер)
• `здание`: Здание/строение/сооружение/ объект незавершенного строительства
• `помещ_здания`: Помещение в пределах здания/строения/сооружения/машино-место
• `помещ_квартиры`: Помещение в пределах квартиры" }, "app__schemas__invoice_full__title_v_501_xml_schema_____________7": { "properties": { "наим_окв": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Наим Окв" }, "код_окв": { "type": "string", "maxLength": 3, "minLength": 3, "pattern": "[0-9]{3}", "nullable": true, "title": "Код Окв" }, "уе": { "type": "string", "const": "у.е.", "nullable": true, "title": "Уе" }, "курс_вал": { "type": "string", "decimal_places": 4, "max_digits": 10, "nullable": true, "title": "Курс Вал" }, "опр_уе": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Опр Уе" } }, "type": "object", "title": "ДенИзмТип" }, "app__schemas__invoice_full__title_v_501_xml_schema______________4": { "properties": { "рекв_наим_док": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Рекв Наим Док" }, "рекв_номер_док": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Рекв Номер Док" }, "рекв_дата_док": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "title": "Рекв Дата Док" }, "рекв_ид_файл_док": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Рекв Ид Файл Док" }, "рекв_ид_док": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Рекв Ид Док" }, "р_ид_сист_хран_д": { "type": "string", "maxLength": 500, "minLength": 1, "nullable": true, "title": "Р Ид Сист Хран Д" }, "рекв_урл_сист_док": { "type": "string", "maxLength": 500, "minLength": 1, "nullable": true, "title": "Рекв Урл Сист Док" }, "рекв_доп_свед_док": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Рекв Доп Свед Док" }, "рекв_ид_рек_сост": { "items": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema________________1" }, "type": "array", "title": "Рекв Ид Рек Сост", "default": [] } }, "type": "object", "required": [ "рекв_наим_док", "рекв_номер_док", "рекв_дата_док" ], "title": "РеквДокТип", "description": "Реквизиты документа
• `рекв_наим_док`: Наименование документа
• `рекв_номер_док`: Номер документа
• `рекв_дата_док`: Дата документа
• `рекв_ид_файл_док`: Идентификатор файла обмена документа, подписанного первой стороной
• `рекв_ид_док`: Идентификатор документа
• `р_ид_сист_хран_д`: Идентифицирующая информация об информационной системе, в которой осуществляется хранение документа, необходимая для запроса информации из информационной системы
• `рекв_урл_сист_док`: Сведения в формате URL об информационной системе, которая предоставляет техническую возможность получения информации о документе
• `рекв_доп_свед_док`: Дополнительные сведения
• `рекв_ид_рек_сост`: Идентифицирующие реквизиты сторон, составивших документ" }, "app__schemas__invoice_full__title_v_501_xml_schema______________5": { "properties": { "код_вид_обяз": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Код Вид Обяз" }, "наим_вид_обязм": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Вид Обязм" } }, "type": "object", "title": "ВидОбязТип" }, "app__schemas__invoice_full__title_v_501_xml_schema_______________1": { "properties": { "ид_стат": { "type": "string", "enum": [ "ИО", "ИГ" ], "title": "Ид Стат" }, "код_стр": { "type": "string", "maxLength": 3, "minLength": 3, "pattern": "[0-9]{3}", "title": "Код Стр" }, "наим_стран": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Наим Стран" }, "наим": { "type": "string", "maxLength": 1000, "minLength": 1, "title": "Наим" }, "идентиф": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Идентиф" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" } }, "type": "object", "required": [ "ид_стат", "код_стр", "наим_стран", "наим" ], "title": "СвИнНеУчТип", "description": "Сведения об иностранной организации (иностранном гражданине), не состоящей/состоящем на учете в налоговом органе
• `ид_стат`: Идентификация статуса
• `код_стр`: Код страны
• `наим_стран`: Наименование страны
• `наим`: Наименование иностранной организации полное/Фамилия, имя, отчество (при наличии) иностранного гражданина
• `идентиф`: Идентификатор иностранной организации (иностранного гражданина)
• `иные_свед`: Иные сведения для однозначной идентификации иностранной организации (иностранного гражданина)" }, "app__schemas__invoice_full__title_v_501_xml_schema_______________3": { "properties": { "номер_счета": { "type": "string", "maxLength": 20, "minLength": 1, "title": "Номер Счета" }, "наим_банк": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Наим Банк" }, "иннюл": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}", "nullable": true, "title": "Иннюл" }, "кпп": { "type": "string", "maxLength": 9, "minLength": 9, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})([0-9]{2})([0-9A-Z]{2})([0-9]{3})", "nullable": true, "title": "Кпп" }, "бик": { "type": "string", "maxLength": 9, "minLength": 9, "pattern": "[0-9]{9}", "title": "Бик" }, "кор_счет": { "type": "string", "maxLength": 20, "minLength": 1, "title": "Кор Счет" }, "swift_код": { "type": "string", "maxLength": 11, "minLength": 8, "nullable": true, "title": "Swift Код" } }, "type": "object", "required": [ "номер_счета", "бик", "кор_счет" ], "title": "БанкРеквТип" }, "app__schemas__invoice_full__title_v_501_xml_schema_______________4": { "properties": { "окпо": { "type": "string", "maxLength": 10, "minLength": 1, "nullable": true, "title": "Окпо" }, "код_опф": { "type": "string", "maxLength": 5, "minLength": 2, "pattern": "(?:[0-9]{2})|(?:[0-9]{5})", "nullable": true, "title": "Код Опф" }, "полн_наим_опф": { "type": "string", "maxLength": 255, "minLength": 4, "nullable": true, "title": "Полн Наим Опф" }, "структ_подр": { "type": "string", "maxLength": 500, "minLength": 1, "nullable": true, "title": "Структ Подр" }, "инф_для_участ": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Инф Для Участ" }, "сокр_наим": { "type": "string", "maxLength": 510, "minLength": 1, "nullable": true, "title": "Сокр Наим" }, "ид_св": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema___________1" }, "банк_рекв": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema_______________3", "nullable": true }, "адрес": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema____________2", "nullable": true }, "контакт": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03______________2", "nullable": true } }, "type": "object", "required": [ "ид_св" ], "title": "УчастникТип", "description": "Сведения об участнике факта хозяйственной жизни
• `окпо`: Код по Общероссийскому классификатору предприятий и организаций
• `код_опф`: Код по Общероссийскому классификатору организационно-правовых форм
• `полн_наим_опф`: Полное наименование организационно-правовой формы
• `структ_подр`: Структурное подразделение
• `инф_для_участ`: Информация для участника документооборота
• `сокр_наим`: Сокращенное наименование
• `ид_св`: Идентификационные сведения
• `банк_рекв`: Банковские реквизиты получателя денежных средств
• `адрес`: Адрес
• `контакт`: Контактные данные" }, "app__schemas__invoice_full__title_v_501_xml_schema_______________5": { "properties": { "ст_тов_без_ндс_всего": { "type": "string", "title": "Ст Тов Без Ндс Всего" }, "ст_тов_уч_нал_всего": { "type": "string", "title": "Ст Тов Уч Нал Всего" }, "сум_ски_всего": { "type": "string", "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Сум Ски Всего" }, "сум_нал_всего": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema_____________1" } }, "type": "object", "required": [ "ст_тов_без_ндс_всего", "ст_тов_уч_нал_всего", "сум_нал_всего" ], "title": "ВсегоОплТип" }, "app__schemas__invoice_full__title_v_501_xml_schema_______________6": { "properties": { "кнд": { "type": "string", "const": "1110379", "title": "Кнд", "default": "1110379" }, "функция": { "$ref": "#/components/schemas/InvoiceFunctionEnum" }, "дата_инф": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "title": "Дата Инф" }, "вр_инф": { "type": "string", "maxLength": 8, "minLength": 8, "pattern": "([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})", "title": "Вр Инф" }, "сод_сч": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema____________5" }, "подписант": { "items": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema________________5" }, "type": "array", "minItems": 1, "title": "Подписант" }, "инф_пол": { "items": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema_____________2" }, "type": "array", "title": "Инф Пол", "default": [] } }, "type": "object", "required": [ "функция", "дата_инф", "вр_инф", "сод_сч", "подписант" ], "title": "ДокументТип" }, "app__schemas__invoice_full__title_v_501_xml_schema________________1": { "properties": { "иннюл": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}", "nullable": true, "title": "Иннюл" }, "иннфл": { "type": "string", "maxLength": 12, "minLength": 12, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}", "nullable": true, "title": "Иннфл" }, "данн_ино": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema_______________1", "nullable": true }, "наим_оив": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Оив" } }, "type": "object", "title": "ИдРекСостТип", "description": "Идентифицирующие реквизиты сторон, составивших документ
• `иннюл`: ИНН юридического лица, состоящего на учете в налоговом органе
• `иннфл`: ИНН физического лица, в том числе индивидуального предпринимателя
• `данн_ино`: Данные об иностранной организации (иностранном гражданине), не состоящей на учете в налоговом органе
• `наим_оив`: Наименование органа исполнительной власти (специализированной уполномоченной организации), выдавшего документ" }, "app__schemas__invoice_full__title_v_501_xml_schema________________2": { "properties": { "осн_иное": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Осн Иное" }, "осн_рекв_док": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema______________4", "nullable": true } }, "type": "object", "title": "ОснованиеТип" }, "app__schemas__invoice_full__title_v_501_xml_schema________________3": { "properties": { "наим_гос_сист": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Наим Гос Сист" }, "учет_ед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Учет Ед" }, "иная_инф": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Иная Инф" }, "ид_ном_учет_ед": { "items": { "type": "string", "maxLength": 255, "minLength": 1 }, "type": "array", "minItems": 1, "title": "Ид Ном Учет Ед" } }, "type": "object", "required": [ "наим_гос_сист", "ид_ном_учет_ед" ], "title": "СвГосСистТип" }, "app__schemas__invoice_full__title_v_501_xml_schema________________4": { "properties": { "ном_довер": { "type": "string", "maxLength": 36, "minLength": 36, "title": "Ном Довер" }, "дата_выд_довер": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "title": "Дата Выд Довер" }, "вн_ном_довер": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Вн Ном Довер" }, "дата_вн_рег_довер": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Вн Рег Довер" }, "ид_сист_хран": { "type": "string", "maxLength": 500, "minLength": 1, "title": "Ид Сист Хран" }, "урл_сист": { "type": "string", "maxLength": 500, "minLength": 1, "nullable": true, "title": "Урл Сист" } }, "type": "object", "required": [ "ном_довер", "дата_выд_довер", "ид_сист_хран" ], "title": "СвДоверЭлТип" }, "app__schemas__invoice_full__title_v_501_xml_schema________________5": { "properties": { "должн": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Должн" }, "тип_подпис": { "type": "string", "enum": [ "1", "2", "3" ], "nullable": true, "title": "Тип Подпис" }, "дата_под_док": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Под Док" }, "спос_подт_полном": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6" ], "title": "Спос Подт Полном" }, "доп_свед_подп": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Доп Свед Подп" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_01________" }, "св_довер_эл": { "items": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema________________4" }, "type": "array", "title": "Св Довер Эл", "default": [] }, "св_довер_бум": { "items": { "$ref": "#/components/schemas/app__schemas__upd_full__buyer_title_5_03_________________2" }, "type": "array", "title": "Св Довер Бум", "default": [] } }, "type": "object", "required": [ "должн", "спос_подт_полном", "фио" ], "title": "ПодписантТип", "description": "Сведения о лице, подписывающем информацию отправителя в электронной форме
• `должн`: Должность
• `тип_подпис`: Тип подписи
• `дата_под_док`: Дата подписания документа
• `спос_подт_полном`: Способ подтверждения полномочий представителя на подписание документа
• `доп_свед_подп`: Дополнительные сведения
• `фио`: Фамилия, имя, отчество (при наличии)
• `св_довер_эл`: Сведения о доверенности в электронной форме в машиночитаемом виде, используемой для подтверждения полномочий представителя
• `св_довер_бум`: Сведения о доверенности в форме документа на бумажном носителе, используемой для подтверждения полномочий представителя" }, "app__schemas__invoice_full__title_v_501_xml_schema_________________1": { "properties": { "вид_код": { "type": "string", "maxLength": 1, "minLength": 1, "title": "Вид Код" }, "наим": { "type": "string", "maxLength": 255, "minLength": 1, "title": "Наим" } }, "type": "object", "required": [ "вид_код", "наим" ], "title": "ВидНаимКодТип", "description": "Сведения о виде (код) и наименовании адресного элемента
• `вид_код`: Вид (код) элемента
• `наим`: Наименование элемента" }, "app__schemas__invoice_full__title_v_501_xml_schema_________________2": { "properties": { "пр_тов_раб": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "nullable": true, "title": "Пр Тов Раб" }, "доп_призн": { "type": "string", "maxLength": 4, "minLength": 1, "nullable": true, "title": "Доп Призн" }, "код_происх": { "type": "string", "maxLength": 3, "minLength": 3, "pattern": "[0-9]{3}", "nullable": true, "title": "Код Происх" }, "кр_наим_стр_пр": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Кр Наим Стр Пр" }, "характер_тов": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Характер Тов" }, "сорт_тов": { "type": "string", "maxLength": 10, "minLength": 1, "nullable": true, "title": "Сорт Тов" }, "серия_тов": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Серия Тов" }, "артикул_тов": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Артикул Тов" }, "код_тов": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Код Тов" }, "код_кат": { "type": "string", "maxLength": 27, "minLength": 27, "nullable": true, "title": "Код Кат" }, "код_вид_тов": { "type": "string", "maxLength": 10, "minLength": 10, "nullable": true, "title": "Код Вид Тов" }, "св_гос_сист": { "items": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema________________3" }, "type": "array", "title": "Св Гос Сист", "default": [] } }, "type": "object", "title": "ДопСведТовТип" }, "app__schemas__invoice_full__title_v_501_xml_schema__________________": { "properties": { "ном_стр": { "type": "string", "title": "Ном Стр" }, "наим_тов": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Наим Тов" }, "кол_тов": { "type": "string", "decimal_places": 11, "max_digits": 26, "nullable": true, "title": "Кол Тов" }, "океи_тов": { "type": "string", "maxLength": 4, "minLength": 3, "pattern": "(?:[0-9]{3})|(?:[0-9]{4})", "nullable": true, "title": "Океи Тов" }, "наим_ед_изм": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Ед Изм" }, "цена_тов": { "type": "string", "decimal_places": 11, "max_digits": 26, "nullable": true, "title": "Цена Тов" }, "ст_тов_без_ндс": { "type": "string", "title": "Ст Тов Без Ндс" }, "ст_тов_уч_нал": { "type": "string", "title": "Ст Тов Уч Нал" }, "цена_тов_без_ски": { "type": "string", "decimal_places": 11, "max_digits": 26, "nullable": true, "title": "Цена Тов Без Ски" }, "ст_тов_без_ндс_ски": { "type": "string", "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Ст Тов Без Ндс Ски" }, "ст_тов_уч_нал_без_ски": { "type": "string", "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Ст Тов Уч Нал Без Ски" }, "нал_ст": { "type": "string", "enum": [ "0%", "5%", "7%", "9.09%", "10%", "16.67%", "18.03%", "20%", "22%", "5/105", "7/107", "10/110", "20/120", "22/122", "без НДС", "НДС исчисляется налоговым агентом" ], "nullable": true, "title": "Нал Ст" }, "нал_ст_ин": { "type": "string", "maxLength": 35, "minLength": 1, "nullable": true, "title": "Нал Ст Ин" }, "сум_ски": { "type": "string", "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Сум Ски" }, "процент_ски": { "type": "string", "decimal_places": 0, "max_digits": 2, "nullable": true, "title": "Процент Ски" }, "сум_нал": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema_____________1" }, "сум_нал_без_ски": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema_____________1" }, "доп_свед_тов": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema_________________2", "nullable": true }, "инф_пол": { "items": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema_____________2" }, "type": "array", "title": "Инф Пол", "default": [] } }, "type": "object", "required": [ "ном_стр", "ст_тов_без_ндс", "ст_тов_уч_нал", "сум_нал", "сум_нал_без_ски" ], "title": "СведТовЦенПокТип" }, "app__schemas__invoice_nullable__title_v_501_xml_schema_________-Input__1": { "properties": { "св_ип": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03___________2", "nullable": true }, "св_юл_уч": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_____________3", "nullable": true }, "св_фл_уч": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema___________-Input__4", "nullable": true }, "св_ин_не_уч": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_______________1", "nullable": true } }, "type": "object", "title": "ИдСвТип" }, "app__schemas__invoice_nullable__title_v_501_xml_schema_________-Output__1": { "properties": { "св_ип": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03___________2", "nullable": true }, "св_юл_уч": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_____________3", "nullable": true }, "св_фл_уч": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema___________-Input__4", "nullable": true }, "св_ин_не_уч": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_______________1", "nullable": true } }, "type": "object", "title": "ИдСвТип" }, "app__schemas__invoice_nullable__title_v_501_xml_schema__________-Input__5": { "properties": { "всего_наим": { "enum": [ "number", "string" ], "decimal_places": 0, "max_digits": 6, "nullable": true, "title": "Всего Наим" }, "основание": { "items": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema________________2" }, "type": "array", "title": "Основание", "default": [] }, "свед_тов_цен_пок": { "items": { "$ref": "#/components/schemas/________________-Input" }, "type": "array", "title": "Свед Тов Цен Пок", "default": [] }, "всего_опл": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_____________-Input__6" }, "доп_св": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema____________4", "nullable": true }, "ден_изм": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema___________-Input__7" }, "получ_дн_ср": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_____________-Input__4", "nullable": true }, "св_плат": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_____________-Input__4", "nullable": true }, "св_прод": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_____________-Input__4", "nullable": true }, "св_покуп": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_____________-Input__4", "nullable": true }, "груз_от": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_____________-Input__4", "nullable": true }, "груз_получ": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_____________-Input__4", "nullable": true }, "вид_обяз": { "items": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema______________5" }, "type": "array", "title": "Вид Обяз", "default": [] } }, "type": "object", "title": "СодСчТип" }, "app__schemas__invoice_nullable__title_v_501_xml_schema__________-Output__5": { "properties": { "всего_наим": { "type": "string", "decimal_places": 0, "max_digits": 6, "nullable": true, "title": "Всего Наим" }, "основание": { "items": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema________________2" }, "type": "array", "title": "Основание", "default": [] }, "свед_тов_цен_пок": { "items": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema__________________-Output" }, "type": "array", "title": "Свед Тов Цен Пок", "default": [] }, "всего_опл": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_____________-Output__6" }, "доп_св": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema____________4", "nullable": true }, "ден_изм": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema_____________7" }, "получ_дн_ср": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_____________-Output__4", "nullable": true }, "св_плат": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_____________-Output__4", "nullable": true }, "св_прод": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_____________-Output__4", "nullable": true }, "св_покуп": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_____________-Output__4", "nullable": true }, "груз_от": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_____________-Output__4", "nullable": true }, "груз_получ": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_____________-Output__4", "nullable": true }, "вид_обяз": { "items": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema______________5" }, "type": "array", "title": "Вид Обяз", "default": [] } }, "type": "object", "title": "СодСчТип" }, "app__schemas__invoice_nullable__title_v_501_xml_schema___________-Input__1": { "properties": { "сум_нал": { "enum": [ "number", "string" ], "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Сум Нал" }, "без_ндс": { "type": "string", "const": "без НДС", "nullable": true, "title": "Без Ндс" } }, "type": "object", "title": "СумНДСТип", "description": "Сумма налога
• `сум_нал`: Значение
• `без_ндс`: Без налога на добавленную стоимость (НДС)" }, "app__schemas__invoice_nullable__title_v_501_xml_schema___________-Input__4": { "properties": { "снилс": { "type": "string", "maxLength": 14, "minLength": 14, "pattern": "(?:[0-9]{3}\\-[0-9]{3}\\-[0-9]{3}\\-[0-9]{2})|(?:[0-9]{3}\\-[0-9]{3}\\-[0-9]{3} [0-9]{2})", "nullable": true, "title": "Снилс" }, "иннфл": { "type": "string", "maxLength": 12, "minLength": 12, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}", "nullable": true, "title": "Иннфл" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" }, "ид_стат_л": { "type": "string", "enum": [ "0", "1" ], "nullable": true, "title": "Ид Стат Л" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________", "nullable": true } }, "type": "object", "title": "СвФЛУчТип" }, "app__schemas__invoice_nullable__title_v_501_xml_schema___________-Input__7": { "properties": { "наим_окв": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Наим Окв" }, "код_окв": { "type": "string", "maxLength": 3, "minLength": 3, "pattern": "[0-9]{3}", "nullable": true, "title": "Код Окв" }, "уе": { "type": "string", "const": "у.е.", "nullable": true, "title": "Уе" }, "курс_вал": { "enum": [ "number", "string" ], "decimal_places": 4, "max_digits": 10, "nullable": true, "title": "Курс Вал" }, "опр_уе": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Опр Уе" } }, "type": "object", "title": "ДенИзмТип" }, "app__schemas__invoice_nullable__title_v_501_xml_schema____________2": { "properties": { "глн_места": { "type": "string", "maxLength": 13, "minLength": 13, "nullable": true, "title": "Глн Места" }, "адр_рф": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03____________3", "nullable": true }, "адр_гар": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_____________5", "nullable": true }, "адр_инф": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03_____________4", "nullable": true } }, "type": "object", "title": "АдресТип", "description": "Сведения об адресе (месте нахождения)
• `глн_места`: Глобальный номер места нахождения (GLN места)
• `адр_рф`: Адрес, указанный в Едином государственном реестре юридических лиц/почтовый адрес/адрес регистрации по месту жительства индивидуального предпринимателя, указанный в Едином государственном реестре индивидуальных предпринимателей (реквизиты адреса на территории Российской Федерации)
• `адр_гар`: Адрес в соответствии с государственным адресным реестром, указанный в Едином государственном реестре юридических лиц/почтовый адрес/адрес регистрации по месту жительства индивидуального предпринимателя, указанный в Едином государственном реестре индивидуальных предпринимателей (реквизиты адреса на территории Российской Федерации)
• `адр_инф`: Адрес, указанный в Едином государственном реестре юридических лиц/почтовый адрес/адрес регистрации по месту жительства индивидуального предпринимателя, указанный в Едином государственном реестре индивидуальных предпринимателей (информация об адресе, в том числе об адресе за пределами территории Российской Федерации)" }, "app__schemas__invoice_nullable__title_v_501_xml_schema____________4": { "properties": { "дата_нач_тов": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Нач Тов" }, "назн_пл": { "type": "string", "maxLength": 210, "minLength": 1, "nullable": true, "title": "Назн Пл" }, "уник_инф": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Уник Инф" }, "способ_опл": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Способ Опл" }, "огран_оп_дат": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Огран Оп Дат" }, "огран_оп_дат_вр": { "type": "string", "maxLength": 25, "minLength": 25, "pattern": "(((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6))))))([T]([0-1]{1}[0-9]{1}|2[0-3]{1}):([0-5]{1}[0-9]{1}):([0-5]{1}[0-9]{1})([+|-]([01][0-9])[:]([0-5][0-9])))", "nullable": true, "title": "Огран Оп Дат Вр" }, "усл_опл": { "items": { "type": "string", "maxLength": 1000, "minLength": 1 }, "type": "array", "title": "Усл Опл", "default": [] }, "усл_оказ_пост": { "items": { "type": "string", "maxLength": 1000, "minLength": 1 }, "type": "array", "title": "Усл Оказ Пост", "default": [] }, "инф_пол": { "items": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_____________2" }, "type": "array", "title": "Инф Пол", "default": [] } }, "type": "object", "title": "ДопСвТип" }, "app__schemas__invoice_nullable__title_v_501_xml_schema_____________-Input__4": { "properties": { "окпо": { "type": "string", "maxLength": 10, "minLength": 1, "nullable": true, "title": "Окпо" }, "код_опф": { "type": "string", "maxLength": 5, "minLength": 2, "pattern": "(?:[0-9]{2})|(?:[0-9]{5})", "nullable": true, "title": "Код Опф" }, "полн_наим_опф": { "type": "string", "maxLength": 255, "minLength": 4, "nullable": true, "title": "Полн Наим Опф" }, "структ_подр": { "type": "string", "maxLength": 500, "minLength": 1, "nullable": true, "title": "Структ Подр" }, "инф_для_участ": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Инф Для Участ" }, "сокр_наим": { "type": "string", "maxLength": 510, "minLength": 1, "nullable": true, "title": "Сокр Наим" }, "ид_св": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_________-Input__1" }, "банк_рекв": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_______________3", "nullable": true }, "адрес": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema____________2", "nullable": true }, "контакт": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03______________2", "nullable": true } }, "type": "object", "title": "УчастникТип", "description": "Сведения об участнике факта хозяйственной жизни
• `окпо`: Код по Общероссийскому классификатору предприятий и организаций
• `код_опф`: Код по Общероссийскому классификатору организационно-правовых форм
• `полн_наим_опф`: Полное наименование организационно-правовой формы
• `структ_подр`: Структурное подразделение
• `инф_для_участ`: Информация для участника документооборота
• `сокр_наим`: Сокращенное наименование
• `ид_св`: Идентификационные сведения
• `банк_рекв`: Банковские реквизиты получателя денежных средств
• `адрес`: Адрес
• `контакт`: Контактные данные" }, "app__schemas__invoice_nullable__title_v_501_xml_schema_____________-Input__5": { "properties": { "сод_сч": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema__________-Input__5" }, "подписант": { "items": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema______________-Input__5" }, "type": "array", "title": "Подписант", "default": [] }, "инф_пол": { "items": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_____________2" }, "type": "array", "title": "Инф Пол", "default": [] } }, "type": "object", "title": "ДокументТип" }, "app__schemas__invoice_nullable__title_v_501_xml_schema_____________-Input__6": { "properties": { "ст_тов_без_ндс_всего": { "enum": [ "number", "string" ], "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Ст Тов Без Ндс Всего" }, "ст_тов_уч_нал_всего": { "enum": [ "number", "string" ], "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Ст Тов Уч Нал Всего" }, "сум_ски_всего": { "enum": [ "number", "string" ], "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Сум Ски Всего" }, "сум_нал_всего": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema___________-Input__1", "nullable": true } }, "type": "object", "title": "ВсегоОплТип" }, "app__schemas__invoice_nullable__title_v_501_xml_schema_____________-Output__4": { "properties": { "окпо": { "type": "string", "maxLength": 10, "minLength": 1, "nullable": true, "title": "Окпо" }, "код_опф": { "type": "string", "maxLength": 5, "minLength": 2, "pattern": "(?:[0-9]{2})|(?:[0-9]{5})", "nullable": true, "title": "Код Опф" }, "полн_наим_опф": { "type": "string", "maxLength": 255, "minLength": 4, "nullable": true, "title": "Полн Наим Опф" }, "структ_подр": { "type": "string", "maxLength": 500, "minLength": 1, "nullable": true, "title": "Структ Подр" }, "инф_для_участ": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Инф Для Участ" }, "сокр_наим": { "type": "string", "maxLength": 510, "minLength": 1, "nullable": true, "title": "Сокр Наим" }, "ид_св": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_________-Output__1" }, "банк_рекв": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_______________3", "nullable": true }, "адрес": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema____________2", "nullable": true }, "контакт": { "$ref": "#/components/schemas/app__schemas__upd_full__seller_title_5_03______________2", "nullable": true } }, "type": "object", "title": "УчастникТип", "description": "Сведения об участнике факта хозяйственной жизни
• `окпо`: Код по Общероссийскому классификатору предприятий и организаций
• `код_опф`: Код по Общероссийскому классификатору организационно-правовых форм
• `полн_наим_опф`: Полное наименование организационно-правовой формы
• `структ_подр`: Структурное подразделение
• `инф_для_участ`: Информация для участника документооборота
• `сокр_наим`: Сокращенное наименование
• `ид_св`: Идентификационные сведения
• `банк_рекв`: Банковские реквизиты получателя денежных средств
• `адрес`: Адрес
• `контакт`: Контактные данные" }, "app__schemas__invoice_nullable__title_v_501_xml_schema_____________-Output__5": { "properties": { "сод_сч": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema__________-Output__5" }, "подписант": { "items": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema______________-Output__5" }, "type": "array", "title": "Подписант", "default": [] }, "инф_пол": { "items": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_____________2" }, "type": "array", "title": "Инф Пол", "default": [] } }, "type": "object", "title": "ДокументТип" }, "app__schemas__invoice_nullable__title_v_501_xml_schema_____________-Output__6": { "properties": { "ст_тов_без_ндс_всего": { "type": "string", "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Ст Тов Без Ндс Всего" }, "ст_тов_уч_нал_всего": { "type": "string", "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Ст Тов Уч Нал Всего" }, "сум_ски_всего": { "type": "string", "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Сум Ски Всего" }, "сум_нал_всего": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema_____________1", "nullable": true } }, "type": "object", "title": "ВсегоОплТип" }, "app__schemas__invoice_nullable__title_v_501_xml_schema_____________2": { "properties": { "ид_файл_инф_пол": { "type": "string", "maxLength": 36, "minLength": 36, "nullable": true, "title": "Ид Файл Инф Пол" }, "текст_инф": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_01_______________4" }, "type": "array", "title": "Текст Инф", "default": [] } }, "type": "object", "title": "ИнфПолТип", "description": "Информационное поле
• `ид_файл_инф_пол`: Идентификатор файла информационного поля
• `текст_инф`: Текстовая информация" }, "app__schemas__invoice_nullable__title_v_501_xml_schema_____________3": { "properties": { "наим_орг": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Наим Орг" }, "иннюл": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}", "nullable": true, "title": "Иннюл" }, "огрн": { "type": "string", "maxLength": 13, "minLength": 13, "pattern": "[0-9]{13}", "nullable": true, "title": "Огрн" }, "кпп": { "type": "string", "maxLength": 9, "minLength": 9, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})([0-9]{2})([0-9A-Z]{2})([0-9]{3})", "nullable": true, "title": "Кпп" } }, "type": "object", "title": "СвЮЛУчТип" }, "app__schemas__invoice_nullable__title_v_501_xml_schema_____________5": { "properties": { "ид_ном": { "type": "string", "maxLength": 36, "minLength": 36, "nullable": true, "title": "Ид Ном" }, "индекс": { "type": "string", "maxLength": 6, "minLength": 6, "nullable": true, "title": "Индекс" }, "код_регион": { "type": "string", "maxLength": 2, "minLength": 2, "pattern": "[0-9]{2}", "nullable": true, "title": "Код Регион" }, "наим_регион": { "type": "string", "maxLength": 51, "minLength": 1, "nullable": true, "title": "Наим Регион" }, "муницип_район": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_________________1", "nullable": true }, "город_сел_поселен": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_________________1", "nullable": true }, "населен_пункт": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03______________3", "nullable": true }, "эл_план_структур": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03______________1", "nullable": true }, "эл_ул_дор_сети": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03______________1", "nullable": true }, "земел_участок": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Земел Участок" }, "здание": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03____________1" }, "type": "array", "title": "Здание", "default": [] }, "помещ_здания": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03____________1", "nullable": true }, "помещ_квартиры": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03____________1", "nullable": true } }, "type": "object", "title": "АдрГАРТип", "description": "Адрес в соответствии с государственным адресным реестром
• `ид_ном`: Уникальный номер адреса объекта адресации в государственном адресном реестре
• `индекс`: Почтовый индекс
• `код_регион`: Код субъекта Российской Федерации
• `наим_регион`: Наименование субъекта Российской Федерации
• `муницип_район`: Муниципальный район/городской округ/внутригородская территория города федерального значения/муниципальный округ/федеральная территория
• `город_сел_поселен`: Городское поселение/сельское поселение/межселенная территория в составе муниципального района/внутригородской район городского округа
• `населен_пункт`: Населенный пункт (город, деревня, село и прочее)
• `эл_план_структур`: Элемент планировочной структуры
• `эл_ул_дор_сети`: Элемент улично-дорожной сети
• `земел_участок`: Земельный участок (номер)
• `здание`: Здание/строение/сооружение/ объект незавершенного строительства
• `помещ_здания`: Помещение в пределах здания/строения/сооружения/машино-место
• `помещ_квартиры`: Помещение в пределах квартиры" }, "app__schemas__invoice_nullable__title_v_501_xml_schema______________-Input__5": { "properties": { "должн": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Должн" }, "тип_подпис": { "type": "string", "enum": [ "1", "2", "3" ], "nullable": true, "title": "Тип Подпис" }, "дата_под_док": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Под Док" }, "спос_подт_полном": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6" ], "nullable": true, "title": "Спос Подт Полном" }, "доп_свед_подп": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Доп Свед Подп" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________" }, "св_довер_эл": { "items": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema________________4" }, "type": "array", "title": "Св Довер Эл", "default": [] }, "св_довер_бум": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_03_________________2" }, "type": "array", "title": "Св Довер Бум", "default": [] } }, "type": "object", "title": "ПодписантТип", "description": "Сведения о лице, подписывающем информацию отправителя в электронной форме
• `должн`: Должность
• `тип_подпис`: Тип подписи
• `дата_под_док`: Дата подписания документа
• `спос_подт_полном`: Способ подтверждения полномочий представителя на подписание документа
• `доп_свед_подп`: Дополнительные сведения
• `фио`: Фамилия, имя, отчество (при наличии)
• `св_довер_эл`: Сведения о доверенности в электронной форме в машиночитаемом виде, используемой для подтверждения полномочий представителя
• `св_довер_бум`: Сведения о доверенности в форме документа на бумажном носителе, используемой для подтверждения полномочий представителя" }, "app__schemas__invoice_nullable__title_v_501_xml_schema______________-Output__5": { "properties": { "должн": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Должн" }, "тип_подпис": { "type": "string", "enum": [ "1", "2", "3" ], "nullable": true, "title": "Тип Подпис" }, "дата_под_док": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Под Док" }, "спос_подт_полном": { "type": "string", "enum": [ "1", "2", "3", "4", "5", "6" ], "nullable": true, "title": "Спос Подт Полном" }, "доп_свед_подп": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Доп Свед Подп" }, "фио": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_01________" }, "св_довер_эл": { "items": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema________________4" }, "type": "array", "title": "Св Довер Эл", "default": [] }, "св_довер_бум": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__buyer_title_5_03_________________2" }, "type": "array", "title": "Св Довер Бум", "default": [] } }, "type": "object", "title": "ПодписантТип", "description": "Сведения о лице, подписывающем информацию отправителя в электронной форме
• `должн`: Должность
• `тип_подпис`: Тип подписи
• `дата_под_док`: Дата подписания документа
• `спос_подт_полном`: Способ подтверждения полномочий представителя на подписание документа
• `доп_свед_подп`: Дополнительные сведения
• `фио`: Фамилия, имя, отчество (при наличии)
• `св_довер_эл`: Сведения о доверенности в электронной форме в машиночитаемом виде, используемой для подтверждения полномочий представителя
• `св_довер_бум`: Сведения о доверенности в форме документа на бумажном носителе, используемой для подтверждения полномочий представителя" }, "app__schemas__invoice_nullable__title_v_501_xml_schema______________4": { "properties": { "рекв_наим_док": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Рекв Наим Док" }, "рекв_номер_док": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Рекв Номер Док" }, "рекв_дата_док": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Рекв Дата Док" }, "рекв_ид_файл_док": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Рекв Ид Файл Док" }, "рекв_ид_док": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Рекв Ид Док" }, "р_ид_сист_хран_д": { "type": "string", "maxLength": 500, "minLength": 1, "nullable": true, "title": "Р Ид Сист Хран Д" }, "рекв_урл_сист_док": { "type": "string", "maxLength": 500, "minLength": 1, "nullable": true, "title": "Рекв Урл Сист Док" }, "рекв_доп_свед_док": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Рекв Доп Свед Док" }, "рекв_ид_рек_сост": { "items": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema________________1" }, "type": "array", "title": "Рекв Ид Рек Сост", "default": [] } }, "type": "object", "title": "РеквДокТип", "description": "Реквизиты документа
• `рекв_наим_док`: Наименование документа
• `рекв_номер_док`: Номер документа
• `рекв_дата_док`: Дата документа
• `рекв_ид_файл_док`: Идентификатор файла обмена документа, подписанного первой стороной
• `рекв_ид_док`: Идентификатор документа
• `р_ид_сист_хран_д`: Идентифицирующая информация об информационной системе, в которой осуществляется хранение документа, необходимая для запроса информации из информационной системы
• `рекв_урл_сист_док`: Сведения в формате URL об информационной системе, которая предоставляет техническую возможность получения информации о документе
• `рекв_доп_свед_док`: Дополнительные сведения
• `рекв_ид_рек_сост`: Идентифицирующие реквизиты сторон, составивших документ" }, "app__schemas__invoice_nullable__title_v_501_xml_schema_______________1": { "properties": { "ид_стат": { "type": "string", "enum": [ "ИО", "ИГ" ], "nullable": true, "title": "Ид Стат" }, "код_стр": { "type": "string", "maxLength": 3, "minLength": 3, "pattern": "[0-9]{3}", "nullable": true, "title": "Код Стр" }, "наим_стран": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Стран" }, "наим": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Наим" }, "идентиф": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Идентиф" }, "иные_свед": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Иные Свед" } }, "type": "object", "title": "СвИнНеУчТип", "description": "Сведения об иностранной организации (иностранном гражданине), не состоящей/состоящем на учете в налоговом органе
• `ид_стат`: Идентификация статуса
• `код_стр`: Код страны
• `наим_стран`: Наименование страны
• `наим`: Наименование иностранной организации полное/Фамилия, имя, отчество (при наличии) иностранного гражданина
• `идентиф`: Идентификатор иностранной организации (иностранного гражданина)
• `иные_свед`: Иные сведения для однозначной идентификации иностранной организации (иностранного гражданина)" }, "app__schemas__invoice_nullable__title_v_501_xml_schema_______________3": { "properties": { "номер_счета": { "type": "string", "maxLength": 20, "minLength": 1, "nullable": true, "title": "Номер Счета" }, "наим_банк": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Наим Банк" }, "иннюл": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}", "nullable": true, "title": "Иннюл" }, "кпп": { "type": "string", "maxLength": 9, "minLength": 9, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})([0-9]{2})([0-9A-Z]{2})([0-9]{3})", "nullable": true, "title": "Кпп" }, "бик": { "type": "string", "maxLength": 9, "minLength": 9, "pattern": "[0-9]{9}", "nullable": true, "title": "Бик" }, "кор_счет": { "type": "string", "maxLength": 20, "minLength": 1, "nullable": true, "title": "Кор Счет" }, "swift_код": { "type": "string", "maxLength": 11, "minLength": 8, "nullable": true, "title": "Swift Код" } }, "type": "object", "title": "БанкРеквТип" }, "app__schemas__invoice_nullable__title_v_501_xml_schema________________1": { "properties": { "иннюл": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{8}", "nullable": true, "title": "Иннюл" }, "иннфл": { "type": "string", "maxLength": 12, "minLength": 12, "pattern": "([0-9]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{10}", "nullable": true, "title": "Иннфл" }, "данн_ино": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_______________1", "nullable": true }, "наим_оив": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Оив" } }, "type": "object", "title": "ИдРекСостТип", "description": "Идентифицирующие реквизиты сторон, составивших документ
• `иннюл`: ИНН юридического лица, состоящего на учете в налоговом органе
• `иннфл`: ИНН физического лица, в том числе индивидуального предпринимателя
• `данн_ино`: Данные об иностранной организации (иностранном гражданине), не состоящей на учете в налоговом органе
• `наим_оив`: Наименование органа исполнительной власти (специализированной уполномоченной организации), выдавшего документ" }, "app__schemas__invoice_nullable__title_v_501_xml_schema________________2": { "properties": { "осн_иное": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Осн Иное" }, "осн_рекв_док": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema______________4", "nullable": true } }, "type": "object", "title": "ОснованиеТип" }, "app__schemas__invoice_nullable__title_v_501_xml_schema________________4": { "properties": { "ном_довер": { "type": "string", "maxLength": 36, "minLength": 36, "nullable": true, "title": "Ном Довер" }, "дата_выд_довер": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Выд Довер" }, "вн_ном_довер": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Вн Ном Довер" }, "дата_вн_рег_довер": { "type": "string", "maxLength": 10, "minLength": 10, "pattern": "((((0[1-9]{1}|1[0-9]{1}|2[0-8]{1})\\.(0[1-9]{1}|1[0-2]{1}))|((29|30)\\.(01|0[3-9]{1}|1[0-2]{1}))|(31\\.(01|03|05|07|08|10|12)))\\.((19|20)[0-9]{2}))|(29\\.02\\.((19|20)(((0|2|4|6|8)(0|4|8))|((1|3|5|7|9)(2|6)))))", "nullable": true, "title": "Дата Вн Рег Довер" }, "ид_сист_хран": { "type": "string", "maxLength": 500, "minLength": 1, "title": "Ид Сист Хран" }, "урл_сист": { "type": "string", "maxLength": 500, "minLength": 1, "nullable": true, "title": "Урл Сист" } }, "type": "object", "required": [ "ид_сист_хран" ], "title": "СвДоверЭлТип" }, "app__schemas__invoice_nullable__title_v_501_xml_schema_________________1": { "properties": { "вид_код": { "type": "string", "maxLength": 1, "minLength": 1, "nullable": true, "title": "Вид Код" }, "наим": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим" } }, "type": "object", "title": "ВидНаимКодТип", "description": "Сведения о виде (код) и наименовании адресного элемента
• `вид_код`: Вид (код) элемента
• `наим`: Наименование элемента" }, "app__schemas__invoice_nullable__title_v_501_xml_schema_________________2": { "properties": { "пр_тов_раб": { "type": "string", "enum": [ "1", "2", "3", "4", "5" ], "nullable": true, "title": "Пр Тов Раб" }, "доп_призн": { "type": "string", "maxLength": 4, "minLength": 1, "nullable": true, "title": "Доп Призн" }, "код_происх": { "type": "string", "maxLength": 3, "minLength": 3, "pattern": "[0-9]{3}", "nullable": true, "title": "Код Происх" }, "кр_наим_стр_пр": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Кр Наим Стр Пр" }, "характер_тов": { "type": "string", "maxLength": 1000, "minLength": 1, "nullable": true, "title": "Характер Тов" }, "сорт_тов": { "type": "string", "maxLength": 10, "minLength": 1, "nullable": true, "title": "Сорт Тов" }, "серия_тов": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Серия Тов" }, "артикул_тов": { "type": "string", "maxLength": 50, "minLength": 1, "nullable": true, "title": "Артикул Тов" }, "код_тов": { "type": "string", "maxLength": 100, "minLength": 1, "nullable": true, "title": "Код Тов" }, "код_кат": { "type": "string", "maxLength": 27, "minLength": 27, "nullable": true, "title": "Код Кат" }, "код_вид_тов": { "type": "string", "maxLength": 10, "minLength": 10, "nullable": true, "title": "Код Вид Тов" }, "св_гос_сист": { "items": { "$ref": "#/components/schemas/app__schemas__upd_nullable__seller_title_5_03________________2" }, "type": "array", "title": "Св Гос Сист", "default": [] } }, "type": "object", "title": "ДопСведТовТип" }, "app__schemas__invoice_nullable__title_v_501_xml_schema__________________-Output": { "properties": { "ном_стр": { "type": "string", "decimal_places": 0, "max_digits": 6, "nullable": true, "title": "Ном Стр" }, "наим_тов": { "type": "string", "maxLength": 2000, "minLength": 1, "nullable": true, "title": "Наим Тов" }, "кол_тов": { "type": "string", "decimal_places": 11, "max_digits": 26, "nullable": true, "title": "Кол Тов" }, "океи_тов": { "type": "string", "maxLength": 4, "minLength": 3, "pattern": "(?:[0-9]{3})|(?:[0-9]{4})", "nullable": true, "title": "Океи Тов" }, "наим_ед_изм": { "type": "string", "maxLength": 255, "minLength": 1, "nullable": true, "title": "Наим Ед Изм" }, "цена_тов": { "type": "string", "decimal_places": 11, "max_digits": 26, "nullable": true, "title": "Цена Тов" }, "ст_тов_без_ндс": { "type": "string", "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Ст Тов Без Ндс" }, "ст_тов_уч_нал": { "type": "string", "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Ст Тов Уч Нал" }, "цена_тов_без_ски": { "type": "string", "decimal_places": 11, "max_digits": 26, "nullable": true, "title": "Цена Тов Без Ски" }, "ст_тов_без_ндс_ски": { "type": "string", "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Ст Тов Без Ндс Ски" }, "ст_тов_уч_нал_без_ски": { "type": "string", "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Ст Тов Уч Нал Без Ски" }, "нал_ст": { "type": "string", "enum": [ "0%", "5%", "7%", "9.09%", "10%", "16.67%", "18.03%", "20%", "22%", "5/105", "7/107", "10/110", "20/120", "22/122", "без НДС", "НДС исчисляется налоговым агентом" ], "nullable": true, "title": "Нал Ст" }, "нал_ст_ин": { "type": "string", "maxLength": 35, "minLength": 1, "nullable": true, "title": "Нал Ст Ин" }, "сум_ски": { "type": "string", "decimal_places": 2, "max_digits": 19, "nullable": true, "title": "Сум Ски" }, "процент_ски": { "type": "string", "decimal_places": 0, "max_digits": 2, "nullable": true, "title": "Процент Ски" }, "сум_нал": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema_____________1", "nullable": true }, "сум_нал_без_ски": { "$ref": "#/components/schemas/app__schemas__invoice_full__title_v_501_xml_schema_____________1", "nullable": true }, "доп_свед_тов": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_________________2", "nullable": true }, "инф_пол": { "items": { "$ref": "#/components/schemas/app__schemas__invoice_nullable__title_v_501_xml_schema_____________2" }, "type": "array", "title": "Инф Пол", "default": [] } }, "type": "object", "title": "СведТовЦенПокТип" }, "Body_create_docflow_v4_docflows_post": { "properties": { "file": { "type": "string", "format": "binary", "title": "File", "description": "Файл документа" }, "doctype": { "$ref": "#/components/schemas/VoyagerDoctypeEnum", "description": "Тип документа" }, "number": { "type": "string", "nullable": true, "title": "Number", "description": "Номер документа" }, "date": { "type": "string", "format": "date", "nullable": true, "title": "Date", "description": "Дата документа" }, "is_receiver_signature_expected": { "type": "boolean", "title": "Is Receiver Signature Expected", "description": "Требуется ли ответная подпись" }, "receiver_edo_id": { "type": "string", "title": "Receiver Edo Id", "description": "ID ЭДО пользователя получателя документа" }, "ati_admin_id": { "type": "string", "nullable": true, "title": "Ati Admin Id", "description": "Идентификатор ДО, если документ был создан через АтиАдмин" } }, "type": "object", "required": [ "file", "doctype", "is_receiver_signature_expected", "receiver_edo_id" ], "title": "Body_create_docflow_v4_docflows_post" }, "PreviewResponseSchema": { "properties": { "pages": { "type": "integer", "title": "Pages", "description": "Количество страниц" }, "pattern": { "type": "string", "title": "Pattern", "description": "Шаблон URL для запроса изображения страницы, например '/folder/page_%PAGE%.png'" } }, "type": "object", "required": [ "pages", "pattern" ], "title": "PreviewResponseSchema" }, "VoyagerDoctypeEnum": { "type": "string", "enum": [ "акт", "акт сверки", "счет", "счет-фактура", "договор", "доверенность", "доп. соглашение (к договору)", "информационное письмо", "уведомление об отказе от исполнения", "заказ", "заказ (табличный вид)", "заявка (к договору)", "заявка к договору (табличный вид)", "накладная", "товарная накладная", "товарно-транспортная накладная", "транспортная накладная", "поручение экспедитору", "СЧФДОППродавец", "ДОППродавец", "СЧФ", "ДокументОПередачеРезультатовРаботИсполнитель", "другой" ], "title": "VoyagerDoctypeEnum" }, "DocumentIDSchema": { "properties": { "id": { "type": "string", "title": "Id" } }, "type": "object", "required": [ "id" ], "title": "DocumentIDSchema" }, "RoamingParticipantsSchema": { "properties": { "sender_edo_id": { "type": "string", "nullable": true, "title": "Sender Edo Id", "description": "ID ЭДО пользователя отправителя документа" }, "receiver_edo_id": { "type": "string", "nullable": true, "title": "Receiver Edo Id", "description": "ID ЭДО пользователя получателя документа" }, "receiver_edo_name": { "type": "string", "nullable": true, "title": "Receiver Edo Name", "description": "Имя получателя документооборота" } }, "type": "object", "title": "RoamingParticipantsSchema" }, "Body_verify_account_by_signature_v4_verify_account_by_signature_post": { "properties": { "signature": { "type": "string", "format": "binary", "title": "Signature", "description": "Подпись в формате base64" } }, "type": "object", "required": [ "signature" ], "title": "Body_verify_account_by_signature_v4_verify_account_by_signature_post" }, "CertificateMetaResponseDict": { "properties": { "revoked": { "type": "boolean", "title": "Revoked" }, "created_at": { "type": "string", "format": "date-time", "title": "Created At" } }, "type": "object", "required": [ "revoked", "created_at" ], "title": "CertificateMetaResponseDict" }, "CertificateResponsePublicData": { "properties": { "id": { "type": "string", "title": "Id" }, "body": { "type": "string", "title": "Body" }, "components": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Components" }, "issuer": { "additionalProperties": { "type": "string" }, "type": "object", "title": "Issuer" }, "serial": { "type": "string", "title": "Serial" }, "title": { "type": "string", "title": "Title" }, "valid_from": { "type": "string", "title": "Valid From" }, "valid_until": { "type": "string", "title": "Valid Until" }, "meta": { "$ref": "#/components/schemas/CertificateMetaResponseDict" } }, "type": "object", "required": [ "id", "body", "components", "issuer", "serial", "title", "valid_from", "valid_until", "meta" ], "title": "CertificateResponsePublicData" }, "LegalAddressSchema": { "properties": { "postcode": { "type": "string", "pattern": "^\\d{6}$", "nullable": true, "title": "Postcode", "description": "Почтовый индекс" }, "region_id": { "type": "integer", "title": "Region Id", "description": "Идентификатор региона" }, "district": { "type": "string", "pattern": "^[^,]*$", "nullable": true, "title": "District", "description": "Район", "examples": [ "Выборгский", "Приморский" ] }, "city": { "type": "string", "pattern": "^[^,]*$", "nullable": true, "title": "City", "description": "Город", "examples": [ "Санкт-Петербург", "Москва" ] }, "locality": { "type": "string", "pattern": "^[^,]*$", "nullable": true, "title": "Locality", "description": "Населенный пункт", "examples": [ "Населенный пункт" ] }, "street": { "type": "string", "nullable": true, "title": "Street", "description": "Улица", "examples": [ "Невский проспект" ] }, "house": { "type": "string", "nullable": true, "title": "House", "description": "Дом", "examples": [ "10a" ] }, "apartment": { "type": "string", "nullable": true, "title": "Apartment", "description": "Квартира", "examples": [ "123" ] }, "housing": { "type": "string", "nullable": true, "title": "Housing", "description": "Корпус", "examples": [ "5" ] } }, "type": "object", "required": [ "region_id" ], "title": "LegalAddressSchema" }, "UserAccess": { "type": "object", "properties": { "firm_id": { "type": [ "null", "integer" ], "description": "Идентификатор фирмы.", "format": "int32", "example": 100500 }, "contact_id": { "type": [ "null", "integer" ], "description": "Идентификатор контакта.", "format": "int32", "example": 42 } }, "additionalProperties": false, "description": "Участник доступа к файлу: фирма и/или контакт.", "example": { "firm_id": 100500, "contact_id": 42 } }, "FileInfoPublic": { "type": "object", "properties": { "file_key": { "type": [ "null", "string" ], "description": "Уникальный ключ файла, генерируется сам. Ключ файла будет начинаться с его типа business_type.", "example": "firm_100500_logo" }, "file_key2": { "type": [ "null", "string" ], "description": "Дополнительный ключ файла (связь с другим ключом или дубликат).", "example": "contact_42_avatar_copy" }, "file_name": { "type": [ "null", "string" ], "description": "Имя файла.", "example": "logo.png" }, "content_type": { "type": [ "null", "string" ], "description": "MIME-тип содержимого.", "example": "image/png" }, "access_type": { "enum": [ "Public", "Firm", "Contact", "Authorized" ], "type": "string", "description": "Тип доступа к файлу.\n- Public - Доступ всем без ограничений\n- Firm - Доступ в рамках фирмы\n- Contact - Доступ в рамках контакта\n- Authorized - Доступ для авторизованных пользователей", "example": "Public" }, "file_business_type": { "enum": [ "FirmDocument", "Avatar", "Logo", "Load", "Orders", "CatalogsTrucks", "CatalogsDrivers", "InsurerPrivateDocument", "InsurerPublicDocument" ], "type": "string", "description": "Бизнес-тип файла (аватар, лого и т.д.), влияет на access_type и ограничения.\n- FirmDocument\n- Avatar\n- Logo\n- Load\n- Orders\n- CatalogsTrucks\n- CatalogsDrivers\n- InsurerPrivateDocument\n- InsurerPublicDocument", "example": "Logo" }, "add_date": { "type": "string", "description": "Дата и время добавления записи.", "format": "date-time", "example": "2026-03-31T09:00:00Z" }, "delete_on": { "type": [ "null", "string" ], "description": "Планируемая дата удаления (отложенное удаление).", "format": "date-time", "example": "2026-12-31T00:00:00Z" }, "firm_id": { "type": [ "null", "integer" ], "description": "Идентификатор фирмы-владельца.", "format": "int32", "example": 100500 }, "contact_id": { "type": [ "null", "integer" ], "description": "Идентификатор контакта-владельца.", "format": "int32", "example": 42 }, "access_list": { "type": [ "null", "array" ], "items": { "description": "Участник доступа к файлу: фирма и/или контакт.", "$ref": "#/components/schemas/UserAccess" }, "description": "Список дополнительных участников доступа.", "example": [ { "firm_id": 100500, "contact_id": 42 } ] }, "with_watermark": { "type": [ "null", "boolean" ], "description": "Признак необходимости водяного знака при отдаче.", "example": true }, "binding_tag": { "type": [ "null", "string" ], "description": "Тег привязки (контекст использования файла).", "example": "order-999" } }, "additionalProperties": false, "description": "Документ файла.", "example": { "file_key": "firm_100500_logo", "file_key2": "contact_42_avatar_copy", "file_name": "logo.png", "content_type": "image/png", "access_type": "Public", "file_business_type": "Logo", "add_date": "2026-03-31T09:00:00Z", "delete_on": "2026-12-31T00:00:00Z", "firm_id": 100500, "contact_id": 42, "with_watermark": true, "binding_tag": "order-999", "access_list": [ { "firm_id": 100500, "contact_id": 42 } ] } }, "FileInfoRequestPublic": { "type": "object", "properties": { "ati_id": { "type": [ "null", "string" ], "description": "Идентификатор пользователя ATI.", "example": "100500" }, "contact_id": { "type": [ "null", "integer" ], "description": "Идентификатор контакта для фильтрации файлов.", "format": "int32", "example": 42 }, "business_type": { "enum": [ "FirmDocument", "Avatar", "Logo", "Load", "Orders", "CatalogsTrucks", "CatalogsDrivers", "InsurerPrivateDocument", "InsurerPublicDocument" ], "type": "string", "description": "Бизнес-тип запрашиваемых файлов.\n- FirmDocument\n- Avatar\n- Logo\n- Load\n- Orders\n- CatalogsTrucks\n- CatalogsDrivers\n- InsurerPrivateDocument\n- InsurerPublicDocument", "example": "Avatar" }, "keys": { "type": [ "null", "array" ], "items": { "type": "string" }, "description": "Список ключей файлов (основной набор).", "example": [ "firm_100500_logo", "contact_42_avatar" ] }, "keys2": { "type": [ "null", "array" ], "items": { "type": "string" }, "description": "Дополнительный список ключей файлов.", "example": [ "firm_100500_logo_thumb" ] } }, "additionalProperties": false, "example": { "firm_id": 100500, "ati_id": "100500", "contact_id": 42, "business_type": "Avatar", "keys": [ "firm_100500_logo", "contact_42_avatar" ], "request_firm_id": 100500, "request_contact_id": 42, "keys2": [ "firm_100500_logo_thumb" ] } }, "NotFoundType": { "enum": [ "Status", "Default" ], "type": "string", "description": "Поведение при отсутствии файла при запросе аватара или логотипа.\n- Status (Вернуть статус «не найдено»)\n- Default (Подставить изображение по умолчанию)", "x-ms-enum-flags": { "isFlags": false } }, "file_success": { "type": "object", "properties": { "ok": { "type": "boolean" }, "result": { "type": "object", "properties": { "id": { "type": "string", "title": "Идентификатор файла" }, "fileName": { "type": "string", "title": "Имя файла" }, "size": { "type": "integer", "title": "Размер файла в байтах" }, "mimetype": { "type": "string", "title": "Тип файла" }, "link": { "type": "string", "title": "Ссылка на файл для скачивания" } } } } }, "goslog-service__ErrorResponse": { "type": "object", "properties": { "error": { "type": [ "null", "string" ], "description": "Код ошибки", "example": "string" }, "reason": { "type": [ "null", "string" ], "description": "Текст ошибки для пользователя", "example": "string" } }, "additionalProperties": false, "description": "Стандартный ответ API при ошибке", "example": { "error": "string", "reason": "string" } }, "GoslogExpeditorLookupBatchResponse": { "required": [ "expeditors" ], "type": "object", "properties": { "expeditors": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/GoslogExpeditorLookupItem" }, "description": "Экспедиторы, найденные в реестре (порядок не гарантируется)", "example": [ { "registry_number": "string", "included_at": "string", "ogrn": "string", "inn": "string" } ] } }, "additionalProperties": false, "description": "Ответ на запрос поиска экспедиторов по ИНН", "example": { "expeditors": [ { "registry_number": "string", "included_at": "string", "ogrn": "string", "inn": "string" } ] } }, "GoslogExpeditorLookupItem": { "required": [ "included_at", "inn", "registry_number" ], "type": "object", "properties": { "registry_number": { "type": [ "null", "string" ], "description": "Реестровый номер записи", "example": "string" }, "included_at": { "type": [ "null", "string" ], "description": "Дата включения в реестр (ISO формат)", "example": "string" }, "ogrn": { "type": [ "null", "string" ], "description": "ОГРН", "example": "string" }, "inn": { "type": [ "null", "string" ], "description": "ИНН", "example": "string" } }, "additionalProperties": false, "description": "Запись экспедитора в ответе lookup", "example": { "registry_number": "string", "included_at": "string", "ogrn": "string", "inn": "string" } }, "ErrorFormatResponse": { "title": "Ответ: Формат ответа при ошибке", "required": [ "error_body", "reason", "status_code", "details" ], "type": "object", "properties": { "error_body": { "title": "Error Body", "type": "string", "description": "основное тело ошибки с описанием" }, "reason": { "title": "Reason", "type": "string", "description": "тип ошибки если имеется" }, "status_code": { "title": "Status Code", "type": "integer", "description": "код возвращаемой ошибки" }, "details": { "title": "Details", "type": "object", "description": "какие-либо дополнительные детали ошибки" } } }, "index_ati__HTTPValidationError": { "title": "HTTPValidationError", "type": "object", "properties": { "detail": { "title": "Detail", "type": "array", "items": { "$ref": "#/components/schemas/index_ati__ValidationError" } } } }, "LicenseCurrentIndexRequest": { "title": "Запрос: Входные параметры для получения текущего состояни общего индекса", "required": [ "CarType" ], "type": "object", "properties": { "CarType": { "title": "Тип кузова: [\"all\", \"close\", \"open\", \"ref\"]", "type": "string", "description": "Тип кузова.\n* `ref` - Рефрижераторы.\n* `close` - Закрытые.\n* `open` - Открытые.\n* `all` - Все типы.\n ", "example": "all" } } }, "LicenseCurrentIndexResponse": { "title": "Ответ: Текущее состояние общего индекса", "required": [ "Index", "IndexMovingUp", "Dynamic" ], "type": "object", "properties": { "Index": { "title": "Текущее значение индекса", "type": "integer", "description": "Текущее значение индекса" }, "IndexMovingUp": { "title": "Индикатор роста индекса", "type": "boolean", "description": "Параметр, который показывает, был ли рост индекса по отношению к предыдущему значению" }, "CarType": { "title": "Тип кузова: [\"all\", \"close\", \"open\", \"ref\"]", "type": "string", "description": "Тип кузова.\n* `ref` - Рефрижераторы.\n* `close` - Закрытые.\n* `open` - Открытые.\n* `all` - Все типы.\n " }, "Dynamic": { "title": "Динамика индекса", "allOf": [ { "$ref": "#/components/schemas/LicenseDynamic" } ] } } }, "LicenseDynamic": { "title": "Подпараметр ответа: Динамика индекса", "required": [ "day", "week", "month", "3m", "6m", "ytd", "1y", "3y", "alltime" ], "type": "object", "properties": { "day": { "title": "Динамика за день", "allOf": [ { "$ref": "#/components/schemas/LicenseDynamicValues" } ], "description": "Динамика индекса за день. Значение указано в процентах." }, "week": { "title": "Динамика за неделю", "allOf": [ { "$ref": "#/components/schemas/LicenseDynamicValues" } ], "description": "Динамика индекса за неделю. Значение указано в процентах." }, "month": { "title": "Динамика за месяц", "allOf": [ { "$ref": "#/components/schemas/LicenseDynamicValues" } ], "description": "Динамика индекса за месяц. Значение указано в процентах." }, "3m": { "title": "Динамика за три месяца", "allOf": [ { "$ref": "#/components/schemas/LicenseDynamicValues" } ], "description": "Динамика индекса за три месяца. Значение указано в процентах." }, "6m": { "title": "Динамика за шесть месяцев", "allOf": [ { "$ref": "#/components/schemas/LicenseDynamicValues" } ], "description": "Динамика индекса за шесть месяцев. Значение указано в процентах." }, "ytd": { "title": "Динамика с начала года", "allOf": [ { "$ref": "#/components/schemas/LicenseDynamicValues" } ], "description": "Динамика индекса с начала года. Значение указано в процентах." }, "1y": { "title": "Динамика за год", "allOf": [ { "$ref": "#/components/schemas/LicenseDynamicValues" } ], "description": "Динамика индекса за год. Значение указано в процентах." }, "3y": { "title": "Динамика за три года", "allOf": [ { "$ref": "#/components/schemas/LicenseDynamicValues" } ], "description": "Динамика индекса за три года. Значение указано в процентах." }, "alltime": { "title": "Динамика за все время", "allOf": [ { "$ref": "#/components/schemas/LicenseDynamicValues" } ], "description": "Динамика индекса за все время. Значение указано в процентах." } } }, "LicenseDynamicValues": { "title": "Подпараметр ответа: Значения динамики за период", "required": [ "Delta" ], "type": "object", "properties": { "Delta": { "title": "Дельта индекса, проценты", "type": "number", "description": "Дельта индекса, значение указано в процентах" } } }, "LicenseGeneralIndexRequest": { "title": "Ответ: Динамика общего индекса", "required": [ "DateFrom", "DateTo" ], "type": "object", "properties": { "CarType": { "title": "Тип кузова: [\"all\", \"close\", \"open\", \"ref\"]", "type": "string", "description": "Тип кузова.\n* `ref` - Рефрижераторы.\n* `close` - Закрытые.\n* `open` - Открытые.\n* `all` - Все типы.\n ", "default": "all", "example": "all" }, "DateFrom": { "title": "Начало периода.", "type": "string", "description": "Начало периода. Формат ISO-8601.\n ", "format": "date", "example": "2022-02-01" }, "DateTo": { "title": "Конец периода.", "type": "string", "description": "Конец периода. Формат ISO-8601.\n ", "format": "date", "example": "2022-03-02" } } }, "LicenseGeneralIndexResponse": { "title": "Ответ: Текущее состояние общего индекса", "required": [ "Data" ], "type": "object", "properties": { "CarType": { "title": "Тип кузова: [\"all\", \"close\", \"open\", \"ref\"]", "type": "string", "description": "Тип кузова.\n* `ref` - Рефрижераторы.\n* `close` - Закрытые.\n* `open` - Открытые.\n* `all` - Все типы.\n " }, "Data": { "title": "Набор данных индекса", "type": "array", "items": { "$ref": "#/components/schemas/LicenseTimePoint" }, "description": "Набор данных индекса" } } }, "LicenseTimePoint": { "title": "Подпараметр ответа: Значение индекса в конкретную дату", "required": [ "Date", "Index" ], "type": "object", "properties": { "Date": { "title": "Дата", "type": "string", "description": "Дата, Формат ISO-8601", "format": "date" }, "Index": { "title": "Значение индекса", "type": "integer", "description": "Значение индекса" } } }, "index_ati__ValidationError": { "title": "ValidationError", "required": [ "loc", "msg", "type" ], "type": "object", "properties": { "loc": { "title": "Location", "type": "array", "items": { "type": "string" } }, "msg": { "title": "Message", "type": "string" }, "type": { "title": "Error Type", "type": "string" } } }, "SearchCargoInsurancesIntegrationRequestDto": { "type": "object", "properties": { "skip": { "type": "integer", "description": "Сколько заявок пропустить", "format": "int32", "example": 0 }, "take": { "type": "integer", "description": "Сколько заявок вернуть", "format": "int32", "example": 10 }, "firms": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Список firmId страхователей", "nullable": true, "example": [ 12325 ] }, "status": { "allOf": [ { "$ref": "#/components/schemas/InsuranceIntegrationStatus" } ], "description": "Статус заявки", "nullable": true, "example": "Insured" }, "from_add_date": { "type": "string", "description": "Дата начала периода по дате создания заявки", "format": "date-time", "nullable": true, "example": "2026-05-28T10:00:00+00:00" }, "to_add_date": { "type": "string", "description": "Дата конца периода по дате создания заявки", "format": "date-time", "nullable": true, "example": "2026-05-29T10:00:00+00:00" } }, "additionalProperties": false, "description": "Тело поиска заявок на страхование грузов (интеграционный метод для страховых)", "example": { "skip": 0, "take": 10, "firms": [ 12325 ], "status": "Insured", "from_add_date": "2026-05-28T10:00:00+00:00", "to_add_date": "2026-05-29T10:00:00+00:00" } }, "insurance-service__ErrorResponse": { "type": "object", "properties": { "error": { "type": "string", "description": "Код или тип ошибки.", "nullable": true, "example": "string" }, "reason": { "type": "string", "description": "Подробное описание причины ошибки.", "nullable": true, "example": "string" } }, "additionalProperties": false, "description": "Модель ошибки ответа API.", "example": { "error": "string", "reason": "string" } }, "CargoInsuranceIntegrationListDto": { "type": "object", "properties": { "insurances": { "type": "array", "items": { "$ref": "#/components/schemas/FoundCargoInsuranceIntegrationDto" }, "description": "Заявки на страхование грузов найденных по заданным параметрам поиска.", "nullable": true, "example": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ati_id": "123456", "firm_name": "ООО Ромашка", "account_inn": "7701234567", "firm_requisites": { "requisite_id": "123", "legal_address": { "address_id": "123456", "formatted_text": "Россия, г. Москва, ул. Ленина, д. 1" }, "post_address": { "address_id": "123456", "formatted_text": "Россия, г. Москва, ул. Ленина, д. 1" }, "full_name": "ООО Ромашка", "inn": "7701234567", "ogrn": "1027700123456", "kpp": "770101001", "rs": "40702810900000000001", "ks": "30101810400000000225", "bik": "044525225", "bank": "ПАО Сбербанк", "okpo": "12345678", "signees": [ { "signee_id": 123, "requisite_id": 1234, "full_name": "Иванов Иван Иванович", "position": "Директор", "act_upon": "Устав" } ] }, "change_date": "2026-05-28T10:00:00", "status": "Insured", "status_change_date": "2026-05-28T11:00:00", "start_date": "2026-06-01", "end_date": "2026-12-31", "sum": 150000, "tariff_sum": 3500, "tariff": 2.33, "franchise_sum": 10000, "franchise": 5, "currency": "RUB", "policy_number": "POL-123456", "policy_file_name": "policy.pdf", "policy_file_url": "https://example.com/policy.pdf", "policy_template_file_url": "https://example.com/policy-template.pdf", "invoice_url": "https://example.com/invoice.pdf", "payment_url": "https://example.com/payment", "price_in_policy": true, "client_payment_date": "2026-05-29T14:30:00", "insurer_payment_date": "2026-06-02T09:15:00", "deflected_notice_comment": "Недостаточно документов для оформления полиса", "cargo": { "cargo_type_name": "Бытовая техника", "cargo_name": "Холодильники", "cargo_package_count": 10, "cargo_package_type_name": "Паллеты", "cargo_weight": 12000.5, "cargo_attributes_description": "С хрупкими элементами", "sealing_number": "PL-778899", "is_groupage": false, "cargo_volume": 0, "is_used": false, "is_perishable": false, "is_secured": false, "is_fragile": false, "adr": false, "inc_load_unload": false, "is_fraud_risk": false }, "route_vehicle": { "from_city": "Москва", "to_city": "Санкт-Петербург", "distance": 700000, "vehicle_number": "А123АА77", "document_number_type": "CMR", "document_number": "CMR-123456", "truck_type": "Тягач", "extra_points": [ { "point_type": 1, "address": "Россия, г. Казань, ул. Кремлевская, д. 5", "city_name": "Казань", "city_id": 0 } ], "vehicle_passport_files": [ { "name": "policy.pdf", "url": "https://example.com/policy.pdf" } ], "driver_passport_files": [ { "name": "policy.pdf", "url": "https://example.com/policy.pdf" } ], "driver_license_files": [ { "name": "policy.pdf", "url": "https://example.com/policy.pdf" } ] }, "carrier": { "carrier_inn": "7812345678", "carrier_name": "ООО Перевозчик", "carrier_address": "Россия, г. Санкт-Петербург, Невский пр., д. 1" }, "beneficiary": { "beneficiary_inn": "7701234567", "beneficiary_name": "ООО Выгодоприобретатель", "beneficiary_address": "Россия, г. Москва, ул. Пушкина, д. 10" }, "contact": { "id": 12345, "name": "Иван Иванов", "phone": "+7 900 123-45-67", "email": "ivan@example.com" }, "claim_id": "00000000-0000-0000-0000-000000000000" } ] }, "total": { "type": "integer", "description": "Общее количество заявок на страхование грузов, подходящих под фильтр.", "format": "int32", "example": 5 } }, "additionalProperties": false, "description": "Список заявок на страхование грузов (интеграционный API)", "example": { "total": 5, "insurances": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ati_id": "123456", "firm_name": "ООО Ромашка", "account_inn": "7701234567", "firm_requisites": { "requisite_id": "123", "legal_address": { "address_id": "123456", "formatted_text": "Россия, г. Москва, ул. Ленина, д. 1" }, "post_address": { "address_id": "123456", "formatted_text": "Россия, г. Москва, ул. Ленина, д. 1" }, "full_name": "ООО Ромашка", "inn": "7701234567", "ogrn": "1027700123456", "kpp": "770101001", "rs": "40702810900000000001", "ks": "30101810400000000225", "bik": "044525225", "bank": "ПАО Сбербанк", "okpo": "12345678", "signees": [ { "signee_id": 123, "requisite_id": 1234, "full_name": "Иванов Иван Иванович", "position": "Директор", "act_upon": "Устав" } ] }, "change_date": "2026-05-28T10:00:00", "status": "Insured", "status_change_date": "2026-05-28T11:00:00", "start_date": "2026-06-01", "end_date": "2026-12-31", "sum": 150000, "tariff_sum": 3500, "tariff": 2.33, "franchise_sum": 10000, "franchise": 5, "currency": "RUB", "policy_number": "POL-123456", "policy_file_name": "policy.pdf", "policy_file_url": "https://example.com/policy.pdf", "policy_template_file_url": "https://example.com/policy-template.pdf", "invoice_url": "https://example.com/invoice.pdf", "payment_url": "https://example.com/payment", "price_in_policy": true, "client_payment_date": "2026-05-29T14:30:00", "insurer_payment_date": "2026-06-02T09:15:00", "deflected_notice_comment": "Недостаточно документов для оформления полиса", "cargo": { "cargo_type_name": "Бытовая техника", "cargo_name": "Холодильники", "cargo_package_count": 10, "cargo_package_type_name": "Паллеты", "cargo_weight": 12000.5, "cargo_attributes_description": "С хрупкими элементами", "sealing_number": "PL-778899", "is_groupage": false, "cargo_volume": 0, "is_used": false, "is_perishable": false, "is_secured": false, "is_fragile": false, "adr": false, "inc_load_unload": false, "is_fraud_risk": false }, "route_vehicle": { "from_city": "Москва", "to_city": "Санкт-Петербург", "distance": 700000, "vehicle_number": "А123АА77", "document_number_type": "CMR", "document_number": "CMR-123456", "truck_type": "Тягач", "extra_points": [ { "point_type": 1, "address": "Россия, г. Казань, ул. Кремлевская, д. 5", "city_name": "Казань", "city_id": 0 } ], "vehicle_passport_files": [ { "name": "policy.pdf", "url": "https://example.com/policy.pdf" } ], "driver_passport_files": [ { "name": "policy.pdf", "url": "https://example.com/policy.pdf" } ], "driver_license_files": [ { "name": "policy.pdf", "url": "https://example.com/policy.pdf" } ] }, "carrier": { "carrier_inn": "7812345678", "carrier_name": "ООО Перевозчик", "carrier_address": "Россия, г. Санкт-Петербург, Невский пр., д. 1" }, "beneficiary": { "beneficiary_inn": "7701234567", "beneficiary_name": "ООО Выгодоприобретатель", "beneficiary_address": "Россия, г. Москва, ул. Пушкина, д. 10" }, "contact": { "id": 12345, "name": "Иван Иванов", "phone": "+7 900 123-45-67", "email": "ivan@example.com" }, "claim_id": "00000000-0000-0000-0000-000000000000" } ] } }, "ConfirmPaymentResultDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Идентификатор заявки.", "format": "uuid", "example": "f6f9b9f4-ec4a-4fd6-9d2f-6d3a6db0a4d7" }, "status": { "enum": [ "Sent", "InProgress", "Insured", "Withdrawn", "Request", "Deflected", "Cancelled", "Approved" ], "allOf": [ { "$ref": "#/components/schemas/InsuranceIntegrationStatus" } ], "description": "Статус заявки в интеграционном API.", "example": "Insured" }, "status_change_date": { "type": "string", "description": "Дата и время последнего изменения статуса заявки.", "format": "date-time", "example": "2026-05-28T10:00:00+00:00" }, "success": { "type": "boolean", "description": "Успешно ли подтверждена оплата по заявке.", "example": true }, "error_message": { "type": "string", "description": "Сообщение об ошибке, если подтверждение неуспешно", "nullable": true, "example": "Заявка не найдена" }, "client_payment_date": { "type": "string", "description": "Дата оплаты страхового взноса клиентом", "format": "date-time", "nullable": true, "example": "2026-05-29T14:30:00+00:00" }, "cash_back_sum": { "type": "number", "description": "Сумма кэшбека в атисах", "format": "double", "nullable": true, "example": 150 }, "cash_back_percent": { "type": "number", "description": "Процент кэшбека", "format": "double", "nullable": true, "example": 5 } }, "additionalProperties": false, "description": "Модель ответа на метод подтверждения оплаты клиентов", "example": { "id": "f6f9b9f4-ec4a-4fd6-9d2f-6d3a6db0a4d7", "status": "Insured", "status_change_date": "2026-05-28T10:00:00+00:00", "success": true, "error_message": "Заявка не найдена", "client_payment_date": "2026-05-29T14:30:00+00:00", "cash_back_sum": 150, "cash_back_percent": 5 } }, "CargoInsuranceIntegrationDto": { "required": [ "currency" ], "type": "object", "properties": { "id": { "type": "string", "description": "Идентификатор заявки", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "ati_id": { "type": "string", "description": "Код страхователя в АТИ", "nullable": true, "example": "123456" }, "firm_name": { "type": "string", "description": "Наименование страхователя", "nullable": true, "example": "ООО Ромашка" }, "account_inn": { "type": "string", "description": "Инн", "nullable": true, "example": "7701234567" }, "firm_requisites": { "allOf": [ { "$ref": "#/components/schemas/RequisiteDto" } ], "description": "Реквизиты страхователя", "nullable": true, "example": { "requisite_id": "123", "legal_address": { "address_id": "123456", "formatted_text": "Россия, г. Москва, ул. Ленина, д. 1" }, "post_address": { "address_id": "123456", "formatted_text": "Россия, г. Москва, ул. Ленина, д. 1" }, "full_name": "ООО Ромашка", "inn": "7701234567", "ogrn": "1027700123456", "kpp": "770101001", "rs": "40702810900000000001", "ks": "30101810400000000225", "bik": "044525225", "bank": "ПАО Сбербанк", "okpo": "12345678" } }, "change_date": { "type": "string", "description": "Дата изменения заявки", "format": "date-time", "example": "2026-05-28T10:00:00" }, "status": { "enum": [ "Sent", "InProgress", "Insured", "Withdrawn", "Request", "Deflected", "Cancelled", "Approved" ], "allOf": [ { "$ref": "#/components/schemas/InsuranceIntegrationStatus" } ], "description": "Статус заявки в интеграционном API.", "example": "Insured" }, "status_change_date": { "type": "string", "description": "Дата изменения статуса", "format": "date-time", "example": "2026-05-28T11:00:00" }, "start_date": { "type": "string", "description": "Дата начала действия страховки", "format": "date", "example": "2026-06-01" }, "end_date": { "type": "string", "description": "Дата окончания действия страховки", "format": "date", "example": "2026-12-31" }, "sum": { "type": "number", "description": "Страховая сумма", "format": "double", "example": 150000 }, "tariff_sum": { "type": "number", "description": "Стоимость полиса", "format": "double", "nullable": true, "example": 3500 }, "tariff": { "type": "number", "description": "Процент стоимости полиса от страховой суммы", "format": "double", "nullable": true, "example": 2.33 }, "franchise_sum": { "type": "number", "description": "Франшиза", "format": "double", "nullable": true, "example": 10000 }, "franchise": { "type": "number", "description": "Франшиза в %", "format": "double", "nullable": true, "example": 5 }, "currency": { "type": "string", "description": "Валюта заявки", "nullable": true, "example": "RUB" }, "policy_number": { "type": "string", "description": "Номер полиса", "nullable": true, "example": "POL-123456" }, "policy_file_name": { "type": "string", "description": "Имя файла полиса", "nullable": true, "example": "policy.pdf" }, "policy_file_url": { "type": "string", "description": "Ссылка на файл с полисом страхования", "nullable": true, "example": "https://example.com/policy.pdf" }, "policy_template_file_url": { "type": "string", "description": "Ссылка на шаблон файла с полисом страхования", "nullable": true, "example": "https://example.com/policy-template.pdf" }, "price_in_policy": { "type": "boolean", "description": "Цена в полисе", "example": true }, "cargo": { "allOf": [ { "$ref": "#/components/schemas/CargoDetailsDto" } ], "description": "Информация по грузу", "nullable": true, "example": { "cargo_type_name": "Бытовая техника", "cargo_name": "Холодильники", "cargo_package_count": 10, "cargo_package_type_name": "Паллеты", "cargo_weight": 12000.5, "cargo_attributes_description": "С хрупкими элементами", "sealing_number": "PL-778899", "is_groupage": false } }, "route_vehicle": { "allOf": [ { "$ref": "#/components/schemas/RouteVehicleDto" } ], "description": "Маршрут и ТС", "nullable": true, "example": { "from_city": "Москва", "to_city": "Санкт-Петербург", "distance": 700000, "vehicle_number": "А123АА77", "document_number_type": "CMR", "document_number": "CMR-123456", "truck_type": "Тягач" } }, "carrier": { "allOf": [ { "$ref": "#/components/schemas/CarrierDto" } ], "description": "Перевозчик", "nullable": true, "example": { "carrier_inn": "7812345678", "carrier_name": "ООО Перевозчик", "carrier_address": "Россия, г. Санкт-Петербург, Невский пр., д. 1" } }, "beneficiary": { "allOf": [ { "$ref": "#/components/schemas/BeneficiaryDto" } ], "description": "Выгодопреобретатель", "nullable": true, "example": { "beneficiary_inn": "7701234567", "beneficiary_name": "ООО Выгодоприобретатель", "beneficiary_address": "Россия, г. Москва, ул. Пушкина, д. 10" } }, "contact": { "allOf": [ { "$ref": "#/components/schemas/ContactDto" } ], "description": "Контакт", "nullable": true, "example": { "id": 12345, "name": "Иван Иванов", "phone": "+7 900 123-45-67", "email": "ivan@example.com" } } }, "additionalProperties": false, "description": "Модель страхования грузов для интеграций", "example": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ati_id": "123456", "firm_name": "ООО Ромашка", "account_inn": "7701234567", "firm_requisites": { "requisite_id": "123", "legal_address": { "address_id": "123456", "formatted_text": "Россия, г. Москва, ул. Ленина, д. 1" }, "post_address": { "address_id": "123456", "formatted_text": "Россия, г. Москва, ул. Ленина, д. 1" }, "full_name": "ООО Ромашка", "inn": "7701234567", "ogrn": "1027700123456", "kpp": "770101001", "rs": "40702810900000000001", "ks": "30101810400000000225", "bik": "044525225", "bank": "ПАО Сбербанк", "okpo": "12345678", "signees": [ { "signee_id": 123, "requisite_id": 1234, "full_name": "Иванов Иван Иванович", "position": "Директор", "act_upon": "Устав" } ] }, "change_date": "2026-05-28T10:00:00", "status": "Insured", "status_change_date": "2026-05-28T11:00:00", "start_date": "2026-06-01", "end_date": "2026-12-31", "sum": 150000, "tariff_sum": 3500, "tariff": 2.33, "franchise_sum": 10000, "franchise": 5, "currency": "RUB", "policy_number": "POL-123456", "policy_file_name": "policy.pdf", "policy_file_url": "https://example.com/policy.pdf", "policy_template_file_url": "https://example.com/policy-template.pdf", "price_in_policy": true, "cargo": { "cargo_type_name": "Бытовая техника", "cargo_name": "Холодильники", "cargo_package_count": 10, "cargo_package_type_name": "Паллеты", "cargo_weight": 12000.5, "cargo_attributes_description": "С хрупкими элементами", "sealing_number": "PL-778899", "is_groupage": false, "cargo_volume": 0, "is_used": false, "is_perishable": false, "is_secured": false, "is_fragile": false, "adr": false, "inc_load_unload": false, "is_fraud_risk": false }, "route_vehicle": { "from_city": "Москва", "to_city": "Санкт-Петербург", "distance": 700000, "vehicle_number": "А123АА77", "document_number_type": "CMR", "document_number": "CMR-123456", "truck_type": "Тягач", "extra_points": [ { "point_type": 1, "address": "Россия, г. Казань, ул. Кремлевская, д. 5", "city_name": "Казань", "city_id": 0 } ], "vehicle_passport_files": [ { "name": "policy.pdf", "url": "https://example.com/policy.pdf" } ], "driver_passport_files": [ { "name": "policy.pdf", "url": "https://example.com/policy.pdf" } ], "driver_license_files": [ { "name": "policy.pdf", "url": "https://example.com/policy.pdf" } ] }, "carrier": { "carrier_inn": "7812345678", "carrier_name": "ООО Перевозчик", "carrier_address": "Россия, г. Санкт-Петербург, Невский пр., д. 1" }, "beneficiary": { "beneficiary_inn": "7701234567", "beneficiary_name": "ООО Выгодоприобретатель", "beneficiary_address": "Россия, г. Москва, ул. Пушкина, д. 10" }, "contact": { "id": 12345, "name": "Иван Иванов", "phone": "+7 900 123-45-67", "email": "ivan@example.com" } } }, "DeflectInsuranceRequestDto": { "required": [ "deflected_notice_comment" ], "type": "object", "properties": { "deflected_notice_comment": { "maxLength": 255, "minLength": 0, "type": "string", "description": "Причина отклонения", "example": "Недостаточно документов для оформления" } }, "additionalProperties": false, "description": "Запрос на отклонение заявки на страхование.", "example": { "deflected_notice_comment": "Недостаточно документов для оформления" } }, "InsuranceMutationIntegrationResultDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Идентификатор заявки.", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "status": { "enum": [ "Sent", "InProgress", "Insured", "Withdrawn", "Request", "Deflected", "Cancelled", "Approved" ], "allOf": [ { "$ref": "#/components/schemas/InsuranceIntegrationStatus" } ], "description": "Статус заявки в интеграционном API.", "example": "Insured" }, "status_change_date": { "type": "string", "description": "Дата и время последнего изменения статуса заявки.", "format": "date-time", "example": "2026-05-28T10:00:00+00:00" }, "deflected_notice_comment": { "type": "string", "description": "Текст причины отклонения для страхователя (если заявка отклонена).", "nullable": true, "example": "Недостаточно документов" } }, "additionalProperties": false, "description": "Краткий результат операции над заявкой в интеграционном API (идентификатор, статус и дата смены статуса).", "example": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "status": "Insured", "status_change_date": "2026-05-28T10:00:00+00:00", "deflected_notice_comment": "Недостаточно документов" } }, "FileLinkDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Наименование файла.", "nullable": true, "example": "policy.pdf" }, "url": { "type": "string", "description": "URL файла.", "nullable": true, "example": "https://example.com/policy.pdf" } }, "additionalProperties": false, "description": "Ссылка на файл.", "example": { "name": "policy.pdf", "url": "https://example.com/policy.pdf" } }, "AttachPolicyRequest": { "required": [ "contact_id", "file", "policy_number" ], "type": "object", "properties": { "policy_number": { "minLength": 1, "type": "string", "description": "Номер страхового полиса.", "example": "Полис12345" }, "file": { "allOf": [ { "$ref": "#/components/schemas/FileBase64Dto" } ], "description": "Файл формата base64.", "example": { "file_base64": "JVBERi0xLjQKJ...", "content_type": "application/pdf", "file_name": "Полис_12345.pdf" } }, "contact_id": { "type": "integer", "description": "Идентификатор контакта страховой компании.", "format": "int32", "example": 12345 } }, "additionalProperties": false, "description": "Модель запроса на прикрепление полиса к заявке страхования ответственности.", "example": { "policy_number": "Полис12345", "file": { "file_base64": "JVBERi0xLjQKJ...", "content_type": "application/pdf", "file_name": "Полис_12345.pdf" }, "contact_id": 12345 } }, "InsuranceIntegrationStatus": { "enum": [ "Sent", "InProgress", "Insured", "Withdrawn", "Request", "Deflected", "Cancelled", "Approved" ], "type": "string", "description": "Статус заявки в интеграционном API.\n- Sent (Новая)\n- InProgress (Обрабатывается)\n- Insured (Застрахована)\n- Withdrawn (Отозвана)\n- Request (Запрос)\n- Deflected (Отклонена)\n- Cancelled (Аннулирована)\n- Approved (Одобрена)", "x-ms-enum-flags": { "isFlags": false } }, "FoundCargoInsuranceIntegrationDto": { "required": [ "currency" ], "type": "object", "properties": { "id": { "type": "string", "description": "Идентификатор заявки.", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "ati_id": { "type": "string", "description": "Код страхователя в АТИ.", "nullable": true, "example": "123456" }, "firm_name": { "type": "string", "description": "Наименование страхователя.", "nullable": true, "example": "ООО Ромашка" }, "account_inn": { "type": "string", "description": "ИНН страхователя.", "nullable": true, "example": "7701234567" }, "firm_requisites": { "allOf": [ { "$ref": "#/components/schemas/RequisiteDto" } ], "description": "Реквизиты страхователя.", "nullable": true, "example": { "requisite_id": "123", "legal_address": { "address_id": "123456", "formatted_text": "Россия, г. Москва, ул. Ленина, д. 1" }, "post_address": { "address_id": "123456", "formatted_text": "Россия, г. Москва, ул. Ленина, д. 1" }, "full_name": "ООО Ромашка", "inn": "7701234567", "ogrn": "1027700123456", "kpp": "770101001", "rs": "40702810900000000001", "ks": "30101810400000000225", "bik": "044525225", "bank": "ПАО Сбербанк", "okpo": "12345678" } }, "change_date": { "type": "string", "description": "Дата изменения заявки.", "format": "date-time", "example": "2026-05-28T10:00:00" }, "status": { "enum": [ "Sent", "InProgress", "Insured", "Withdrawn", "Request", "Deflected", "Cancelled", "Approved" ], "allOf": [ { "$ref": "#/components/schemas/InsuranceIntegrationStatus" } ], "description": "Статус заявки в интеграционном API.", "example": "Insured" }, "status_change_date": { "type": "string", "description": "Дата изменения статуса.", "format": "date-time", "example": "2026-05-28T11:00:00" }, "start_date": { "type": "string", "description": "Дата начала действия страховки.", "format": "date", "example": "2026-06-01" }, "end_date": { "type": "string", "description": "Дата окончания действия страховки.", "format": "date", "example": "2026-12-31" }, "sum": { "type": "number", "description": "Страховая сумма.", "format": "double", "example": 150000 }, "tariff_sum": { "type": "number", "description": "Стоимость полиса.", "format": "double", "nullable": true, "example": 3500 }, "tariff": { "type": "number", "description": "Процент стоимости полиса от страховой суммы.", "format": "double", "nullable": true, "example": 2.33 }, "franchise_sum": { "type": "number", "description": "Сумма франшизы.", "format": "double", "nullable": true, "example": 10000 }, "franchise": { "type": "number", "description": "Франшиза в %.", "format": "double", "nullable": true, "example": 5 }, "currency": { "type": "string", "description": "Валюта заявки.", "nullable": true, "example": "RUB" }, "policy_number": { "type": "string", "description": "Номер полиса.", "nullable": true, "example": "POL-123456" }, "policy_file_name": { "type": "string", "description": "Имя файла полиса.", "nullable": true, "example": "policy.pdf" }, "policy_file_url": { "type": "string", "description": "Ссылка на файл полиса.", "nullable": true, "example": "https://example.com/policy.pdf" }, "policy_template_file_url": { "type": "string", "description": "Ссылка на шаблон полиса.", "nullable": true, "example": "https://example.com/policy-template.pdf" }, "invoice_url": { "type": "string", "description": "Ссылка на счёт-фактуру.", "nullable": true, "example": "https://example.com/invoice.pdf" }, "payment_url": { "type": "string", "description": "Ссылка на оплату.", "nullable": true, "example": "https://example.com/payment" }, "price_in_policy": { "type": "boolean", "description": "Цена в полисе.", "example": true }, "client_payment_date": { "type": "string", "description": "Дата оплаты клиентом.", "format": "date-time", "nullable": true, "example": "2026-05-29T14:30:00" }, "insurer_payment_date": { "type": "string", "description": "Дата оплаты страховщику.", "format": "date-time", "nullable": true, "example": "2026-06-02T09:15:00" }, "deflected_notice_comment": { "type": "string", "description": "Комментарий к отклонению.", "nullable": true, "example": "Недостаточно документов для оформления полиса" }, "cargo": { "allOf": [ { "$ref": "#/components/schemas/CargoDetailsDto" } ], "description": "Информация по грузу.", "nullable": true, "example": { "cargo_type_name": "Бытовая техника", "cargo_name": "Холодильники", "cargo_package_count": 10, "cargo_package_type_name": "Паллеты", "cargo_weight": 12000.5, "cargo_attributes_description": "С хрупкими элементами", "sealing_number": "PL-778899", "is_groupage": false } }, "route_vehicle": { "allOf": [ { "$ref": "#/components/schemas/RouteVehicleDto" } ], "description": "Маршрут и ТС.", "nullable": true, "example": { "from_city": "Москва", "to_city": "Санкт-Петербург", "distance": 700000, "vehicle_number": "А123АА77", "document_number_type": "CMR", "document_number": "CMR-123456", "truck_type": "Тягач" } }, "carrier": { "allOf": [ { "$ref": "#/components/schemas/CarrierDto" } ], "description": "Перевозчик.", "nullable": true, "example": { "carrier_inn": "7812345678", "carrier_name": "ООО Перевозчик", "carrier_address": "Россия, г. Санкт-Петербург, Невский пр., д. 1" } }, "beneficiary": { "allOf": [ { "$ref": "#/components/schemas/BeneficiaryDto" } ], "description": "Выгодоприобретатель.", "nullable": true, "example": { "beneficiary_inn": "7701234567", "beneficiary_name": "ООО Выгодоприобретатель", "beneficiary_address": "Россия, г. Москва, ул. Пушкина, д. 10" } }, "contact": { "allOf": [ { "$ref": "#/components/schemas/ContactDto" } ], "description": "Контакт.", "nullable": true, "example": { "id": 12345, "name": "Иван Иванов", "phone": "+7 900 123-45-67", "email": "ivan@example.com" } }, "claim_id": { "type": "string", "description": "Идентификатор претензии.", "format": "uuid", "nullable": true, "example": "00000000-0000-0000-0000-000000000000" } }, "additionalProperties": false, "description": "Модель заявки на страхование груза в списке поиска (интеграционный API).", "example": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "ati_id": "123456", "firm_name": "ООО Ромашка", "account_inn": "7701234567", "firm_requisites": { "requisite_id": "123", "legal_address": { "address_id": "123456", "formatted_text": "Россия, г. Москва, ул. Ленина, д. 1" }, "post_address": { "address_id": "123456", "formatted_text": "Россия, г. Москва, ул. Ленина, д. 1" }, "full_name": "ООО Ромашка", "inn": "7701234567", "ogrn": "1027700123456", "kpp": "770101001", "rs": "40702810900000000001", "ks": "30101810400000000225", "bik": "044525225", "bank": "ПАО Сбербанк", "okpo": "12345678", "signees": [ { "signee_id": 123, "requisite_id": 1234, "full_name": "Иванов Иван Иванович", "position": "Директор", "act_upon": "Устав" } ] }, "change_date": "2026-05-28T10:00:00", "status": "Insured", "status_change_date": "2026-05-28T11:00:00", "start_date": "2026-06-01", "end_date": "2026-12-31", "sum": 150000, "tariff_sum": 3500, "tariff": 2.33, "franchise_sum": 10000, "franchise": 5, "currency": "RUB", "policy_number": "POL-123456", "policy_file_name": "policy.pdf", "policy_file_url": "https://example.com/policy.pdf", "policy_template_file_url": "https://example.com/policy-template.pdf", "invoice_url": "https://example.com/invoice.pdf", "payment_url": "https://example.com/payment", "price_in_policy": true, "client_payment_date": "2026-05-29T14:30:00", "insurer_payment_date": "2026-06-02T09:15:00", "deflected_notice_comment": "Недостаточно документов для оформления полиса", "cargo": { "cargo_type_name": "Бытовая техника", "cargo_name": "Холодильники", "cargo_package_count": 10, "cargo_package_type_name": "Паллеты", "cargo_weight": 12000.5, "cargo_attributes_description": "С хрупкими элементами", "sealing_number": "PL-778899", "is_groupage": false, "cargo_volume": 0, "is_used": false, "is_perishable": false, "is_secured": false, "is_fragile": false, "adr": false, "inc_load_unload": false, "is_fraud_risk": false }, "route_vehicle": { "from_city": "Москва", "to_city": "Санкт-Петербург", "distance": 700000, "vehicle_number": "А123АА77", "document_number_type": "CMR", "document_number": "CMR-123456", "truck_type": "Тягач", "extra_points": [ { "point_type": 1, "address": "Россия, г. Казань, ул. Кремлевская, д. 5", "city_name": "Казань", "city_id": 0 } ], "vehicle_passport_files": [ { "name": "policy.pdf", "url": "https://example.com/policy.pdf" } ], "driver_passport_files": [ { "name": "policy.pdf", "url": "https://example.com/policy.pdf" } ], "driver_license_files": [ { "name": "policy.pdf", "url": "https://example.com/policy.pdf" } ] }, "carrier": { "carrier_inn": "7812345678", "carrier_name": "ООО Перевозчик", "carrier_address": "Россия, г. Санкт-Петербург, Невский пр., д. 1" }, "beneficiary": { "beneficiary_inn": "7701234567", "beneficiary_name": "ООО Выгодоприобретатель", "beneficiary_address": "Россия, г. Москва, ул. Пушкина, д. 10" }, "contact": { "id": 12345, "name": "Иван Иванов", "phone": "+7 900 123-45-67", "email": "ivan@example.com" }, "claim_id": "00000000-0000-0000-0000-000000000000" } }, "RequisiteDto": { "type": "object", "properties": { "requisite_id": { "type": "string", "description": "Id реквизитов", "nullable": true, "example": "123" }, "legal_address": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "description": "Юр. адрес", "nullable": true, "example": { "address_id": "123456", "formatted_text": "Россия, г. Москва, ул. Ленина, д. 1" } }, "post_address": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "description": "Почтовый адрес", "nullable": true, "example": { "address_id": "123456", "formatted_text": "Россия, г. Москва, ул. Ленина, д. 1" } }, "full_name": { "type": "string", "description": "Название фирмы", "nullable": true, "example": "ООО Ромашка" }, "inn": { "type": "string", "description": "ИНН", "nullable": true, "example": "7701234567" }, "ogrn": { "type": "string", "description": "ОГРН", "nullable": true, "example": "1027700123456" }, "kpp": { "type": "string", "description": "КПП", "nullable": true, "example": "770101001" }, "rs": { "type": "string", "description": "Расчётный счёт", "nullable": true, "example": "40702810900000000001" }, "ks": { "type": "string", "description": "Корр. счёт", "nullable": true, "example": "30101810400000000225" }, "bik": { "type": "string", "description": "БИК банка", "nullable": true, "example": "044525225" }, "bank": { "type": "string", "description": "Название банка", "nullable": true, "example": "ПАО Сбербанк" }, "okpo": { "type": "string", "description": "ОКПО", "nullable": true, "example": "12345678" }, "signees": { "type": "array", "items": { "$ref": "#/components/schemas/insurance-service__Signee" }, "description": "Данные подписанта", "nullable": true, "example": [ { "signee_id": 123, "requisite_id": 1234, "full_name": "Иванов Иван Иванович", "position": "Директор", "act_upon": "Устав" } ] } }, "additionalProperties": false, "description": "Реквизиты", "example": { "requisite_id": "123", "legal_address": { "address_id": "123456", "formatted_text": "Россия, г. Москва, ул. Ленина, д. 1" }, "post_address": { "address_id": "123456", "formatted_text": "Россия, г. Москва, ул. Ленина, д. 1" }, "full_name": "ООО Ромашка", "inn": "7701234567", "ogrn": "1027700123456", "kpp": "770101001", "rs": "40702810900000000001", "ks": "30101810400000000225", "bik": "044525225", "bank": "ПАО Сбербанк", "okpo": "12345678", "signees": [ { "signee_id": 123, "requisite_id": 1234, "full_name": "Иванов Иван Иванович", "position": "Директор", "act_upon": "Устав" } ] } }, "CargoDetailsDto": { "type": "object", "properties": { "cargo_type_name": { "type": "string", "description": "Тип груза.", "nullable": true, "example": "Бытовая техника" }, "cargo_name": { "type": "string", "description": "Наименование груза.", "nullable": true, "example": "Холодильники" }, "cargo_package_count": { "type": "number", "description": "Количество мест груза.", "format": "double", "nullable": true, "example": 10 }, "cargo_package_type_name": { "type": "string", "description": "Тип упаковки груза.", "nullable": true, "example": "Паллеты" }, "cargo_weight": { "type": "number", "description": "Вес груза.", "format": "float", "nullable": true, "example": 12000.5 }, "cargo_volume": { "type": "number", "description": "Объём груза.", "format": "float", "nullable": true, "example": 0 }, "cargo_attributes_description": { "type": "string", "description": "Атрибуты груза.", "nullable": true, "example": "С хрупкими элементами" }, "sealing_number": { "type": "string", "description": "Номер пломбы.", "nullable": true, "example": "PL-778899" }, "is_groupage": { "type": "boolean", "description": "Признак сборного груза.", "nullable": true, "example": false }, "is_used": { "type": "boolean", "description": "Признак груза бывшего в употреблении.", "nullable": true, "example": false }, "is_perishable": { "type": "boolean", "description": "Признак скоропортящегося груза.", "nullable": true, "example": false }, "is_secured": { "type": "boolean", "description": "Признак наличия охраны.", "nullable": true, "example": false }, "is_fragile": { "type": "boolean", "description": "Признак груза, подверженного бою/лому.", "nullable": true, "example": false }, "adr": { "type": "boolean", "description": "Опасный, класс опасности.", "nullable": true, "example": false }, "inc_load_unload": { "type": "boolean", "description": "Погрузо-разгрузочные работы.", "nullable": true, "example": false }, "is_fraud_risk": { "type": "boolean", "description": "Риск мошенничества.", "nullable": true, "example": false } }, "additionalProperties": false, "description": "Данные о грузе.", "example": { "cargo_type_name": "Бытовая техника", "cargo_name": "Холодильники", "cargo_package_count": 10, "cargo_package_type_name": "Паллеты", "cargo_weight": 12000.5, "cargo_attributes_description": "С хрупкими элементами", "sealing_number": "PL-778899", "is_groupage": false, "cargo_volume": 0, "is_used": false, "is_perishable": false, "is_secured": false, "is_fragile": false, "adr": false, "inc_load_unload": false, "is_fraud_risk": false } }, "RouteVehicleDto": { "type": "object", "properties": { "from_city": { "type": "string", "description": "Город погрузки.", "nullable": true, "example": "Москва" }, "to_city": { "type": "string", "description": "Город выгрузки.", "nullable": true, "example": "Санкт-Петербург" }, "distance": { "type": "integer", "description": "Расстояние, в м", "format": "int32", "nullable": true, "example": 700000 }, "extra_points": { "type": "array", "items": { "$ref": "#/components/schemas/CargoRouteExtraPointDto" }, "description": "Дополнительные точки маршрута.", "nullable": true, "example": [ { "point_type": 1, "address": "Россия, г. Казань, ул. Кремлевская, д. 5", "city_name": "Казань", "city_id": 0 } ] }, "vehicle_number": { "type": "string", "description": "Государственный номер транспортного средства.", "nullable": true, "example": "А123АА77" }, "document_number_type": { "type": "string", "description": "Тип транспортного документа.", "nullable": true, "example": "CMR" }, "document_number": { "type": "string", "description": "Номер документа.", "nullable": true, "example": "CMR-123456" }, "truck_type": { "type": "string", "description": "Тип транспортного средства.", "nullable": true, "example": "Тягач" }, "vehicle_passport_files": { "type": "array", "items": { "$ref": "#/components/schemas/FileLinkDto" }, "description": "Файлы СТС или ПТС транспортного средства.", "nullable": true, "example": [ { "name": "policy.pdf", "url": "https://example.com/policy.pdf" } ] }, "driver_passport_files": { "type": "array", "items": { "$ref": "#/components/schemas/FileLinkDto" }, "description": "Файлы паспорта водителя.", "nullable": true, "example": [ { "name": "policy.pdf", "url": "https://example.com/policy.pdf" } ] }, "driver_license_files": { "type": "array", "items": { "$ref": "#/components/schemas/FileLinkDto" }, "description": "Файлы водительского удостоверения.", "nullable": true, "example": [ { "name": "policy.pdf", "url": "https://example.com/policy.pdf" } ] } }, "additionalProperties": false, "description": "Данные о маршруте и транспортном средстве.", "example": { "from_city": "Москва", "to_city": "Санкт-Петербург", "distance": 700000, "vehicle_number": "А123АА77", "document_number_type": "CMR", "document_number": "CMR-123456", "truck_type": "Тягач", "extra_points": [ { "point_type": 1, "address": "Россия, г. Казань, ул. Кремлевская, д. 5", "city_name": "Казань", "city_id": 0 } ], "vehicle_passport_files": [ { "name": "policy.pdf", "url": "https://example.com/policy.pdf" } ], "driver_passport_files": [ { "name": "policy.pdf", "url": "https://example.com/policy.pdf" } ], "driver_license_files": [ { "name": "policy.pdf", "url": "https://example.com/policy.pdf" } ] } }, "CarrierDto": { "type": "object", "properties": { "carrier_inn": { "type": "string", "description": "ИНН перевозчика.", "nullable": true, "example": "7812345678" }, "carrier_name": { "type": "string", "description": "Наименование перевозчика.", "nullable": true, "example": "ООО Перевозчик" }, "carrier_address": { "type": "string", "description": "Адрес перевозчика.", "nullable": true, "example": "Россия, г. Санкт-Петербург, Невский пр., д. 1" } }, "additionalProperties": false, "description": "Данные перевозчика.", "example": { "carrier_inn": "7812345678", "carrier_name": "ООО Перевозчик", "carrier_address": "Россия, г. Санкт-Петербург, Невский пр., д. 1" } }, "BeneficiaryDto": { "type": "object", "properties": { "beneficiary_inn": { "type": "string", "description": "ИНН выгодоприобретателя.", "nullable": true, "example": "7701234567" }, "beneficiary_name": { "type": "string", "description": "Наименование выгодоприобретателя.", "nullable": true, "example": "ООО Выгодоприобретатель" }, "beneficiary_address": { "type": "string", "description": "Адрес выгодоприобретателя.", "nullable": true, "example": "Россия, г. Москва, ул. Пушкина, д. 10" } }, "additionalProperties": false, "description": "Данные выгодоприобретателя.", "example": { "beneficiary_inn": "7701234567", "beneficiary_name": "ООО Выгодоприобретатель", "beneficiary_address": "Россия, г. Москва, ул. Пушкина, д. 10" } }, "ContactDto": { "type": "object", "properties": { "id": { "type": "integer", "description": "Id контакта", "format": "int32", "example": 12345 }, "name": { "type": "string", "description": "Имя контакта", "nullable": true, "example": "Иван Иванов" }, "phone": { "type": "string", "description": "Телефон контакта", "nullable": true, "example": "+7 900 123-45-67" }, "email": { "type": "string", "description": "Email контакта", "nullable": true, "example": "ivan@example.com" } }, "additionalProperties": false, "description": "Контакт страхователя", "example": { "id": 12345, "name": "Иван Иванов", "phone": "+7 900 123-45-67", "email": "ivan@example.com" } }, "FileBase64Dto": { "required": [ "file_base64" ], "type": "object", "properties": { "file_base64": { "minLength": 1, "type": "string", "description": "Байтовый контент файла формата base64.", "example": "JVBERi0xLjQKJ..." }, "content_type": { "type": "string", "description": "MIME-тип файла.", "nullable": true, "example": "application/pdf" }, "file_name": { "type": "string", "description": "Название файла.", "nullable": true, "example": "Полис_12345.pdf" } }, "additionalProperties": false, "description": "Файл формата base64.", "example": { "file_base64": "JVBERi0xLjQKJ...", "content_type": "application/pdf", "file_name": "Полис_12345.pdf" } }, "Address": { "type": "object", "properties": { "address_id": { "type": "string", "description": "Id адреса", "nullable": true, "example": "123456" }, "formatted_text": { "type": "string", "description": "Строка адреса", "nullable": true, "example": "Россия, г. Москва, ул. Ленина, д. 1" } }, "additionalProperties": false, "description": "Адрес", "example": { "address_id": "123456", "formatted_text": "Россия, г. Москва, ул. Ленина, д. 1" } }, "insurance-service__Signee": { "type": "object", "properties": { "signee_id": { "type": "string", "description": "id подписанта", "nullable": true, "example": 123 }, "requisite_id": { "type": "string", "description": "id реквизитов", "nullable": true, "example": 1234 }, "full_name": { "type": "string", "description": "ФИО", "nullable": true, "example": "Иванов Иван Иванович" }, "position": { "type": "string", "description": "Должность", "nullable": true, "example": "Директор" }, "act_upon": { "type": "string", "description": "Действует на основании ...", "nullable": true, "example": "Устав" } }, "additionalProperties": false, "description": "Подписант", "example": { "signee_id": 123, "requisite_id": 1234, "full_name": "Иванов Иван Иванович", "position": "Директор", "act_upon": "Устав" } }, "CargoRouteExtraPointDto": { "type": "object", "properties": { "point_type": { "type": "integer", "description": "Тип точки (погрузка/выгрузка).", "format": "int32", "example": 1 }, "address": { "type": "string", "description": "Адрес точки.", "nullable": true, "example": "Россия, г. Казань, ул. Кремлевская, д. 5" }, "city_id": { "type": "integer", "description": "Идентификатор города.", "format": "int32", "nullable": true, "example": 0 }, "city_name": { "type": "string", "description": "Наименование города.", "nullable": true, "example": "Казань" } }, "additionalProperties": false, "description": "Дополнительная точка маршрута груза.", "example": { "point_type": 1, "address": "Россия, г. Казань, ул. Кремлевская, д. 5", "city_name": "Казань", "city_id": 0 } }, "DeleteCargoApplicationsIntegrationRequest": { "required": [ "cargo_application_ids" ], "type": "object", "properties": { "cargo_application_ids": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" }, "description": "Идентификаторы заявок на груз для удаления.", "example": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] } }, "description": "Запрос на удаление нескольких архивных заявок на груз через Integration API." }, "ErrorResponseDetails": { "required": [ "error_code", "reason" ], "type": "object", "properties": { "error_code": { "type": [ "null", "string" ], "description": "Код ошибки.", "example": "validation_error" }, "reason": { "type": [ "null", "string" ], "description": "Сообщение об ошибке.", "example": "Передан невалидный объект" }, "details": { "description": "Дополнительные детали ошибки." }, "error_list": { "type": [ "null", "array" ], "items": { "type": "object" }, "description": "Список ошибок валидации.", "example": [ { "property": "route.loading.address", "reason": "Поле обязательно", "error": "required" } ] } }, "description": "Ответ об ошибке при выполнении операции." }, "ArchiveCargoApplicationsIntegrationRequest": { "required": [ "cargo_application_ids" ], "type": "object", "properties": { "cargo_application_ids": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" }, "description": "Идентификаторы заявок на груз для архивации.", "example": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ] } }, "description": "Запрос на архивацию нескольких заявок на груз через Integration API." }, "CreateCargoApplicationPublicRequest": { "required": [ "cargo_application" ], "type": "object", "properties": { "cargo_application": { "description": "Заявка груза", "$ref": "#/components/schemas/CargoApplicationRequest" } }, "description": "Запрос на создание заявки на груз через Public API." }, "CreateCargoApplicationPublicResponse": { "required": [ "cargo_application" ], "type": "object", "properties": { "cargo_application": { "description": "Заявка груза", "$ref": "#/components/schemas/PublicCargoApplicationResponse" } }, "description": "Ответ на создание заявки на груз через Public API." }, "RefreshCargoApplicationPublicResponse": { "required": [ "refresh_operation_responses" ], "type": "object", "properties": { "refresh_operation_responses": { "type": [ "null", "object" ], "additionalProperties": { "$ref": "#/components/schemas/OperationResponse" }, "description": "Результаты обновления грузов. Ключ — id заявки, значение — результат операции.", "example": { "550e8400-e29b-41d4-a716-446655440000": { "type": "success", "message": "Успешная операция", "status_code": "success" } } } }, "description": "Ответ на обновление (refresh) заявок на груз через Public API." }, "PublicCargoApplicationResponse": { "required": [ "cargo_application_id", "snapshot_id", "cargo_application_number", "department_id", "persistent_user_id", "added_at", "updated_at", "origin_source", "route", "truck", "payment", "boards", "application_contacts" ], "type": "object", "properties": { "cargo_id": { "type": "string", "description": "ID груза OBSOLETE используй поле `CargoApplicationId`", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "cargo_number": { "type": "string", "description": "Номер груза, автоматически генерируемый ATI.SU OBSOLETE используй поле `CargoApplicationNumber`", "example": "ABC1234" }, "source": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "description": "OBSOLETE используй поле `OriginSource`", "format": "int32", "example": 2 }, "contacts": { "type": "array", "items": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "description": "Контакты OBSOLETE используй поле ApplicationContacts", "example": [ 0 ] }, "distance": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "description": "Дистанция, км", "format": "int32", "example": 1794 }, "cargo_application_id": { "type": "string", "description": "Id груза", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "snapshot_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "description": "Id состояния груза (меняется при каждом редактировании)", "format": "int64", "example": 1000500 }, "cargo_application_number": { "type": "string", "description": "Номер груза, автоматически генерируемый ATI.SU", "example": "ABC1234" }, "department_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "description": "Подразделение, которому принадлежит заявка.", "format": "int32", "example": 7654321 }, "persistent_user_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "description": "Идентификатор пользователя, разместившего заявку", "format": "int32", "example": 1234567 }, "actor_contact_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Идентификатор контакта, разместившего заявку", "format": "int32", "example": 0 }, "external_id": { "type": [ "null", "string" ], "description": "Внешний номер груза или заказа", "example": "EXT-12345" }, "added_at": { "type": "string", "description": "Время добавления груза, UTC", "format": "date-time", "example": "2024-01-15T10:30:00+00:00" }, "updated_at": { "type": "string", "description": "Время последнего изменения груза, UTC", "format": "date-time", "example": "2024-01-15T10:30:00+00:00" }, "refreshed_at": { "type": "string", "description": "Время последнего поднятия груза, UTC", "format": "date-time", "example": "2024-01-15T10:30:00+00:00" }, "origin_source": { "type": "string", "description": "Использованный api при создания груза: - `web-cargos-api`, - `mobile-cargos-api`, - `public-cargos-api`", "example": "public-cargos-api" }, "route": { "description": "Маршрут", "$ref": "#/components/schemas/RouteResponse" }, "truck": { "description": "Транспорт", "$ref": "#/components/schemas/TruckResponse" }, "payment": { "description": "Оплата", "$ref": "#/components/schemas/PaymentResponse" }, "boards": { "type": "array", "items": { "$ref": "#/components/schemas/BoardPlacementResponse" }, "description": "Площадки груза", "example": [ { "id": "a0a0a0a0a0a0a0a0a0a0a0a0", "publication_mode": "now", "publication_time": "2024-01-15T10:30:00+00:00", "cancel_publish_on_auction_bet": true, "reservation_enabled": true, "is_published": true } ] }, "documents": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DocumentResponse" }, "description": "Фото груза и документов", "example": [ { "id": "9c6cce94-c0e3-eb11-bb99-002590fdcfdb", "file_id": "6b35842b8386446c82a43726f139abe1", "name": "Транспортная накладная.pdf", "link": "https://api.ati.su/webapi/filestorage/files/6b35842b8386446c82a43726f139abe1" } ] }, "application_contacts": { "type": "array", "items": { "$ref": "#/components/schemas/ContactInformationResponse" }, "description": "Информация о контактах груза", "example": [ { "id": 0 } ] }, "paid_features": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PaidFeaturesResponse" } ], "description": "Платные услуги" }, "note": { "type": [ "null", "string" ], "description": "Примечание к грузу", "example": "Тестовый груз" }, "lot_id": { "type": [ "null", "string" ], "description": "Id Лота, к которому прикреплён данный груз", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "lot_number": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Номер Лота, к которому прикреплён данный груз", "format": "int32", "example": 38 }, "is_pass_through_copy": { "type": [ "null", "boolean" ], "description": "Является ли груз сквозной копией", "example": true }, "is_archived": { "type": [ "null", "boolean" ], "description": "Отправлен ли груз в архив", "example": true }, "archive_date": { "type": [ "null", "string" ], "description": "Время отправки груза в архив, UTC", "format": "date-time", "example": "2024-01-15T10:30:00+00:00" }, "true_price": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Истинная ставка на груз после жалоб \"Озвученная ставка\"", "format": "int32", "example": 50000 }, "true_currency_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Истинная валюта ставки на груз после жалоб \"Озвученная ставка\"", "format": "int32", "example": 1 }, "client_application_id": { "type": [ "null", "string" ], "description": "Идентификатор интегратора (клиентского приложения), через которое был создан груз", "example": "ati" } }, "description": "Контракт заявки груза, ожидаемый в ответах публичного http api работы с грузами" }, "UpdateCargoApplicationPublicRequest": { "required": [ "cargo_application" ], "type": "object", "properties": { "cargo_application": { "description": "Заявка груза", "$ref": "#/components/schemas/CargoApplicationRequest" } }, "description": "Запрос на обновление заявки на груз через Public API." }, "UpdateCargoApplicationPublicResponse": { "required": [ "cargo_application" ], "type": "object", "properties": { "cargo_application": { "description": "Заявка груза", "$ref": "#/components/schemas/PublicCargoApplicationResponse" } }, "description": "Ответ на обновление заявки на груз через Public API." }, "RestoreCargoApplicationPublicRequest": { "required": [ "cargo_application" ], "type": "object", "properties": { "cargo_application": { "description": "Заявка груза", "$ref": "#/components/schemas/CargoApplicationRequest" } }, "description": "Запрос на восстановление заявки на груз через Public API." }, "OperationResponse": { "required": [ "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/OperationResponseErrorResponseDetails" }, { "$ref": "#/components/schemas/SuccessOperationResponse" } ], "description": "Базовый ответ результата операции.", "discriminator": { "propertyName": "type", "mapping": { "error": "#/components/schemas/OperationResponseErrorResponseDetails", "success": "#/components/schemas/SuccessOperationResponse" } } }, "CargoApplicationRequest": { "required": [ "route", "truck", "payment", "contacts" ], "type": "object", "properties": { "external_id": { "maxLength": 250, "minLength": 0, "type": [ "null", "string" ], "description": "Внешний номер груза или заказа Поле не должно содержать emoji-символы и emoji-последовательности", "example": "EXT-12345" }, "route": { "description": "Маршрут", "$ref": "#/components/schemas/RouteRequest" }, "truck": { "description": "Транспорт", "$ref": "#/components/schemas/TruckRequest" }, "payment": { "description": "Оплата", "$ref": "#/components/schemas/PaymentRequest" }, "documents": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DocumentRequest" }, "description": "Фото груза и документов", "example": [ { "id": "9c6cce94-c0e3-eb11-bb99-002590fdcfdb", "file_id": "6b35842b8386446c82a43726f139abe1" } ] }, "boards": { "type": "array", "items": { "$ref": "#/components/schemas/BoardPlacementRequest" }, "description": "Площадки груза", "example": [ { "id": "a0a0a0a0a0a0a0a0a0a0a0a0", "publication_mode": "now", "publication_time": "2024-01-15T10:30:00+00:00", "cancel_publish_on_auction_bet": true, "reservation_enabled": true } ] }, "paid_features": { "description": "Платные услуги: приоритетный показ, стелс", "$ref": "#/components/schemas/PaidFeaturesRequest" }, "note": { "maxLength": 1000, "type": [ "null", "string" ], "description": "Примечание к заявке Поле не должно содержать emoji-символы и emoji-последовательности", "example": "Тестовый груз" }, "contacts": { "type": "array", "items": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "description": "Id контактов заявки", "example": [ 0 ] } }, "description": "Параметры заявки на груз." }, "RouteResponse": { "required": [ "loading", "unloading" ], "type": "object", "properties": { "loading": { "description": "Загрузка", "$ref": "#/components/schemas/PrimaryLoadingPointResponse" }, "unloading": { "description": "Разгрузка", "$ref": "#/components/schemas/PrimaryUnloadingPointResponse" }, "way_points": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/WayPointResponse" }, "description": "Точки маршрута", "example": [ { "type": "loading", "city_id": 3611, "city": { "city_id": 3611, "region_id": 21, "country_id": 1 }, "address": "ул. Набережная, д. 12" } ] }, "is_round_trip": { "type": [ "null", "boolean" ], "description": "Кругорейс", "example": true } }, "description": "Маршрут." }, "TruckResponse": { "required": [ "trucks_count", "load_type", "body_types", "is_tracking" ], "type": "object", "properties": { "trucks_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "description": "Количество машин", "format": "int32", "example": 1 }, "load_type": { "type": "string", "description": "Загрузка: - `ftl` — отдельной машиной - `dont-care` — не важно", "example": "ftl" }, "body_types": { "type": "array", "items": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "description": "TypeId типов кузовов. Значение TypeId из словаря кузовов", "example": [ 200, 100 ] }, "is_tracking": { "type": "boolean", "description": "Трекинг через АТИ Водитель", "example": true }, "adr": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "ADR", "format": "int32", "example": 3 }, "belts_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Количество ремней", "format": "int32", "example": 4 }, "required_capacity": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "description": "Требуемая грузоподъемность в тоннах", "format": "double", "example": 20 }, "body_loading": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/TruckLoadTypeResponse" } ], "description": "Способы загрузки" }, "body_unloading": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/TruckLoadTypeResponse" } ], "description": "Способы разгрузки" }, "temperature": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/TemperatureResponse" } ], "description": "Температура" }, "documents": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/TruckDocumentsResponse" } ], "description": "Разрешения" }, "requirements": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/TruckRequirementsResponse" } ], "description": "Требования" } }, "description": "Транспорт." }, "PaymentResponse": { "required": [ "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/WithBargainingPaymentResponse" }, { "$ref": "#/components/schemas/WithoutBargainingPaymentResponse" }, { "$ref": "#/components/schemas/RateRequestPaymentResponse" }, { "$ref": "#/components/schemas/AuctionPaymentResponse" } ], "description": "Оплата.", "discriminator": { "propertyName": "type", "mapping": { "with-bargaining": "#/components/schemas/WithBargainingPaymentResponse", "without-bargaining": "#/components/schemas/WithoutBargainingPaymentResponse", "rate-request": "#/components/schemas/RateRequestPaymentResponse", "auction": "#/components/schemas/AuctionPaymentResponse" } } }, "BoardPlacementResponse": { "required": [ "id", "publication_mode", "publication_time", "cancel_publish_on_auction_bet", "reservation_enabled", "is_published" ], "type": "object", "properties": { "id": { "type": "string", "description": "Id площадки", "example": "a0a0a0a0a0a0a0a0a0a0a0a0" }, "publication_mode": { "type": "string", "description": "Опубликовать груз: now – сразу `15m` – через 15 минут `30m` – через 30 минут `1h` – через час `3h` – через 3 часа `6h` – через 6 часов `exact-time` - в точное время", "example": "now" }, "publication_time": { "type": "string", "description": "Точное время публикации груза, для publication_mode = 'exact-time'", "format": "date-time", "example": "2024-01-15T10:30:00+00:00" }, "cancel_publish_on_auction_bet": { "type": "boolean", "description": "Не публиковать груз при отложенной публикации, если появилась ставка по Торгам", "example": true }, "publication_restriction": { "description": "Стратегия ограничений публикации груза на площадке", "examples": [ 0 ], "$ref": "#/components/schemas/PublicationRestriction" }, "reservation_enabled": { "type": "boolean", "description": "Разрешить перевозчикам бронировать груз", "example": true }, "is_published": { "type": "boolean", "description": "Груз опубликован на площадке", "example": true } }, "description": "Площадка размещения груза." }, "DocumentResponse": { "required": [ "file_id", "name", "link" ], "type": "object", "properties": { "id": { "type": "string", "description": "Старый id документа OBSOLETE используй поле FileID", "example": "9c6cce94-c0e3-eb11-bb99-002590fdcfdb" }, "file_id": { "type": "string", "description": "Id документа в API Плюшкин (TODO ссылка)", "example": "6b35842b8386446c82a43726f139abe1" }, "name": { "type": "string", "description": "Название документа", "example": "Транспортная накладная.pdf" }, "link": { "type": "string", "description": "Ссылка на документ", "example": "https://api.ati.su/webapi/filestorage/files/6b35842b8386446c82a43726f139abe1" } }, "description": "Фото груза или документа." }, "ContactInformationResponse": { "required": [ "id" ], "type": "object", "properties": { "id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "description": "Id контакта", "format": "int32", "example": 0 } }, "description": "Контактная информация по грузу." }, "PaidFeaturesResponse": { "type": "object", "properties": { "priority_view": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PriorityViewResponse" } ], "description": "Приоритетный показ" }, "stealth": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StealthResponse" } ], "description": "Стэлс" } }, "description": "Платные услуги: приоритетный показ, стелс." }, "OperationResponseErrorResponseDetails": { "required": [ "error_code", "reason" ], "properties": { "type": { "enum": [ "error" ], "type": "string", "description": "Тип результата операции:\n- `error` — ошибка при выполнении операции\n- `success` — успех при выполнении операции", "example": "success" }, "error_code": { "type": [ "null", "string" ], "description": "Код ошибки.", "example": "validation_error" }, "reason": { "type": [ "null", "string" ], "description": "Сообщение об ошибке.", "example": "Передан невалидный объект" }, "details": { "description": "Дополнительные детали ошибки." }, "error_list": { "type": [ "null", "array" ], "items": { "type": "object" }, "description": "Список ошибок валидации.", "example": [ { "property": "route.loading.address", "reason": "Поле обязательно", "error": "required" } ] } }, "description": "Ответ об ошибке при выполнении операции." }, "SuccessOperationResponse": { "properties": { "type": { "enum": [ "success" ], "type": "string", "description": "Тип результата операции:\n- `error` — ошибка при выполнении операции\n- `success` — успех при выполнении операции", "example": "success" }, "message": { "type": [ "null", "string" ], "description": "Сообщение об успешном выполнении операции.", "example": "Успешная операция" }, "status_code": { "type": [ "null", "string" ], "description": "Код статуса операции.", "example": "success" } }, "description": "Ответ об успешном выполнении операции." }, "RouteRequest": { "required": [ "loading", "unloading" ], "type": "object", "properties": { "loading": { "description": "Загрузка", "$ref": "#/components/schemas/PrimaryLoadingPointRequest" }, "unloading": { "description": "Разгрузка", "$ref": "#/components/schemas/PrimaryUnloadingPointRequest" }, "way_points": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/WayPointRequest" }, "description": "Точки маршрута", "example": [ { "type": "loading", "city_id": 3611, "address": "Набережная" } ] }, "is_round_trip": { "type": [ "null", "boolean" ], "description": "Кругорейс", "example": true } }, "description": "Маршрут." }, "TruckRequest": { "required": [ "load_type", "body_types" ], "type": "object", "properties": { "trucks_count": { "maximum": 99, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Количество машин", "format": "int32", "default": 1, "example": 1 }, "load_type": { "type": "string", "description": "Загрузка: - `ftl` — отдельной машиной - `ltl` — догрузом - `dont-care` — отдельной машиной или догрузом", "example": "ftl" }, "body_types": { "type": "array", "items": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "description": "TypeId типов кузовов. Значение TypeId из словаря кузовов", "example": [ 200, 100 ] }, "body_loading": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/TruckLoadTypeRequest" } ], "description": "Способы загрузки" }, "body_unloading": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/TruckLoadTypeRequest" } ], "description": "Способы разгрузки" }, "temperature": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/TemperatureRequest" } ], "description": "Температура" }, "documents": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/TruckDocumentsRequest" } ], "description": "Разрешения" }, "requirements": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/TruckRequirementsRequest" } ], "description": "Требования" }, "adr": { "maximum": 9, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "ADR", "format": "int32", "example": 3 }, "belts_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Количество ремней", "format": "int32", "example": 4 }, "is_tracking": { "type": [ "null", "boolean" ], "description": "Трекинг через АТИ Водитель", "example": true }, "required_capacity": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "description": "Требуемая грузоподъемность в тоннах", "format": "double", "example": 20 } }, "description": "Транспорт." }, "PaymentRequest": { "required": [ "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/WithBargainingPaymentRequest" }, { "$ref": "#/components/schemas/WithoutBargainingPaymentRequest" }, { "$ref": "#/components/schemas/RateRequestPaymentRequest" }, { "$ref": "#/components/schemas/AuctionPaymentRequest" } ], "description": "Оплата.", "discriminator": { "propertyName": "type", "mapping": { "with-bargaining": "#/components/schemas/WithBargainingPaymentRequest", "without-bargaining": "#/components/schemas/WithoutBargainingPaymentRequest", "rate-request": "#/components/schemas/RateRequestPaymentRequest", "auction": "#/components/schemas/AuctionPaymentRequest" } } }, "DocumentRequest": { "type": "object", "properties": { "id": { "type": "string", "description": "Старый id документа", "example": "9c6cce94-c0e3-eb11-bb99-002590fdcfdb" }, "file_id": { "type": "string", "description": "Новый id документа", "example": "6b35842b8386446c82a43726f139abe1" } }, "description": "Фото груза или документа." }, "BoardPlacementRequest": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "string", "description": "Id площадки", "example": "a0a0a0a0a0a0a0a0a0a0a0a0" }, "publication_mode": { "type": "string", "description": "Опубликовать груз - `now` – сразу - `15m` – через 15 минут - `30m` – через 30 минут - `1h` – через час - `3h` – через 3 часа - `6h` – через 6 часов - `exact-time` - в точное время", "default": "now", "example": "now" }, "publication_time": { "type": [ "null", "string" ], "description": "Точное время публикации груза, для `publication_mode = 'exact-time'`", "format": "date-time", "example": "2024-01-15T10:30:00+00:00" }, "cancel_publish_on_auction_bet": { "type": [ "null", "boolean" ], "description": "Не публиковать груз при отложенной публикации, если появилась ставка по Торгам", "example": true }, "reservation_enabled": { "type": [ "null", "boolean" ], "description": "Разрешить перевозчикам бронировать груз", "example": true } }, "description": "Площадка размещения груза." }, "PaidFeaturesRequest": { "type": "object", "properties": { "priority_view": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PriorityViewRequest" } ], "description": "Приоритетный показ" }, "stealth": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/StealthResponse" } ], "description": "Стэлс" } }, "description": "Платные услуги: приоритетный показ, стелс." }, "PrimaryLoadingPointResponse": { "required": [ "dates", "cargos", "city_id", "city" ], "type": "object", "properties": { "near_cities": { "type": [ "null", "array" ], "items": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "description": "Ближайшие города. Id города из словаря OBSOLETE используй поле NearbyCities", "example": [ 3611 ] }, "dates": { "description": "Даты загрузки", "$ref": "#/components/schemas/LoadingDateResponse" }, "cargos": { "type": "array", "items": { "$ref": "#/components/schemas/LoadingCargoResponse" }, "description": "Параметры грузов на загрузку", "example": [ { "name_id": 112, "name": "Автомобиль(ли)", "packaging": { "type": 2, "quantity": 20 }, "cargo_id": 1, "weight": { "type": "tons", "quantity": 20 }, "volume": { "quantity": 20 }, "sizes": { "diameter": 1.2 } } ] }, "nearby_cities": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/NearbyCityResponse" }, "description": "Ближайшие крупные города", "example": [ { "id": 3611, "distance": 25 } ] }, "city_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "description": "Id города из словаря OBSOLETE используй поле City.CityId", "format": "int32", "example": 3611 }, "city": { "description": "Информация о населённом пункте", "$ref": "#/components/schemas/CityPointResponse" }, "coordinates": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CoordinatesResponse" } ], "description": "Координаты" }, "address": { "type": [ "null", "string" ], "description": "Адрес в населённом пункте", "example": "ул. Набережная, д. 12" }, "organization": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrganizationResponse" } ], "description": "Данные об организации из справочника (TODO ссылка на api), если она была указана в качестве адреса" } }, "description": "Основная точка загрузки." }, "PrimaryUnloadingPointResponse": { "required": [ "city_id", "city" ], "type": "object", "properties": { "near_cities": { "type": [ "null", "array" ], "items": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "description": "Ближайшие города. Id города из словаря OBSOLETE используй поле NearbyCities", "example": [ 3611 ] }, "dates": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UnloadingDatesResponse" } ], "description": "Даты разгрузки" }, "nearby_cities": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/NearbyCityResponse" }, "description": "Ближайшие крупные города", "example": [ { "id": 3611, "distance": 25 } ] }, "city_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "description": "Id города из словаря OBSOLETE используй поле City.CityId", "format": "int32", "example": 3611 }, "city": { "description": "Информация о населённом пункте", "$ref": "#/components/schemas/CityPointResponse" }, "coordinates": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CoordinatesResponse" } ], "description": "Координаты" }, "address": { "type": [ "null", "string" ], "description": "Адрес в населённом пункте", "example": "ул. Набережная, д. 12" }, "organization": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrganizationResponse" } ], "description": "Данные об организации из справочника (TODO ссылка на api), если она была указана в качестве адреса" } }, "description": "Основная точка разгрузки." }, "WayPointResponse": { "required": [ "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/LoadingWayPointResponse" }, { "$ref": "#/components/schemas/UnloadingWayPointResponse" }, { "$ref": "#/components/schemas/CustomsWayPointResponse" }, { "$ref": "#/components/schemas/GoThroughWayPointResponse" } ], "description": "Промежуточная точка маршрута.", "discriminator": { "propertyName": "type", "mapping": { "loading": "#/components/schemas/LoadingWayPointResponse", "unloading": "#/components/schemas/UnloadingWayPointResponse", "customs": "#/components/schemas/CustomsWayPointResponse", "go-through": "#/components/schemas/GoThroughWayPointResponse" } } }, "TruckLoadTypeResponse": { "required": [ "types", "is_all_required" ], "type": "object", "properties": { "types": { "type": "array", "items": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "description": "Id типа загрузки из словаря типов загрузок", "example": [ 1, 4, 8 ] }, "is_all_required": { "type": "boolean", "description": "Обязательны все выбранные", "example": true } }, "description": "Способы загрузки или разгрузки." }, "TemperatureResponse": { "type": "object", "properties": { "from": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "От", "format": "int32", "example": -18 }, "to": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "До", "format": "int32", "example": 5 } }, "description": "Температура." }, "TruckDocumentsResponse": { "required": [ "tir", "cmr", "t1", "medical_card" ], "type": "object", "properties": { "tir": { "type": "boolean", "description": "TIR", "example": true }, "cmr": { "type": "boolean", "description": "CMR", "example": true }, "t1": { "type": "boolean", "description": "T1", "example": true }, "medical_card": { "type": "boolean", "description": "Медкнижка", "example": true } }, "description": "Разрешения транспорта." }, "TruckRequirementsResponse": { "required": [ "logging_truck", "road_train", "air_suspension", "team_driving" ], "type": "object", "properties": { "logging_truck": { "type": "boolean", "description": "Коники", "example": true }, "road_train": { "type": "boolean", "description": "Сцепка", "example": true }, "air_suspension": { "type": "boolean", "description": "Пневмоход", "example": true }, "team_driving": { "type": "boolean", "description": "Для груза необходимы два водителя", "example": true } }, "description": "Требования к транспорту." }, "WithBargainingPaymentResponse": { "required": [ "currency_type", "hide_counter_offers", "direct_offer" ], "properties": { "type": { "enum": [ "with-bargaining" ], "type": "string", "description": "Тип оплаты — с возможностью торга (`with-bargaining`).", "example": "with-bargaining" }, "auto_invites_settings": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AutoInvitesSettingsResponse" } ], "description": "Настройки автоматического приглашения на лучшее встречное предложение" }, "currency_type": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "description": "Id валюты из словаря валют", "format": "int32", "example": 1 }, "rate_with_vat": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "description": "Ставка безнал с НДС", "format": "double", "example": 50000 }, "rate_without_vat": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "description": "Ставка безнал без НДС", "format": "double", "example": 50000 }, "cash": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "description": "Ставка наличными", "format": "double", "example": 50000 }, "on_card": { "type": [ "null", "boolean" ], "description": "Возможность отправлять наличные на карту", "example": true }, "rates_with_vat": { "type": "array", "items": { "$ref": "#/components/schemas/RateWithVatResponse" }, "description": "Безналичные ставки с НДС", "example": [ { "rate_with_vat": 50000, "vat_percent": 20 } ] }, "hide_counter_offers": { "type": "boolean", "description": "Встречные предложения видны только вам", "example": true }, "direct_offer": { "type": "boolean", "description": "Прямой договор", "example": true }, "prepayment": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PrepaymentResponse" } ], "description": "Предоплата" }, "payment_mode": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PaymentModeResponse" } ], "description": "Режим оплаты" } }, "description": "Оплата с торгом." }, "WithoutBargainingPaymentResponse": { "required": [ "currency_type", "hide_counter_offers", "direct_offer" ], "properties": { "type": { "enum": [ "without-bargaining" ], "type": "string", "description": "Тип оплаты — без возможности торга (`without-bargaining`).", "example": "without-bargaining" }, "currency_type": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "description": "Id валюты из словаря валют", "format": "int32", "example": 1 }, "rate_with_vat": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "description": "Ставка безнал с НДС", "format": "double", "example": 50000 }, "rate_without_vat": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "description": "Ставка безнал без НДС", "format": "double", "example": 50000 }, "cash": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "description": "Ставка наличными", "format": "double", "example": 50000 }, "on_card": { "type": [ "null", "boolean" ], "description": "Возможность отправлять наличные на карту", "example": true }, "rates_with_vat": { "type": "array", "items": { "$ref": "#/components/schemas/RateWithVatResponse" }, "description": "Безналичные ставки с НДС", "example": [ { "rate_with_vat": 50000, "vat_percent": 20 } ] }, "hide_counter_offers": { "type": "boolean", "description": "Встречные предложения видны только вам", "example": true }, "direct_offer": { "type": "boolean", "description": "Прямой договор", "example": true }, "prepayment": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PrepaymentResponse" } ], "description": "Предоплата" }, "payment_mode": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PaymentModeResponse" } ], "description": "Режим оплаты" } }, "description": "Оплата без торга." }, "RateRequestPaymentResponse": { "required": [ "rate_with_vat_available", "rate_without_vat_available", "cash_available", "hide_counter_offers", "direct_offer" ], "properties": { "type": { "enum": [ "rate-request" ], "type": "string", "description": "Тип оплаты — запрос ставки (`rate-request`).", "example": "rate-request" }, "rate_with_vat_available": { "type": "boolean", "description": "Можно предлагать ставки безнал с НДС", "example": true }, "rate_without_vat_available": { "type": "boolean", "description": "Можно предлагать ставки безнал без НДС", "example": true }, "cash_available": { "type": "boolean", "description": "Можно предлагать ставки наличными", "example": true }, "auto_invites_settings": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AutoInvitesSettingsResponse" } ], "description": "Настройки автоматического приглашения на лучшее встречное предложение" }, "hide_counter_offers": { "type": "boolean", "description": "Встречные предложения видны только вам", "example": true }, "direct_offer": { "type": "boolean", "description": "Прямой договор", "example": true }, "prepayment": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PrepaymentResponse" } ], "description": "Предоплата" }, "payment_mode": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PaymentModeResponse" } ], "description": "Режим оплаты" } }, "description": "Оплата с запросом ставки." }, "AuctionPaymentResponse": { "required": [ "auction_id", "start_rate", "auction_currency_type", "bid_step", "accept_bids_with_vat", "is_antisniper", "time_to_provide_documents", "winner_criteria", "auction_duration", "no_winner_end_options", "hide_counter_offers", "direct_offer" ], "properties": { "type": { "enum": [ "auction" ], "type": "string", "description": "Тип оплаты — Торги (`auction`).", "example": "auction" }, "auction_id": { "type": "string", "description": "Id Торгов", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "start_rate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "description": "Начальная ставка Торгов", "format": "double", "example": 50000 }, "auction_currency_type": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "description": "Id валюты из словаря валют", "format": "int32", "example": 1 }, "bid_step": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "description": "Шаг ставки Торгов", "format": "double", "example": 1000 }, "accept_bids_with_vat": { "type": "boolean", "description": "Принимать ставки с НДС", "example": true }, "accept_bids_without_vat": { "type": [ "null", "boolean" ], "description": "Принимать ставки без НДС", "example": true }, "vat_percents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Размер НДС, в процентах", "format": "int32", "example": 20 }, "is_antisniper": { "type": "boolean", "description": "Опция Антиснайпер", "example": true }, "time_to_provide_documents": { "type": "string", "description": "Время, за которое победитель обязан предоставить документы", "example": "02:00" }, "winner_criteria": { "type": "string", "description": "Критерий выбора победителя: `best-rate` — по лучшей ставке `matching-date` — с учётом даты загрузки и лучшей ставки", "example": "best-rate" }, "winner_reselection_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Количество автоматических переназначений победителя Торгов, в случае отказа от груза", "format": "int32", "example": 1 }, "auction_duration": { "description": "Параметры длительности Торгов", "$ref": "#/components/schemas/AuctionDurationOptionsResponse" }, "no_winner_end_options": { "description": "Действие при окончательном завершении Торгов без победителя", "$ref": "#/components/schemas/AuctionEndActionResponse" }, "accept_counter_offers": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AuctionCounterOffersOptionsResponse" } ], "description": "Параметры доступности встречных предложений во время проведения Торгов" }, "auto_renew": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AuctionRenewOptionsResponse" } ], "description": "Параметры автопродления Торгов" }, "rate_rise": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AuctionRateRiseOptionsResponse" } ], "description": "Параметры повышения ставки Торгов при отсутствии ставок" }, "auction_restart": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AuctionRestartOptionsResponse" } ], "description": "Параметры перезапуска Торгов в случае отсутствия ставок" }, "hide_counter_offers": { "type": "boolean", "description": "Встречные предложения видны только вам", "example": true }, "direct_offer": { "type": "boolean", "description": "Прямой договор", "example": true }, "prepayment": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PrepaymentResponse" } ], "description": "Предоплата" }, "payment_mode": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PaymentModeResponse" } ], "description": "Режим оплаты" } }, "description": "Оплата через Торги." }, "PublicationRestriction": { "type": "integer", "description": "Стратегия ограничения публикации на площадки" }, "PriorityViewResponse": { "required": [ "rate", "only_for_paid_users" ], "type": "object", "properties": { "money_spent_per_day": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "description": "Потрачено атисов за день OBSOLETE необходимо получать эту информацию из api приоритетного показа по грузам", "format": "double", "example": 0 }, "money_spent_per_order": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "description": "Потрачено атисов на эту заявку OBSOLETE необходимо получать эту информацию из api приоритетного показа по грузам", "format": "double", "example": 0 }, "rate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "description": "Ставка за просмотр", "format": "double", "example": 10 }, "only_for_paid_users": { "type": "boolean", "description": "Показывать приоритетный груз только платным пользователям", "example": true }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "description": "Лимит на заявку", "format": "double", "example": 5000 }, "daily_limit": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "description": "Суточный лимит", "format": "double", "example": 1000 } }, "description": "Приоритетный показ." }, "StealthResponse": { "type": "object", "properties": { "list_id": { "type": [ "null", "string" ], "description": "Id списка фирм для скрытия", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "minimal_registration_date": { "type": [ "null", "string" ], "description": "Минимальная дата регистрации фирм, которые будут видеть груза", "format": "date-time", "example": "2024-01-15T10:30:00+00:00" }, "minimal_stars_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Минимальное количество звёзд фирм, которые будут видеть груз", "format": "int32", "example": 3 } }, "description": "Стелс." }, "PrimaryLoadingPointRequest": { "required": [ "dates", "cargos", "city_id", "location" ], "type": "object", "properties": { "dates": { "description": "Даты загрузки", "$ref": "#/components/schemas/LoadingDateRequest" }, "cargos": { "type": "array", "items": { "$ref": "#/components/schemas/LoadingCargoRequest" }, "description": "Параметры грузов", "example": [ { "name": "Автомобиль(ли)", "weight": { "type": "tons", "quantity": 20 }, "volume": { "quantity": 20 }, "packaging": { "type": 2, "quantity": 20 }, "sizes": { "diameter": 1.2 }, "id": 1 } ] }, "near_cities": { "type": [ "null", "array" ], "items": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "description": "Ближайшие города. Id города из словаря городов", "example": [ 3611 ] }, "city_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Id города из словаря городов", "format": "int32", "example": 3611 }, "address": { "maxLength": 200, "type": [ "null", "string" ], "description": "Адрес в населённом пункте Поле не должно содержать emoji-символы и emoji-последовательности", "example": "Набережная" }, "coordinates": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CoordinatesRequest" } ], "description": "Координаты" }, "location": { "description": "Расположение", "$ref": "#/components/schemas/PointLocationRequest" } }, "description": "Основная точка загрузки." }, "PrimaryUnloadingPointRequest": { "required": [ "city_id", "location" ], "type": "object", "properties": { "dates": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/UnloadingDatesRequest" } ], "description": "Даты разгрузки" }, "near_cities": { "type": [ "null", "array" ], "items": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "description": "Ближайшие города. Id города из словаря городов", "example": [ 3611 ] }, "city_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Id города из словаря городов", "format": "int32", "example": 3611 }, "address": { "maxLength": 200, "type": [ "null", "string" ], "description": "Адрес в населённом пункте Поле не должно содержать emoji-символы и emoji-последовательности", "example": "Набережная" }, "coordinates": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CoordinatesRequest" } ], "description": "Координаты" }, "location": { "description": "Расположение", "$ref": "#/components/schemas/PointLocationRequest" } }, "description": "Основная точка разгрузки." }, "WayPointRequest": { "required": [ "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/LoadingWayPointRequest" }, { "$ref": "#/components/schemas/UnloadingWayPointRequest" }, { "$ref": "#/components/schemas/CustomsWayPointRequest" }, { "$ref": "#/components/schemas/GoThroughWayPointRequest" } ], "description": "Промежуточная точка маршрута.", "discriminator": { "propertyName": "type", "mapping": { "loading": "#/components/schemas/LoadingWayPointRequest", "unloading": "#/components/schemas/UnloadingWayPointRequest", "customs": "#/components/schemas/CustomsWayPointRequest", "go-through": "#/components/schemas/GoThroughWayPointRequest" } } }, "TruckLoadTypeRequest": { "type": "object", "properties": { "types": { "type": "array", "items": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "description": "Id типа загрузки из словаря типов загрузок", "example": [ 1, 4, 8 ] }, "is_all_required": { "type": [ "null", "boolean" ], "description": "Обязательны все выбранные", "default": false, "example": false } }, "description": "Способы загрузки или разгрузки." }, "TemperatureRequest": { "type": "object", "properties": { "from": { "maximum": 999, "minimum": -99, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "От", "format": "int32", "example": -18 }, "to": { "maximum": 999, "minimum": -99, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "До", "format": "int32", "example": 5 } }, "description": "Температура." }, "TruckDocumentsRequest": { "type": "object", "properties": { "tir": { "type": [ "null", "boolean" ], "description": "TIR todo ссылка на фак", "example": true }, "cmr": { "type": [ "null", "boolean" ], "description": "CMR todo ссылка на фак", "example": true }, "t1": { "type": [ "null", "boolean" ], "description": "T1 todo ссылка на фак", "example": true }, "medical_card": { "type": [ "null", "boolean" ], "description": "Медкнижка", "example": true } }, "description": "Разрешения транспорта." }, "TruckRequirementsRequest": { "type": "object", "properties": { "logging_truck": { "type": [ "null", "boolean" ], "description": "Коники", "example": true }, "road_train": { "type": [ "null", "boolean" ], "description": "Сцепка", "example": true }, "air_suspension": { "type": [ "null", "boolean" ], "description": "Пневмоход", "example": true }, "team_driving": { "type": [ "null", "boolean" ], "description": "Для груза необходимы два водителя", "example": true } }, "description": "Требования к транспорту." }, "WithBargainingPaymentRequest": { "properties": { "type": { "enum": [ "with-bargaining" ], "type": "string", "description": "Тип оплаты — возможен торг (`with-bargaining`).", "example": "with-bargaining" }, "auto_invites_settings": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CounterOffersAutoInviteRequest" } ], "description": "Автоматическое приглашение на лучшее встречное предложение" }, "currency_type": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Id валюты из словаря валют", "format": "int32", "example": 1 }, "rate_with_vat": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "description": "Ставка безнал с НДС", "format": "double", "example": 50000 }, "rate_without_vat": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "description": "Ставка безнал без НДС", "format": "double", "example": 50000 }, "cash": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "description": "Ставка наличными", "format": "double", "example": 50000 }, "on_card": { "type": [ "null", "boolean" ], "description": "Возможность отправлять наличные на карту", "example": true }, "rates_with_vat": { "type": "array", "items": { "$ref": "#/components/schemas/RateWithVatResponse" }, "description": "Безналичные ставки с НДС", "example": [ { "rate_with_vat": 50000, "vat_percent": 20 } ] }, "hide_counter_offers": { "type": [ "null", "boolean" ], "description": "Встречные предложения видны только вам", "example": true }, "direct_offer": { "type": [ "null", "boolean" ], "description": "Прямой договор", "example": true }, "prepayment": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PrepaymentRequest" } ], "description": "Предоплата" }, "payment_mode": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PaymentModeRequest" } ], "description": "Режим оплаты" } }, "description": "Оплата с торгом." }, "WithoutBargainingPaymentRequest": { "properties": { "type": { "enum": [ "without-bargaining" ], "type": "string", "description": "Тип оплаты — без торга (`without-bargaining`).", "example": "without-bargaining" }, "currency_type": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Id валюты из словаря валют", "format": "int32", "example": 1 }, "rate_with_vat": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "description": "Ставка безнал с НДС", "format": "double", "example": 50000 }, "rate_without_vat": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "description": "Ставка безнал без НДС", "format": "double", "example": 50000 }, "cash": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "description": "Ставка наличными", "format": "double", "example": 50000 }, "on_card": { "type": [ "null", "boolean" ], "description": "Возможность отправлять наличные на карту", "example": true }, "rates_with_vat": { "type": "array", "items": { "$ref": "#/components/schemas/RateWithVatResponse" }, "description": "Безналичные ставки с НДС", "example": [ { "rate_with_vat": 50000, "vat_percent": 20 } ] }, "hide_counter_offers": { "type": [ "null", "boolean" ], "description": "Встречные предложения видны только вам", "example": true }, "direct_offer": { "type": [ "null", "boolean" ], "description": "Прямой договор", "example": true }, "prepayment": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PrepaymentRequest" } ], "description": "Предоплата" }, "payment_mode": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PaymentModeRequest" } ], "description": "Режим оплаты" } }, "description": "Оплата без торга." }, "RateRequestPaymentRequest": { "properties": { "type": { "enum": [ "rate-request" ], "type": "string", "description": "Тип оплаты — запрос ставки (`rate-request`).", "example": "rate-request" }, "rate_with_vat_available": { "type": [ "null", "boolean" ], "description": "Можно предлагать ставки безнал с НДС", "example": true }, "rate_without_vat_available": { "type": [ "null", "boolean" ], "description": "Можно предлагать ставки безнал без НДС", "example": true }, "cash_available": { "type": [ "null", "boolean" ], "description": "Можно предлагать ставки наличными", "example": true }, "auto_invites_settings": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CounterOffersAutoInviteRequest" } ], "description": "Автоматическое приглашение на лучшее встречное предложение" }, "hide_counter_offers": { "type": [ "null", "boolean" ], "description": "Встречные предложения видны только вам", "example": true }, "direct_offer": { "type": [ "null", "boolean" ], "description": "Прямой договор", "example": true }, "prepayment": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PrepaymentRequest" } ], "description": "Предоплата" }, "payment_mode": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PaymentModeRequest" } ], "description": "Режим оплаты" } }, "description": "Оплата с запросом ставки." }, "AuctionPaymentRequest": { "required": [ "accept_bids_with_vat", "start_rate", "auction_currency_type", "bid_step", "auction_duration", "winner_criteria", "time_to_provide_documents", "no_winner_end_options" ], "properties": { "type": { "enum": [ "auction" ], "type": "string", "description": "Тип оплаты — Торги (`auction`).", "example": "auction" }, "accept_bids_with_vat": { "type": [ "null", "boolean" ], "description": "Принимать ставки с НДС", "example": true }, "accept_bids_without_vat": { "type": [ "null", "boolean" ], "description": "Принимать ставки без НДС", "example": true }, "vat_percents": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Размер НДС, в процентах", "format": "int32", "example": 20 }, "start_rate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "description": "Начальная ставка Торгов", "format": "double", "example": 50000 }, "auction_currency_type": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Id валюты, в которой будут вестись Торги. Значение из словаря валют", "format": "int32", "example": 1 }, "bid_step": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "description": "Шаг ставок", "format": "double", "example": 1000 }, "auction_duration": { "description": "Параметры длительности Торгов", "$ref": "#/components/schemas/AuctionDurationOptionsRequest" }, "accept_counter_offers": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AuctionCounterOffersOptionsRequest" } ], "description": "Параметры доступности встречных предложений во время проведения Торгов" }, "auto_renew": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AuctionRenewOptionsRequest" } ], "description": "Параметры автопродления Торгов" }, "is_antisniper": { "type": [ "null", "boolean" ], "description": "Опция Антиснайпер", "example": true }, "rate_rise": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AuctionRateRiseOptionsRequest" } ], "description": "Параметры повышения ставки Торгов при отсутствии ставок" }, "winner_criteria": { "type": "string", "description": "Критерий выбора победителя: - `best-rate` — по лучшей ставке - `matching-date` — с учётом даты загрузки и лучшей ставки", "example": "best-rate" }, "time_to_provide_documents": { "type": [ "null", "string" ], "description": "Время, за которое победитель обязан предоставить документы", "example": "02:00" }, "winner_reselection_count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Количество автоматических переназначений победителя Торгов, в случае отказа от груза", "format": "int32", "example": 1 }, "auction_restart": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AuctionRestartOptionsRequest" } ], "description": "Параметры перезапуска Торгов в случае отсутствия ставок" }, "no_winner_end_options": { "description": "Действие при окончательном завершении Торгов без победителя", "$ref": "#/components/schemas/AuctionEndActionRequest" }, "keep_rates": { "type": [ "null", "boolean" ], "description": "Сохранять ставки при редактировании груза", "example": true }, "hide_counter_offers": { "type": [ "null", "boolean" ], "description": "Встречные предложения видны только вам", "example": true }, "direct_offer": { "type": [ "null", "boolean" ], "description": "Прямой договор", "example": true }, "prepayment": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PrepaymentRequest" } ], "description": "Предоплата" }, "payment_mode": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PaymentModeRequest" } ], "description": "Режим оплаты" } }, "description": "Оплата через Торги." }, "PriorityViewRequest": { "required": [ "rate" ], "type": "object", "properties": { "rate": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "description": "Ставка за просмотр", "format": "double", "example": 10 }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "description": "Лимит на заявку", "format": "double", "example": 5000 }, "daily_limit": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "description": "Суточный лимит", "format": "double", "example": 1000 }, "only_for_paid_users": { "type": [ "null", "boolean" ], "description": "Показывать приоритетный груз только платным пользователям", "example": true } }, "description": "Приоритетный показ." }, "LoadingDateResponse": { "required": [ "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/FromDateLoadingDatesResponse" }, { "$ref": "#/components/schemas/ReadyLoadingDatesResponse" }, { "$ref": "#/components/schemas/PermanentLoadingDatesResponse" }, { "$ref": "#/components/schemas/RateRequestLoadingDatesResponse" } ], "description": "Даты загрузки.", "discriminator": { "propertyName": "type", "mapping": { "from-date": "#/components/schemas/FromDateLoadingDatesResponse", "ready": "#/components/schemas/ReadyLoadingDatesResponse", "permanent": "#/components/schemas/PermanentLoadingDatesResponse", "rate-request": "#/components/schemas/RateRequestLoadingDatesResponse" } } }, "LoadingCargoResponse": { "required": [ "name_id", "name", "cargo_id" ], "type": "object", "properties": { "name_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "description": "Id наименования груза из словаря (TODO ссылка на словарь)", "format": "int32", "example": 112 }, "name": { "type": "string", "description": "Наименование груза", "example": "Автомобиль(ли)" }, "packaging": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PackResponse" } ], "description": "Упаковка" }, "cargo_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "description": "Порядковый Id груза внутри заявки", "format": "int32", "example": 1 }, "weight": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WeightResponse" } ], "description": "Вес" }, "volume": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/VolumeResponse" } ], "description": "Объём" }, "sizes": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SizesResponse" } ], "description": "Габариты" } }, "description": "Загружаемый груз." }, "NearbyCityResponse": { "required": [ "id" ], "type": "object", "properties": { "id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "description": "Id города из словаря городов", "format": "int32", "example": 3611 }, "distance": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "description": "Расстояние до города", "format": "double", "example": 25 } }, "description": "Ближайший крупный город." }, "CityPointResponse": { "required": [ "city_id" ], "type": "object", "properties": { "city_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "description": "Id города из словаря городов", "format": "int32", "example": 3611 }, "region_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Id региона из словаря регионов", "format": "int32", "example": 21 }, "country_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Id страны из словаря стран", "format": "int32", "example": 1 } }, "description": "Город точки маршрута." }, "CoordinatesResponse": { "required": [ "longitude", "latitude" ], "type": "object", "properties": { "longitude": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "description": "Долгота", "format": "double", "example": 37.6173 }, "latitude": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "description": "Широта", "format": "double", "example": 55.7558 } }, "description": "Координаты." }, "OrganizationResponse": { "required": [ "organization_id", "address_id" ], "type": "object", "properties": { "organization_id": { "type": "string", "description": "Id из справочника организаций", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "address_id": { "type": "string", "description": "Id адреса в организации", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, "description": "Организация — грузоотправитель или грузополучатель." }, "UnloadingDatesResponse": { "type": "object", "properties": { "first_date": { "type": [ "null", "string" ], "description": "Дата разгрузки", "format": "date-time", "example": "2024-08-27T00:00:00+03:00" }, "last_date": { "type": [ "null", "string" ], "description": "Поздняя дата разгрузки", "format": "date-time", "example": "2024-08-29T00:00:00+03:00" }, "time": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LoadingTimeResponse" } ], "description": "Время разгрузки" } }, "description": "Даты разгрузки." }, "LoadingWayPointResponse": { "required": [ "city_id", "city" ], "properties": { "type": { "enum": [ "loading" ], "type": "string", "description": "Тип промежуточной точки — точка загрузки (`loading`).", "example": "loading" }, "cargos": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/LoadingCargoResponse" }, "description": "Параметры загружаемых грузов", "example": [ { "name_id": 112, "name": "Автомобиль(ли)", "packaging": { "type": 2, "quantity": 20 }, "cargo_id": 1, "weight": { "type": "tons", "quantity": 20 }, "volume": { "quantity": 20 }, "sizes": { "diameter": 1.2 } } ] }, "loading_date": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WayPointArrivalDateResponse" } ], "description": "Даты и время загрузки" }, "city_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "description": "Id города из словаря OBSOLETE используй поле City.CityId", "format": "int32", "example": 3611 }, "city": { "description": "Информация о населённом пункте", "$ref": "#/components/schemas/CityPointResponse" }, "coordinates": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CoordinatesResponse" } ], "description": "Координаты" }, "address": { "type": [ "null", "string" ], "description": "Адрес в населённом пункте", "example": "ул. Набережная, д. 12" }, "organization": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrganizationResponse" } ], "description": "Данные об организации из справочника (TODO ссылка на api), если она была указана в качестве адреса" } }, "description": "Промежуточная точка маршрута — загрузка." }, "UnloadingWayPointResponse": { "required": [ "city_id", "city" ], "properties": { "type": { "enum": [ "unloading" ], "type": "string", "description": "Тип промежуточной точки — точка разгрузки (`unloading`).", "example": "unloading" }, "cargos": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/UnloadingCargoResponse" }, "description": "Параметры разгружаемых грузов", "example": [ { "packaging_quantity": 20, "is_defined_by_ttn": true, "cargo_id": 1, "weight": { "type": "tons", "quantity": 20 }, "volume": { "quantity": 20 }, "sizes": { "diameter": 1.2 } } ] }, "unloading_date": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WayPointArrivalDateResponse" } ], "description": "Параметры даты и времени разгрузки" }, "city_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "description": "Id города из словаря OBSOLETE используй поле City.CityId", "format": "int32", "example": 3611 }, "city": { "description": "Информация о населённом пункте", "$ref": "#/components/schemas/CityPointResponse" }, "coordinates": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CoordinatesResponse" } ], "description": "Координаты" }, "address": { "type": [ "null", "string" ], "description": "Адрес в населённом пункте", "example": "ул. Набережная, д. 12" }, "organization": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrganizationResponse" } ], "description": "Данные об организации из справочника (TODO ссылка на api), если она была указана в качестве адреса" } }, "description": "Промежуточная точка маршрута — разгрузка." }, "CustomsWayPointResponse": { "required": [ "city_id", "city" ], "properties": { "type": { "enum": [ "customs" ], "type": "string", "description": "Тип промежуточной точки — таможня (`customs`).", "example": "customs" }, "city_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "description": "Id города из словаря OBSOLETE используй поле City.CityId", "format": "int32", "example": 3611 }, "city": { "description": "Информация о населённом пункте", "$ref": "#/components/schemas/CityPointResponse" }, "coordinates": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CoordinatesResponse" } ], "description": "Координаты" }, "address": { "type": [ "null", "string" ], "description": "Адрес в населённом пункте", "example": "ул. Набережная, д. 12" }, "organization": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrganizationResponse" } ], "description": "Данные об организации из справочника (TODO ссылка на api), если она была указана в качестве адреса" } }, "description": "Промежуточная точка маршрута — таможня." }, "GoThroughWayPointResponse": { "required": [ "city_id", "city" ], "properties": { "type": { "enum": [ "go-through" ], "type": "string", "description": "Тип промежуточной точки — проезд через (`go-through`).", "example": "go-through" }, "city_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "description": "Id города из словаря OBSOLETE используй поле City.CityId", "format": "int32", "example": 3611 }, "city": { "description": "Информация о населённом пункте", "$ref": "#/components/schemas/CityPointResponse" }, "coordinates": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CoordinatesResponse" } ], "description": "Координаты" }, "address": { "type": [ "null", "string" ], "description": "Адрес в населённом пункте", "example": "ул. Набережная, д. 12" }, "organization": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/OrganizationResponse" } ], "description": "Данные об организации из справочника (TODO ссылка на api), если она была указана в качестве адреса" } }, "description": "Промежуточная точка маршрута — проезд через." }, "AutoInvitesSettingsResponse": { "required": [ "invite_delay", "invite_duration", "need_archive_on_invite" ], "type": "object", "properties": { "invite_delay": { "type": "string", "description": "Период приема встречного предложения до автоматического приглашения (в формате `30m`, `1h`, `2d`).", "example": "30m" }, "invite_duration": { "type": "string", "description": "Период действия автоматического приглашения (в формате `30m`, `1h`, `2d`).", "example": "1h" }, "need_archive_on_invite": { "type": "boolean", "description": "Архивировать заявку при срабатывании автоматического приглашения", "example": true }, "max_percent_deviation": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения", "format": "int32", "example": 10 } }, "description": "Настройки автоматического приглашения на встречные предложения." }, "RateWithVatResponse": { "required": [ "rate_with_vat" ], "type": "object", "properties": { "rate_with_vat": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "description": "Ставка", "format": "double", "example": 50000 }, "vat_percent": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "НДС процент", "format": "int32", "example": 20 } }, "description": "Безналичная ставка с НДС." }, "PrepaymentResponse": { "required": [ "using_fuel" ], "type": "object", "properties": { "percent": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Процент предоплаты", "format": "int32", "example": 30 }, "using_fuel": { "type": "boolean", "description": "Предоплата топливом", "example": true } }, "description": "Предоплата." }, "PaymentModeResponse": { "required": [ "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/DelayedPaymentModeResponse" }, { "$ref": "#/components/schemas/OnUnloadingPaymentModeResponse" } ], "description": "Режим оплаты.", "discriminator": { "propertyName": "type", "mapping": { "delayed-payment": "#/components/schemas/DelayedPaymentModeResponse", "on-unloading": "#/components/schemas/OnUnloadingPaymentModeResponse" } } }, "AuctionDurationOptionsResponse": { "required": [ "count_from_first_bid" ], "type": "object", "properties": { "fixed_duration": { "type": [ "null", "string" ], "description": "Может быть null, если есть значение у поля FinishUntil. Длительность проведения Торгов: `30m` — 30 минут `1h` — 1 час `2h` — 2 часа `3h` — 3 часа `4h` — 4 часа `6h` — 6 часов `12h` — 12 часов `1d` — 1 день `2d` — 2 дня `3d` — 3 дня `4d` — 4 дня `5d` — 5 дней", "example": "1h" }, "count_from_first_bid": { "type": "boolean", "description": "Отсчитывать длительность Торгов с момента первой ставки", "example": true }, "finish_until": { "type": [ "null", "string" ], "description": "Точные дата и время завершения Торгов", "format": "date-time", "example": "2024-01-15T10:30:00+00:00" } }, "description": "Параметры длительности Торгов." }, "AuctionEndActionResponse": { "required": [ "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/ArchiveApplicationAuctionEndActionResponse" }, { "$ref": "#/components/schemas/PublishWithRatesAuctionEndActionResponse" }, { "$ref": "#/components/schemas/PublishRateRequestAuctionEndActionResponse" } ], "description": "Действие при завершении Торгов без победителя.", "discriminator": { "propertyName": "type", "mapping": { "archive": "#/components/schemas/ArchiveApplicationAuctionEndActionResponse", "publish-with-rate": "#/components/schemas/PublishWithRatesAuctionEndActionResponse", "publish-rate-request": "#/components/schemas/PublishRateRequestAuctionEndActionResponse" } } }, "AuctionCounterOffersOptionsResponse": { "required": [ "until_first_bid" ], "type": "object", "properties": { "acceptance_delay": { "type": [ "null", "string" ], "description": "Может быть null, в таком случае будем принимать встречные предложения сразу. Принимать встречные предложения через: - `30m` — 30 минут - `1h` — 1 час - `2h` — 2 часа - `3h` — 3 часа - `4h` — 4 часа - `6h` — 6 часов - `12h` — 12 часов", "example": "1h" }, "until_first_bid": { "type": "boolean", "description": "Принимать встречные предложения до первой ставки по Торгам", "example": true } }, "description": "Параметры доступности встречных предложений во время Торгов." }, "AuctionRenewOptionsResponse": { "required": [ "step", "limit" ], "type": "object", "properties": { "step": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "description": "Количество минут, на которые будут продливаться Торги", "format": "int32", "example": 5 }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "description": "Максимальное время, на которое будут продливаться Торги (в минутах)", "format": "int32", "example": 60 } }, "description": "Параметры автопродления Торгов." }, "AuctionRateRiseOptionsResponse": { "required": [ "periodicity", "rate_limit" ], "type": "object", "properties": { "periodicity": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "description": "Периодичность повышения", "format": "int32", "example": 30 }, "rate_limit": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "description": "Максимальное значение ставки Торгов", "format": "double", "example": 100000 } }, "description": "Параметры повышения ставки Торгов при отсутствии ставок." }, "AuctionRestartOptionsResponse": { "required": [ "count", "new_duration" ], "type": "object", "properties": { "count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "description": "Количество перезапусков", "format": "int32", "example": 1 }, "new_duration": { "type": "string", "description": "Длительность Торгов после перезапуска: `30m` — 30 минут `1h` — 1 час `2h` — 2 часа `3h` — 3 часа `4h` — 4 часа `6h` — 6 часов `12h` — 12 часов", "example": "1h" }, "rate_increase": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AuctionRestartRateIncreaseResponse" } ], "description": "Параметры повышения начальной ставки после перезапуска торгов." } }, "description": "Параметры перезапуска Торгов при отсутствии ставок." }, "LoadingDateRequest": { "required": [ "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/ReadyLoadingDatesRequest" }, { "$ref": "#/components/schemas/FromDateLoadingDatesRequest" }, { "$ref": "#/components/schemas/PermanentLoadingDatesRequest" }, { "$ref": "#/components/schemas/RateRequestLoadingDatesRequest" } ], "description": "Даты загрузки.", "discriminator": { "propertyName": "type", "mapping": { "ready": "#/components/schemas/ReadyLoadingDatesRequest", "from-date": "#/components/schemas/FromDateLoadingDatesRequest", "permanent": "#/components/schemas/PermanentLoadingDatesRequest", "rate-request": "#/components/schemas/RateRequestLoadingDatesRequest" } } }, "LoadingCargoRequest": { "required": [ "name", "weight", "volume", "id" ], "type": "object", "properties": { "name": { "maxLength": 200, "minLength": 0, "type": "string", "description": "Наименование груза Поле не должно содержать emoji-символы и emoji-последовательности", "example": "Автомобиль(ли)" }, "weight": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WeightRequest" } ], "description": "Вес" }, "volume": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/VolumeRequest" } ], "description": "Объём" }, "packaging": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PackRequest" } ], "description": "Упаковка" }, "sizes": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SizesRequest" } ], "description": "Габариты" }, "id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Порядковый номер груза внутри заявки", "format": "int32", "example": 1 } }, "description": "Загружаемый груз." }, "CoordinatesRequest": { "required": [ "longitude", "latitude" ], "type": "object", "properties": { "longitude": { "maximum": 180, "minimum": -180, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "description": "Долгота", "format": "double", "example": 37.6173 }, "latitude": { "maximum": 90, "minimum": -90, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "description": "Широта", "format": "double", "example": 55.7558 } }, "description": "Координаты." }, "PointLocationRequest": { "required": [ "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/ManualPointLocationRequest" }, { "$ref": "#/components/schemas/OrganizationPointLocationRequest" } ], "description": "Расположение точки.", "discriminator": { "propertyName": "type", "mapping": { "manual": "#/components/schemas/ManualPointLocationRequest", "organization": "#/components/schemas/OrganizationPointLocationRequest" } } }, "UnloadingDatesRequest": { "type": "object", "properties": { "first_date": { "type": [ "null", "string" ], "description": "Дата разгрузки", "format": "date-time", "example": "2024-08-27T00:00:00+03:00" }, "last_date": { "type": [ "null", "string" ], "description": "Поздняя дата разгрузки", "format": "date-time", "example": "2024-08-29T00:00:00+03:00" }, "time": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LoadingTimeRequest" } ], "description": "Время разгрузки" } }, "description": "Даты разгрузки." }, "LoadingWayPointRequest": { "required": [ "city_id", "location" ], "properties": { "type": { "enum": [ "loading" ], "type": "string", "description": "Тип промежуточной точки — загрузка (`loading`).", "example": "loading" }, "cargos": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/LoadingCargoRequest" }, "description": "Параметры загружаемых грузов", "example": [ { "name": "Автомобиль(ли)", "weight": { "type": "tons", "quantity": 20 }, "volume": { "quantity": 20 }, "packaging": { "type": 2, "quantity": 20 }, "sizes": { "diameter": 1.2 }, "id": 1 } ] }, "loading_date": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WayPointArrivalDateRequest" } ], "description": "Параметры даты и времени загрузки" }, "city_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Id города из словаря городов", "format": "int32", "example": 3611 }, "address": { "maxLength": 200, "type": [ "null", "string" ], "description": "Адрес в населённом пункте Поле не должно содержать emoji-символы и emoji-последовательности", "example": "Набережная" }, "coordinates": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CoordinatesRequest" } ], "description": "Координаты" }, "location": { "description": "Расположение", "$ref": "#/components/schemas/PointLocationRequest" } }, "description": "Промежуточная точка маршрута — загрузка." }, "UnloadingWayPointRequest": { "required": [ "city_id", "location" ], "properties": { "type": { "enum": [ "unloading" ], "type": "string", "description": "Тип промежуточной точки — разгрузка (`unloading`).", "example": "unloading" }, "cargos": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/UnloadingCargoRequest" }, "description": "Параметры выгружаемых грузов", "example": [ { "weight": { "type": "tons", "quantity": 20 }, "volume": { "quantity": 20 }, "packaging_quantity": 20, "is_defined_by_ttn": true, "id": 1 } ] }, "unloading_date": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WayPointArrivalDateRequest" } ], "description": "Параметры даты и времени разгрузки" }, "city_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Id города из словаря городов", "format": "int32", "example": 3611 }, "address": { "maxLength": 200, "type": [ "null", "string" ], "description": "Адрес в населённом пункте Поле не должно содержать emoji-символы и emoji-последовательности", "example": "Набережная" }, "coordinates": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CoordinatesRequest" } ], "description": "Координаты" }, "location": { "description": "Расположение", "$ref": "#/components/schemas/PointLocationRequest" } }, "description": "Промежуточная точка маршрута — разгрузка." }, "CustomsWayPointRequest": { "required": [ "city_id", "location" ], "properties": { "type": { "enum": [ "customs" ], "type": "string", "description": "Тип промежуточной точки — таможня (`customs`).", "example": "customs" }, "city_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Id города из словаря городов", "format": "int32", "example": 3611 }, "address": { "maxLength": 200, "type": [ "null", "string" ], "description": "Адрес в населённом пункте Поле не должно содержать emoji-символы и emoji-последовательности", "example": "Набережная" }, "coordinates": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CoordinatesRequest" } ], "description": "Координаты" }, "location": { "description": "Расположение", "$ref": "#/components/schemas/PointLocationRequest" } }, "description": "Промежуточная точка маршрута — таможня." }, "GoThroughWayPointRequest": { "required": [ "city_id", "location" ], "properties": { "type": { "enum": [ "go-through" ], "type": "string", "description": "Тип промежуточной точки — проезд через (`go-through`).", "example": "go-through" }, "city_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Id города из словаря городов", "format": "int32", "example": 3611 }, "address": { "maxLength": 200, "type": [ "null", "string" ], "description": "Адрес в населённом пункте Поле не должно содержать emoji-символы и emoji-последовательности", "example": "Набережная" }, "coordinates": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CoordinatesRequest" } ], "description": "Координаты" }, "location": { "description": "Расположение", "$ref": "#/components/schemas/PointLocationRequest" } }, "description": "Промежуточная точка маршрута — проезд через." }, "CounterOffersAutoInviteRequest": { "type": "object", "properties": { "invite_delay": { "type": "string", "description": "Период приема встречного предложения до автоматического приглашения (в формате `30m`, `1h`, `2d`).", "example": "30m" }, "invite_duration": { "type": "string", "description": "Период действия автоматического приглашения (в формате `30m`, `1h`, `2d`).", "example": "1h" }, "max_percent_deviation": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Максимальное возможное отклонение от ставки для срабатывания автоматического приглашения", "format": "int32", "example": 10 }, "need_archive_on_invite": { "type": "boolean", "description": "Архивировать заявку при срабатывании автоматического приглашения", "example": true } }, "description": "Автоматическое приглашение на лучшее встречное предложение." }, "PrepaymentRequest": { "type": "object", "properties": { "percent": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Процент предоплаты", "format": "int32", "example": 30 }, "using_fuel": { "type": [ "null", "boolean" ], "description": "Предоплата топливом", "example": true } }, "description": "Предоплата." }, "PaymentModeRequest": { "required": [ "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/OnUnloadingPaymentModeRequest" }, { "$ref": "#/components/schemas/DelayedPaymentModeRequest" } ], "description": "Режим оплаты.", "discriminator": { "propertyName": "type", "mapping": { "on-unloading": "#/components/schemas/OnUnloadingPaymentModeRequest", "delayed-payment": "#/components/schemas/DelayedPaymentModeRequest" } } }, "AuctionDurationOptionsRequest": { "type": "object", "properties": { "fixed_duration": { "type": [ "null", "string" ], "description": "Длительность торгов: - `30m` — 30 минут - `1h` — 1 час - `2h` — 2 часа - `3h` — 3 часа - `4h` — 4 часа - `6h` — 6 часов - `12h` — 12 часов - `1d` — 1 день - `2d` — 2 дня - `3d` — 3 дня - `4d` — 4 дня - `5d` — 5 дней", "example": "1h" }, "count_from_first_bid": { "type": [ "null", "boolean" ], "description": "Отсчитывать длительность Торгов с момента первой ставки", "example": true }, "finish_until": { "type": [ "null", "string" ], "description": "Точные дата и время завершения Торгов", "format": "date-time", "example": "2024-01-15T10:30:00+00:00" } }, "description": "Параметры длительности Торгов." }, "AuctionCounterOffersOptionsRequest": { "type": "object", "properties": { "acceptance_delay": { "type": [ "null", "string" ], "description": "Принимать встречные предложения через: - `30m` — 30 минут - `1h` — 1 час - `2h` — 2 часа - `3h` — 3 часа - `4h` — 4 часа - `6h` — 6 часов - `12h` — 12 часов", "example": "1h" }, "until_first_bid": { "type": [ "null", "boolean" ], "description": "Принимать встречные предложения до первой ставки по Торгам", "example": true } }, "description": "Параметры доступности встречных предложений во время Торгов." }, "AuctionRenewOptionsRequest": { "required": [ "step", "limit" ], "type": "object", "properties": { "step": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Количество минут, на которые будут продливаться Торги", "format": "int32", "example": 5 }, "limit": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Максимальное время, на которое будут продливаться Торги (в минутах)", "format": "int32", "example": 60 } }, "description": "Параметры автопродления Торгов." }, "AuctionRateRiseOptionsRequest": { "required": [ "periodicity", "rate_limit" ], "type": "object", "properties": { "periodicity": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Периодичность повышения", "format": "int32", "example": 30 }, "rate_limit": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "description": "Максимальное значение ставки Торгов", "format": "double", "example": 100000 } }, "description": "Параметры повышения ставки Торгов при отсутствии ставок." }, "AuctionRestartOptionsRequest": { "required": [ "count", "new_duration" ], "type": "object", "properties": { "count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Количество перезапусков", "format": "int32", "example": 1 }, "new_duration": { "type": "string", "description": "Длительность Торгов после перезапуска: - `30m` — 30 минут - `1h` — 1 час - `2h` — 2 часа - `3h` — 3 часа - `4h` — 4 часа - `6h` — 6 часов - `12h` — 12 часов", "example": "1h" }, "rate_increase": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AuctionRestartRateIncreaseRequest" } ], "description": "Параметры повышения начальной ставки после перезапуска торгов." } }, "description": "Параметры перезапуска Торгов при отсутствии ставок." }, "AuctionEndActionRequest": { "required": [ "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/ArchiveApplicationAuctionEndActionResponse" }, { "$ref": "#/components/schemas/PublishWithRatesAuctionEndActionRequest" }, { "$ref": "#/components/schemas/PublishRateRequestAuctionEndActionRequest" } ], "description": "Действие при завершении Торгов без победителя.", "discriminator": { "propertyName": "type", "mapping": { "archive": "#/components/schemas/ArchiveApplicationAuctionEndActionRequest", "publish-with-rate": "#/components/schemas/PublishWithRatesAuctionEndActionRequest", "publish-rate-request": "#/components/schemas/PublishRateRequestAuctionEndActionRequest" } } }, "FromDateLoadingDatesResponse": { "required": [ "first_date", "last_date" ], "properties": { "type": { "enum": [ "from-date" ], "type": "string", "description": "Тип даты — в промежутке дат (`from-date`).", "example": "from-date" }, "time": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LoadingTimeResponse" } ], "description": "Время загрузки" }, "first_date": { "type": "string", "description": "Дата начала", "format": "date-time", "example": "2024-08-27T00:00:00+03:00" }, "last_date": { "type": "string", "description": "Дата конца", "format": "date-time", "example": "2024-08-29T00:00:00+03:00" } }, "description": "Дата погрузки «С даты»." }, "ReadyLoadingDatesResponse": { "required": [ "is_available_tomorrow", "first_date", "last_date" ], "properties": { "type": { "enum": [ "ready" ], "type": "string", "description": "Тип даты — готов (`ready`).", "example": "ready" }, "is_available_tomorrow": { "type": "boolean", "description": "Готов к загрузке сегодня и завтра (TODO возможно убрать)", "example": true }, "time": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LoadingTimeResponse" } ], "description": "Время загрузки" }, "first_date": { "type": "string", "description": "Дата начала", "format": "date-time", "example": "2024-08-27T00:00:00+03:00" }, "last_date": { "type": "string", "description": "Дата конца", "format": "date-time", "example": "2024-08-29T00:00:00+03:00" } }, "description": "Даты готовности к загрузке." }, "PermanentLoadingDatesResponse": { "required": [ "periodicity", "first_date", "last_date" ], "properties": { "type": { "enum": [ "permanent" ], "type": "string", "description": "Тип даты — постоянно (`permanent`).", "example": "permanent" }, "periodicity": { "type": "string", "description": "Периодичность постоянной загрузки: - `everyday` — \"каждый день\" - `workdays` — \"по рабочим дням\"", "example": "everyday" }, "time": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LoadingTimeResponse" } ], "description": "Время загрузки" }, "first_date": { "type": "string", "description": "Дата начала", "format": "date-time", "example": "2024-08-27T00:00:00+03:00" }, "last_date": { "type": "string", "description": "Дата конца", "format": "date-time", "example": "2024-08-29T00:00:00+03:00" } }, "description": "Постоянные даты загрузки." }, "RateRequestLoadingDatesResponse": { "required": [ "first_date", "last_date" ], "properties": { "type": { "enum": [ "rate-request" ], "type": "string", "description": "Тип даты — запрос ставки (`rate-request`).", "example": "rate-request" }, "first_date": { "type": "string", "description": "Дата начала", "format": "date-time", "example": "2024-08-27T00:00:00+03:00" }, "last_date": { "type": "string", "description": "Дата конца", "format": "date-time", "example": "2024-08-29T00:00:00+03:00" } }, "description": "Даты загрузки для запроса ставки (груза нет)." }, "PackResponse": { "required": [ "type" ], "type": "object", "properties": { "type": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "description": "Id типа упаковки из словаря типов упаковок", "format": "int32", "example": 2 }, "quantity": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Количество", "format": "int32", "example": 20 } }, "description": "Упаковка груза." }, "WeightResponse": { "required": [ "type", "quantity" ], "type": "object", "properties": { "type": { "type": "string", "description": "Тип: - `tons` — тонны - `kilos` — килограммы", "example": "tons" }, "quantity": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "description": "Количество", "format": "double", "example": 20 } }, "description": "Вес груза." }, "VolumeResponse": { "required": [ "quantity" ], "type": "object", "properties": { "quantity": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "description": "Количество", "format": "double", "example": 20 } }, "description": "Объём груза." }, "SizesResponse": { "type": "object", "properties": { "length": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SizeResponse" } ], "description": "Длина, метры" }, "height": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SizeResponse" } ], "description": "Высота, метры" }, "width": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SizeResponse" } ], "description": "Ширина, метры" }, "diameter": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "description": "Диаметр, метры", "format": "double", "example": 1.2 } }, "description": "Габариты груза." }, "LoadingTimeResponse": { "required": [ "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BoundedLoadingTimeResponse" }, { "$ref": "#/components/schemas/RoundTheClockLoadingTimeResponse" } ], "description": "Время загрузки.", "discriminator": { "propertyName": "type", "mapping": { "bounded": "#/components/schemas/BoundedLoadingTimeResponse", "round-the-clock": "#/components/schemas/RoundTheClockLoadingTimeResponse" } } }, "WayPointArrivalDateResponse": { "type": "object", "properties": { "first_date": { "type": [ "null", "string" ], "description": "Дата начала", "format": "date-time", "example": "2024-08-27T00:00:00+03:00" }, "last_date": { "type": [ "null", "string" ], "description": "Дата конца", "format": "date-time", "example": "2024-08-29T00:00:00+03:00" }, "time": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LoadingTimeResponse" } ], "description": "Время загрузки" } }, "description": "Даты прибытия в промежуточную точку." }, "UnloadingCargoResponse": { "required": [ "cargo_id" ], "type": "object", "properties": { "packaging_quantity": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Выгружаемая часть упаковки", "format": "int32", "example": 20 }, "is_defined_by_ttn": { "type": [ "null", "boolean" ], "description": "Выгружаемая часть груза будет определена в ТТН", "example": true }, "cargo_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "description": "Порядковый Id груза внутри заявки", "format": "int32", "example": 1 }, "weight": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WeightResponse" } ], "description": "Вес" }, "volume": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/VolumeResponse" } ], "description": "Объём" }, "sizes": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SizesResponse" } ], "description": "Габариты" } }, "description": "Выгружаемый груз." }, "DelayedPaymentModeResponse": { "required": [ "payment_delay_days" ], "properties": { "type": { "enum": [ "delayed-payment" ], "type": "string", "description": "Тип режима оплаты — через несколько дней (`delayed-payment`).", "example": "delayed-payment" }, "payment_delay_days": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "description": "Количество банковских дней", "format": "int32", "example": 14 } }, "description": "Оплата через N банковских дней." }, "OnUnloadingPaymentModeResponse": { "properties": { "type": { "enum": [ "on-unloading" ], "type": "string", "description": "Тип режима оплаты — на выгрузке (`on-unloading`).", "example": "on-unloading" } }, "description": "Оплата на выгрузке." }, "ArchiveApplicationAuctionEndActionResponse": { "properties": { "type": { "enum": [ "archive" ], "type": "string", "description": "Действие — переместить заявку в архив (`archive`).", "example": "archive" } }, "description": "Завершение Торгов — переместить заявку в архив." }, "PublishWithRatesAuctionEndActionResponse": { "required": [ "currency_type" ], "properties": { "type": { "enum": [ "publish-with-rate" ], "type": "string", "description": "Действие — опубликовать заявку со ставкой (`publish-with-rate`).", "example": "publish-with-rate" }, "currency_type": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "description": "Id валюты из словаря валют", "format": "int32", "example": 1 }, "rate_with_vat": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "description": "Ставка безнал с НДС", "format": "double", "example": 50000 }, "rate_without_vat": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "description": "Ставка безнал без НДС", "format": "double", "example": 50000 }, "cash": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "description": "Ставка наличными", "format": "double", "example": 50000 }, "on_card": { "type": [ "null", "boolean" ], "description": "Возможность отправлять наличные на карту", "example": true }, "auto_invites_settings": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AutoInvitesSettingsResponse" } ], "description": "Автоматическое приглашение на лучшее встречное предложение" }, "rates_with_vat": { "type": "array", "items": { "$ref": "#/components/schemas/RateWithVatResponse" }, "description": "Безналичные ставки с НДС", "example": [ { "rate_with_vat": 50000, "vat_percent": 20 } ] } }, "description": "Завершение Торгов — опубликовать заявку со ставкой." }, "PublishRateRequestAuctionEndActionResponse": { "required": [ "rate_with_vat_available", "rate_without_vat_available", "cash_available" ], "properties": { "type": { "enum": [ "publish-rate-request" ], "type": "string", "description": "Действие — опубликовать заявку с запросом ставки (`publish-rate-request`).", "example": "publish-rate-request" }, "rate_with_vat_available": { "type": "boolean", "description": "Можно предлагать ставки безнал с НДС", "example": true }, "rate_without_vat_available": { "type": "boolean", "description": "Можно предлагать ставки безнал без НДС", "example": true }, "cash_available": { "type": "boolean", "description": "Можно предлагать ставки наличными", "example": true }, "auto_invites_settings": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AutoInvitesSettingsResponse" } ], "description": "Автоматическое приглашение на лучшее встречное предложение" } }, "description": "Завершение Торгов — опубликовать заявку с запросом ставки." }, "AuctionRestartRateIncreaseResponse": { "required": [ "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AuctionRestartIncreaseRateByValueResponse" }, { "$ref": "#/components/schemas/AuctionRestartIncreaseRateByPercentResponse" } ], "description": "Параметры повышения начальной ставки после перезапуска Торгов.", "discriminator": { "propertyName": "type", "mapping": { "currency": "#/components/schemas/AuctionRestartIncreaseRateByValueResponse", "percent": "#/components/schemas/AuctionRestartIncreaseRateByPercentResponse" } } }, "ReadyLoadingDatesRequest": { "properties": { "type": { "enum": [ "ready" ], "type": "string", "description": "Тип даты — готов к загрузке (`ready`).", "example": "ready" }, "is_available_tomorrow": { "type": [ "null", "boolean" ], "description": "Готов к загрузке сегодня и завтра", "example": true }, "time": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LoadingTimeRequest" } ], "description": "Время загрузки" } }, "description": "Даты готовности к загрузке." }, "FromDateLoadingDatesRequest": { "properties": { "type": { "enum": [ "from-date" ], "type": "string", "description": "Тип даты — с даты (`from-date`).", "example": "from-date" }, "first_date": { "type": [ "null", "string" ], "description": "Дата начала", "format": "date-time", "example": "2024-08-27T00:00:00+03:00" }, "last_date": { "type": [ "null", "string" ], "description": "Дата конца", "format": "date-time", "example": "2024-08-27T00:00:00+03:00" }, "time": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LoadingTimeRequest" } ], "description": "Время загрузки" } }, "description": "Дата погрузки \"С даты\", type = 'from-date'" }, "PermanentLoadingDatesRequest": { "required": [ "periodicity" ], "properties": { "type": { "enum": [ "permanent" ], "type": "string", "description": "Тип даты — постоянно (`permanent`).", "example": "permanent" }, "periodicity": { "type": "string", "description": "Периодичность постоянной загрузки - `everyday` — каждый день - `workdays` — по рабочим дням", "example": "everyday" }, "time": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LoadingTimeRequest" } ], "description": "Время загрузки" } }, "description": "Постоянные даты загрузки." }, "RateRequestLoadingDatesRequest": { "properties": { "type": { "enum": [ "rate-request" ], "type": "string", "description": "Тип даты — запрос ставки (`rate-request`).", "example": "rate-request" } }, "description": "Даты загрузки для запроса ставки (груза нет)." }, "WeightRequest": { "required": [ "quantity" ], "type": "object", "properties": { "type": { "type": "string", "description": "Тип: - `tons` — тонны - `kilos` — килограммы", "default": "tons", "example": "tons" }, "quantity": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "description": "Количество от 10 kilos до 9999 tons", "format": "double", "example": 20 } }, "description": "Вес груза." }, "VolumeRequest": { "required": [ "quantity" ], "type": "object", "properties": { "quantity": { "maximum": 9999, "minimum": 0.01, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "description": "Количество", "format": "double", "example": 20 } }, "description": "Объём груза." }, "PackRequest": { "required": [ "type" ], "type": "object", "properties": { "type": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Id типа упаковки из словаря типов упаковок", "format": "int32", "example": 2 }, "quantity": { "maximum": 9999, "minimum": 1, "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Количество", "format": "int32", "example": 20 } }, "description": "Упаковка груза." }, "SizesRequest": { "type": "object", "properties": { "length": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SizeRequest" } ], "description": "Длина, метры" }, "height": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SizeRequest" } ], "description": "Высота, метры" }, "width": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SizeRequest" } ], "description": "Ширина, метры" }, "diameter": { "maximum": 50, "minimum": 0.01, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "description": "Диаметр, метры", "format": "double", "example": 1.2 } }, "description": "Габариты груза." }, "ManualPointLocationRequest": { "required": [ "city_id" ], "properties": { "type": { "enum": [ "manual" ], "type": "string", "description": "Тип расположения точки — ручное (`manual`).", "example": "manual" }, "city_id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Id города из словаря городов", "format": "int32", "example": 3611 }, "address": { "maxLength": 200, "type": [ "null", "string" ], "description": "Адрес в населённом пункте Поле не должно содержать emoji-символы и emoji-последовательности", "example": "Набережная" }, "coordinates": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CoordinatesRequest" } ], "description": "Координаты" } }, "description": "Расположение точки, заданное вручную." }, "OrganizationPointLocationRequest": { "required": [ "organization_id", "address_id" ], "properties": { "type": { "enum": [ "organization" ], "type": "string", "description": "Тип расположения точки — из организации (`organization`).", "example": "organization" }, "organization_id": { "type": [ "null", "string" ], "description": "Id из справочника организаций", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "address_id": { "type": [ "null", "string" ], "description": "Id адреса в организации", "format": "uuid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } }, "description": "Расположение точки из справочника организаций." }, "LoadingTimeRequest": { "required": [ "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/BoundedLoadingTimeRequest" }, { "$ref": "#/components/schemas/RoundTheClockLoadingTimeResponse" } ], "description": "Время загрузки.", "discriminator": { "propertyName": "type", "mapping": { "bounded": "#/components/schemas/BoundedLoadingTimeRequest", "round-the-clock": "#/components/schemas/RoundTheClockLoadingTimeRequest" } } }, "WayPointArrivalDateRequest": { "type": "object", "properties": { "first_date": { "type": [ "null", "string" ], "description": "Дата начала", "format": "date-time", "example": "2024-08-27T00:00:00+03:00" }, "last_date": { "type": [ "null", "string" ], "description": "Дата конца", "format": "date-time", "example": "2024-08-27T00:00:00+03:00" }, "time": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LoadingTimeRequest" } ], "description": "Время загрузки" } }, "description": "Даты прибытия в промежуточную точку." }, "UnloadingCargoRequest": { "required": [ "id" ], "type": "object", "properties": { "weight": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/WeightRequest" } ], "description": "Выгружаемая часть веса" }, "volume": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/VolumeRequest" } ], "description": "Выгружаемая часть объёма" }, "packaging_quantity": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Выгружаемая часть упаковки", "format": "int32", "example": 20 }, "is_defined_by_ttn": { "type": [ "null", "boolean" ], "description": "Выгружаемая часть груза будет определена в ТТН", "example": true }, "id": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Порядковый номер груза внутри заявки", "format": "int32", "example": 1 } }, "description": "Выгружаемый груз." }, "OnUnloadingPaymentModeRequest": { "properties": { "type": { "enum": [ "on-unloading" ], "type": "string", "description": "Тип режима оплаты — оплата на выгрузке (`on-unloading`).", "example": "on-unloading" } }, "description": "Оплата на выгрузке." }, "DelayedPaymentModeRequest": { "properties": { "type": { "enum": [ "delayed-payment" ], "type": "string", "description": "Тип режима оплаты — оплата через N банковских дней (`delayed-payment`).", "example": "delayed-payment" }, "payment_delay_days": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Количество банковских дней", "format": "int32", "example": 14 } }, "description": "Оплата через N банковских дней." }, "AuctionRestartRateIncreaseRequest": { "required": [ "type" ], "type": "object", "oneOf": [ { "$ref": "#/components/schemas/AuctionRestartCurrencyRateIncreaseRequest" }, { "$ref": "#/components/schemas/AuctionRestartPercentRateIncreaseRequest" } ], "description": "Параметры повышения начальной ставки после перезапуска Торгов.", "discriminator": { "propertyName": "type", "mapping": { "currency": "#/components/schemas/AuctionRestartCurrencyRateIncreaseRequest", "percent": "#/components/schemas/AuctionRestartPercentRateIncreaseRequest" } } }, "PublishWithRatesAuctionEndActionRequest": { "properties": { "type": { "enum": [ "publish-with-rate" ], "type": "string", "description": "Действие — опубликовать заявку со ставкой (`publish-with-rate`).", "example": "publish-with-rate" }, "currency_type": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "description": "Id валюты из словаря валют", "format": "int32", "example": 1 }, "rate_with_vat": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "description": "Ставка безнал с НДС", "format": "double", "example": 50000 }, "rates_with_vat": { "type": "array", "items": { "$ref": "#/components/schemas/RateWithVatResponse" }, "description": "Безналичные ставки с НДС", "example": [ { "rate_with_vat": 50000, "vat_percent": 20 } ] }, "rate_without_vat": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "description": "Ставка безнал без НДС", "format": "double", "example": 50000 }, "cash": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "description": "Ставка наличными", "format": "double", "example": 50000 }, "on_card": { "type": [ "null", "boolean" ], "description": "Возможность отправлять наличные на карту", "example": true }, "auto_invites_settings": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CounterOffersAutoInviteRequest" } ], "description": "Автоматическое приглашение на лучшее встречное предложение" } }, "description": "Завершение Торгов — опубликовать заявку со ставкой." }, "PublishRateRequestAuctionEndActionRequest": { "properties": { "type": { "enum": [ "publish-rate-request" ], "type": "string", "description": "Действие — опубликовать заявку с запросом ставки (`publish-rate-request`).", "example": "publish-rate-request" }, "rate_with_vat_available": { "type": [ "null", "boolean" ], "description": "Можно предлагать ставки безнал с НДС", "example": true }, "rate_without_vat_available": { "type": [ "null", "boolean" ], "description": "Можно предлагать ставки безнал без НДС", "example": true }, "cash_available": { "type": [ "null", "boolean" ], "description": "Можно предлагать ставки наличными", "example": true }, "auto_invites_settings": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CounterOffersAutoInviteRequest" } ], "description": "Автоматическое приглашение на лучшее встречное предложение" } }, "description": "Завершение Торгов — опубликовать заявку с запросом ставки." }, "SizeResponse": { "required": [ "value", "is_highlighted" ], "type": "object", "properties": { "value": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "description": "Значение", "format": "double", "example": 2.5 }, "is_highlighted": { "type": "boolean", "description": "Выделить значение цветом в результатах поиска", "example": true } }, "description": "Габаритный размер." }, "BoundedLoadingTimeResponse": { "properties": { "type": { "enum": [ "bounded" ], "type": "string", "description": "Тип времени — с ограничением (`bounded`).", "example": "bounded" }, "start": { "type": [ "null", "string" ], "description": "Время \"с\"", "example": "09:00" }, "end": { "type": [ "null", "string" ], "description": "Время \"по\"", "example": "18:00" }, "offset": { "type": [ "null", "string" ], "description": "Часовой пояс", "example": "+03:00" } }, "description": "Время загрузки в интервале «с/по»." }, "RoundTheClockLoadingTimeResponse": { "properties": { "type": { "enum": [ "round-the-clock" ], "type": "string", "description": "Тип времени — круглосуточно (`round-the-clock`).", "example": "round-the-clock" } }, "description": "Круглосуточное время загрузки." }, "AuctionRestartIncreaseRateByValueResponse": { "required": [ "amount" ], "properties": { "type": { "enum": [ "currency" ], "type": "string", "description": "Тип повышения — абсолютное значение в валюте (`currency`).", "example": "currency" }, "amount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "description": "Значение, на которое нужно повысить начальную ставку.", "format": "double", "example": 5000 } }, "description": "Повышение ставки после перезапуска — абсолютное значение в валюте." }, "AuctionRestartIncreaseRateByPercentResponse": { "required": [ "amount" ], "properties": { "type": { "enum": [ "percent" ], "type": "string", "description": "Тип повышения — процент от начальной ставки (`percent`).", "example": "percent" }, "amount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "description": "Значение, на которое нужно повысить начальную ставку.", "format": "double", "example": 5000 } }, "description": "Повышение ставки после перезапуска — процент от начальной ставки." }, "SizeRequest": { "required": [ "value" ], "type": "object", "properties": { "value": { "maximum": 50, "minimum": 0.01, "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "null", "number", "string" ], "description": "Значение", "format": "double", "example": 2.5 }, "is_highlighted": { "type": [ "null", "boolean" ], "description": "Выделить значение цветом в результатах поиска", "example": true } }, "description": "Габаритный размер." }, "BoundedLoadingTimeRequest": { "properties": { "type": { "enum": [ "bounded" ], "type": "string", "description": "Тип времени — с/по (`bounded`).", "example": "bounded" }, "start": { "type": [ "null", "string" ], "description": "С", "example": "09:00" }, "end": { "type": [ "null", "string" ], "description": "По", "example": "18:00" }, "offset": { "type": [ "null", "string" ], "description": "Часовой пояс", "example": "+03:00" } }, "description": "Время загрузки в интервале «с/по»." }, "AuctionRestartCurrencyRateIncreaseRequest": { "required": [ "amount" ], "properties": { "type": { "enum": [ "currency" ], "type": "string", "description": "Тип повышения — абсолютное значение в валюте (`currency`).", "example": "currency" }, "amount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "description": "Значение, на которое нужно повысить начальную ставку.", "format": "double", "example": 5000 } }, "description": "Повышение ставки после перезапуска — абсолютное значение в валюте." }, "AuctionRestartPercentRateIncreaseRequest": { "required": [ "amount" ], "properties": { "type": { "enum": [ "percent" ], "type": "string", "description": "Тип повышения — процент от начальной ставки (`percent`).", "example": "percent" }, "amount": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "description": "Значение, на которое нужно повысить начальную ставку.", "format": "double", "example": 5000 } }, "description": "Повышение ставки после перезапуска — процент от начальной ставки." }, "cargos_v2__ArchiveCargoApplicationsIntegrationResponse": { "required": [ "cargo_application_ids" ], "type": "object", "properties": { "cargo_application_ids": { "type": [ "null", "object" ], "additionalProperties": { "$ref": "#/components/schemas/cargos_v2__OperationResponse" }, "description": "Результаты архивации грузов. Ключ — id заявки, значение — результат операции.", "example": { "550e8400-e29b-41d4-a716-446655440000": { "type": "success", "message": "Успешная операция", "status_code": "success" } } } }, "description": "Ответ на архивацию заявок на груз через Integration API." }, "cargos_v2__DeleteCargoApplicationsIntegrationResponse": { "required": [ "cargo_application_ids" ], "type": "object", "properties": { "cargo_application_ids": { "type": [ "null", "object" ], "additionalProperties": { "$ref": "#/components/schemas/cargos_v2__OperationResponse" }, "description": "Результаты удаления грузов. Ключ — id заявки, значение — результат операции.", "example": { "550e8400-e29b-41d4-a716-446655440000": { "type": "success", "message": "Успешная операция", "status_code": "success" } } } }, "description": "Ответ на удаление архивных заявок на груз через Integration API." }, "cargos_v2__OperationResponse": { "required": [ "type" ], "type": "object", "anyOf": [ { "$ref": "#/components/schemas/OperationResponseErrorResponseDetails" }, { "$ref": "#/components/schemas/SuccessOperationResponse" } ], "description": "Базовый ответ результата операции.", "discriminator": { "propertyName": "type", "mapping": { "error": "#/components/schemas/OperationResponseErrorResponseDetails", "success": "#/components/schemas/SuccessOperationResponse" } } }, "cargos-priority-view-api__PriorityViewRequest": { "type": "object", "properties": { "view_rate": { "type": "number", "description": "Ставка за просмотр", "format": "double", "nullable": true }, "daily_limit": { "type": "number", "description": "Суточный лимит списания по услуге\r\n \r\n* Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)\r\n* Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0", "format": "double", "nullable": true }, "order_limit": { "type": "number", "description": "Лимит на заявку\r\n \r\n* Должен быть больше либо равен значению ViewRate или быть равным нулю (если ограничения нет)\r\n* Должен быть равен 0 или отсутствовать, если параметр ViewRate отсутствует или равен 0", "format": "double", "nullable": true }, "is_for_paid_only": { "type": "boolean", "description": "Показывать приоритетный показ только платным пользователям", "nullable": true } } }, "UpsertPriorityViewPublicRequest": { "type": "object", "properties": { "priority_view": { "allOf": [ { "$ref": "#/components/schemas/cargos-priority-view-api__PriorityViewRequest" } ], "description": "Конфигурация приоритетного показа", "nullable": true } } }, "CargoCounterOfferIntegratorView": { "type": "object", "description": "Встречное предложение", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "Id встречного предложения", "format": "guid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "cargo_id": { "type": "string", "description": "Id груза, на который оставлено встречное предложение", "format": "guid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "cargo_number": { "type": "string", "description": "Номер груза", "minLength": 1, "example": "CES23786" }, "cargo_firm_id": { "type": "integer", "description": "Id фирмы, которой принадлежит груз", "format": "int32", "example": 1234 }, "firm_id": { "type": "integer", "description": "Id фирмы, которая оставила встречное предложение", "format": "int32", "example": 1234 }, "added_at": { "type": "string", "description": "Дата добавления встречного предложения", "format": "date-time", "example": "2024-01-15T10:30:00+03:00" }, "updated_at": { "type": "string", "description": "Дата изменения встречного предложения", "format": "date-time", "example": "2024-01-15T10:30:00+03:00" }, "price": { "type": "number", "description": "Предложенная цена встречного предложения", "format": "decimal", "example": 100.5 }, "currency_id": { "type": "integer", "description": "Валюта встречного предложения\\\nЗначение из [словаря валют АТИ](https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes)", "format": "int32", "example": 1 }, "nds_price": { "type": "number", "description": "Предложенная цена встречного предложения с НДС", "format": "decimal", "example": 100.5 }, "nds_percent": { "type": "integer", "description": "Процент НДС ставки встречного предложения", "format": "int32", "example": 22 }, "nds_currency_id": { "type": "integer", "description": "Валюта ставки встречного предложения б/нал с НДС.\nЗначение из [словаря валют АТИ](https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes)", "format": "int32", "example": 1 }, "not_nds_price": { "type": "number", "description": "Предложенная цена встречного предложения без НДС", "format": "decimal", "example": 100.5 }, "not_nds_currency_id": { "type": "integer", "description": "Валюта встречного предложения без НДС", "format": "int32", "example": 1 }, "counter_offer_source": { "type": "integer", "description": "Обозначение откуда было добавлено встречное предложение\n \n* `0` - Неизвестный источник\n* `1` - Мобильное приложение\n* `2` - Интегратор\n* `3` - Перехват грузов интегратором\n* `4` - Страница поиска грузов\n* `5` - Перехват машин\n* `6` - Сквозное встречное предложение, добавлено автоматически", "format": "int32", "example": 2 }, "note": { "type": "string", "description": "Примечание к встречному предложению\\\nМаксимальная длина - 512 символов", "minLength": 1, "example": "Тестовое примечание" }, "pay_attributes": { "type": "integer", "description": "Атрибуты оплаты, по умолчанию - 0.\nБитовая сумма следующих параметров:\n \n* `1` - возможна оплата наличными\n* `2` - возможна оплата по безналичному рассчету\n* `4` - блиц\n* `8` - оплата с НДС\n* `16` - возможна предоплата\n* `32` - оплата на выгрузке\n* `64` - включена ли оплата через некоторое количество банковских дней", "format": "int32", "example": 0 }, "prepay_percent": { "type": "integer", "description": "Процент предоплаты", "format": "int32", "example": 0 }, "pay_after_max_bank_days": { "type": "integer", "description": "Оплата через ... банковских дней", "format": "int32", "example": 0 }, "loading_date": { "type": "string", "description": "Дата загрузки", "format": "date", "example": "2024-01-15" }, "is_outdated": { "type": "boolean", "description": "Определяет, просрочено ли встречное предложение. Когда груз редактируют, удаляют, обновляют, встречное предложение помечается просроченным.\\", "example": false }, "is_cargo_published": { "type": "boolean", "description": "Относится ли встречное предложение к опубликованному грузу", "example": false }, "firm_info": { "description": "Информация о фирме, оставившей встречное предложение на груз", "oneOf": [ { "$ref": "#/components/schemas/FirmIntegratorView" } ] } } }, "ExceptionDetailView": { "type": "object", "description": "Детали ошибки", "additionalProperties": false, "properties": { "property": { "type": "string", "description": "Свойство модели с ошибкой", "example": "string" }, "error": { "type": "string", "description": "Ошибка", "example": "string" }, "reason": { "type": "string", "description": "Причина ошибки", "example": "string" } } }, "OperationStatusIntegratorViewOfListOfCargoCounterOfferIntegratorView": { "type": "object", "description": "Статус выполнения операции", "additionalProperties": false, "properties": { "message": { "type": "string", "description": "Сообщение о результате операции", "nullable": true, "example": "OK" }, "error": { "type": "string", "description": "Описание ошибки", "nullable": true, "example": null }, "result": { "type": "array", "description": "Результат операции", "nullable": true, "example": null, "items": { "$ref": "#/components/schemas/CargoCounterOfferIntegratorView" } } } }, "CargoCounterOfferStatusIntegratorView": { "type": "object", "description": "Статус встречного предложения для груза", "additionalProperties": false, "properties": { "cargo_id": { "type": "string", "description": "ID груза", "format": "guid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "has_active": { "type": "boolean", "description": "Есть ли активное встречное предложение", "example": true } } }, "CargoCounterOfferIntegratorDto": { "type": "object", "additionalProperties": false, "required": [ "contact_id" ], "properties": { "contact_id": { "type": "integer", "description": "Контакт, от лица которого выставить встречное предложение", "format": "int32", "example": 1 }, "price": { "type": "number", "description": "Предложенная ставка встречного предложения не б/нал.", "format": "decimal", "example": 100.5 }, "currency_id": { "type": "integer", "description": "Валюта встречного предложения.\nЗначение из [словаря валют АТИ](https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes)", "format": "int32", "example": 1 }, "nds_price": { "type": "number", "description": "Предложенная ставка встречного предложения б/нал с НДС", "format": "decimal", "example": 100.5 }, "nds_percent": { "type": "integer", "description": "Процент НДС ставки встречного предложения", "format": "int32", "nullable": true, "example": 22 }, "nds_currency_id": { "type": "integer", "description": "Валюта ставки встречного предложения б/нал с НДС. \nЗначение из [словаря валют АТИ](https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes)", "format": "int32", "example": 1 }, "not_nds_price": { "type": "number", "description": "Предложенная ставка встречного предложения б/нал без НДС", "format": "decimal", "example": 100.5 }, "not_nds_currency_id": { "type": "integer", "description": "Валюта ставки встречного предложения б/нал без НДС. \nЗначение из [словаря валют АТИ](https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes)", "format": "int32", "example": 1 }, "note": { "type": "string", "description": "Примечание к встречному предложению", "nullable": true, "example": "Примечание" }, "prepay_percent": { "type": "integer", "description": "Процент предоплаты\\\nДопустимое значение от 0 до 100", "format": "int32", "example": 10 }, "pay_after_max_bank_days": { "type": "integer", "description": "Оплата через ... банковских дней\\", "format": "int32", "example": 0 }, "loading_date": { "type": "string", "description": "Дата загрузки", "format": "date", "nullable": true, "example": "2024-01-15" }, "pay_attributes": { "type": "integer", "description": "Атрибуты оплаты, по умолчанию - 0.\nБитовая сумма следующих параметров:\n \n* `1` - возможна оплата наличными\n* `2` - возможна оплата по безналичному рассчету\n* `4` - блиц\n* `8` - оплата с НДС\n* `16` - возможна предоплата\n* `32` - оплата на выгрузке\n* `64` - включена ли оплата через некоторое количество банковских дней", "format": "int32", "example": 64 } } }, "OperationStatusIntegratorViewOfCargoCounterOfferIntegratorView": { "type": "object", "description": "Статус выполнения операции", "additionalProperties": false, "properties": { "message": { "type": "string", "description": "Сообщение о результате операции", "nullable": true, "example": "OK" }, "error": { "type": "string", "description": "Описание ошибки", "nullable": true, "example": null }, "result": { "description": "Результат операции", "nullable": true, "example": null, "oneOf": [ { "$ref": "#/components/schemas/CargoCounterOfferIntegratorView" } ] } } }, "FirmIntegratorView": { "type": "object", "description": "Информация о фирме", "additionalProperties": false, "properties": { "total_score": { "type": "number", "description": "Сумма очков фирмы (количество звезд)", "format": "double", "example": 4.5 }, "status": { "type": "integer", "description": "Тип звезд фирмы\n* `0`: Серый\n* `1`: Красный\n* `2`: Желтый\n* `3`: Зеленый\n* `4`: Партнер АТИ\n* `5`: Сотрудник АТИ\n* `6`: Гос. органы\n* `7`: ОДКС", "format": "int32", "example": 3 }, "full_firm_name": { "type": "string", "description": "Полное название фирмы", "minLength": 1, "example": "ООО Тест" }, "contact": { "description": "Информация о контакте фирмы", "oneOf": [ { "$ref": "#/components/schemas/ContactIntegratorView" } ] }, "inn": { "type": "string", "description": "ИНН", "minLength": 1, "example": 1234567890 } } }, "ContactIntegratorView": { "type": "object", "description": "Информация о контакте", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Id контакта в фирме", "format": "int32", "example": 1 }, "name": { "type": "string", "description": "Имя контакта", "minLength": 1, "example": "Иванов Иван" }, "telephone": { "type": "string", "description": "Телефон", "minLength": 1, "example": "+74951234567" }, "email": { "type": "string", "description": "Электронная почта", "minLength": 1, "example": "test@test.ru" }, "mobile": { "type": "string", "description": "Телефон(мобильный)", "minLength": 1, "example": "+79001234567" }, "mobile_operator": { "type": "string", "description": "Мобильный оператор", "minLength": 1, "example": "МТС" }, "location": { "description": "Информация о местоположении фирмы", "oneOf": [ { "$ref": "#/components/schemas/AccountCityIntegratorView" } ] } } }, "AccountCityIntegratorView": { "type": "object", "description": "Информация о городе", "additionalProperties": false, "properties": { "city_id": { "type": "integer", "description": "ID города", "format": "int32", "example": 1 }, "region_id": { "type": "integer", "description": "ID региона", "format": "int32", "example": 1 }, "country_id": { "type": "integer", "description": "ID страны", "format": "int32", "example": 1 }, "full_name": { "type": "string", "description": "Полное название", "minLength": 1, "example": "Москва, Россия" }, "short_name": { "type": "string", "description": "Краткое название", "minLength": 1, "example": "Москва" }, "is_regional_center": { "type": "boolean", "description": "Является ли региональным центром", "example": true }, "fias_id": { "type": "string", "description": "Id в базе ФИАС", "format": "guid", "example": "0c5b2444-70a0-4932-980c-b4dc0d3f02b5" }, "city_name": { "type": "string", "description": "Название города", "minLength": 1, "example": "Москва" }, "region_name": { "type": "string", "description": "Название региона", "minLength": 1, "example": "Московская область" }, "country_name": { "type": "string", "description": "Название страны", "minLength": 1, "example": "Россия" }, "country_code": { "type": "string", "description": "Код страны", "minLength": 1, "example": "RU" } } }, "User": { "type": "object", "properties": { "id": { "type": "string", "description": "id юзера (c contact_id)" }, "code": { "type": "string", "description": "alias юзера (без contact_id)" }, "name": { "type": "string", "description": "имя юзера" }, "company": { "type": "string", "description": "название компании" }, "email": { "type": "string", "description": "email юзера" }, "fax": { "type": "string", "description": "факс юзера" }, "icq": { "type": "string", "description": "icq юзера" }, "mobile": { "type": "string", "description": "номер мобильного телефона юзера" }, "phone": { "type": "string", "description": "номер телефона юзера" }, "skype": { "type": "string", "description": "skype юзера" } } }, "ArrayOfUsers": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "Subscription": { "type": "object", "properties": { "id": { "type": "string", "description": "id чата" }, "channel_type": { "type": "string", "description": "тип чата" }, "name": { "type": "string", "description": "Название чата (имя собеседника)" }, "ctime": { "type": "string", "description": "время создания чата (iso)" }, "utime": { "type": "string", "description": "время последнего изменения (iso)" }, "owner": { "type": "string", "description": "создатель чата" }, "tail": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/Tail" } }, "description": { "type": "string", "description": "описание чата (для диалогов - название фирмы)" }, "users": { "type": "array", "items": { "type": "string", "description": "alias участника (c contact_id)" } }, "partner": { "type": "string", "description": "id партнера (без contact_id)" }, "partner_id": { "type": "string", "description": "id партнера (c contact_id)" }, "partner_full": { "type": "string", "description": "alias партнера (c contact_id)" }, "count": { "type": "integer", "description": "количество учасчтников группового чата (для диалогов - null)" }, "dts": { "type": "integer", "description": "timestamp последней очистки сообщений" }, "unread": { "type": "string", "description": "количество непрочитанных сообщений" }, "user": { "type": "string", "description": "id юзера (c contact_id)" }, "uts": { "type": "integer", "description": "timestamp последнего изменения" }, "short_url": { "type": "string", "description": "короткий хэш для группового чата, используется в ссылке для приглашения, содерижтся только в подписке админа" } } }, "ArrayOfSubscriptions": { "type": "array", "items": { "$ref": "#/components/schemas/Subscription" } }, "Message": { "type": "object", "properties": { "channel": { "type": "string", "description": "id чата" }, "delivered": { "type": "boolean", "description": "доставлено/недоставлено" }, "stamp": { "type": "string", "description": "таймстемп (isoformat) сообщения" }, "text": { "type": "string", "description": "текст сообщения" }, "ts": { "type": "integer", "description": "таймстемп (unix) сообщения" }, "id": { "type": "string", "description": "id сообщения" }, "user": { "type": "string", "description": "id отправителя, отстутствует в системных событиях" }, "event": { "type": "string", "enum": [ "join", "exclude", "quit", "invite", "create", "system_message" ], "description": "тип системного события" }, "from": { "type": "string", "description": "Имя отправителя сообщения" }, "document": { "type": "string", "description": "ссылка на документ в атидоках", "example": "/document/07a940594fdb4866aa9f8f48c192632d/" }, "document_mimetype": { "type": "string" }, "document_size": { "type": "integer" }, "file_id": { "type": "string", "description": "id загруженного в filestorage файла" }, "file_mimetype": { "type": "string" }, "file_name": { "type": "string" }, "file_size": { "type": "integer" } } }, "Tail": { "type": "object", "properties": { "text": { "type": "string", "description": "текст сообщения (в случае картинки или файла - название объекта)" }, "ts": { "type": "integer", "description": "таймстемп (unix) сообщения" }, "user": { "type": "string", "description": "id отправителя, отстутствует в системных событиях" }, "from": { "type": "string", "description": "имя отправителя сообщения" }, "file_name": { "type": "string", "description": "имя файла (если есть)" }, "image_name": { "type": "string", "description": "имя картинки (если есть)" } } }, "ArrayOfMessages": { "type": "array", "items": { "$ref": "#/components/schemas/Message" } }, "ATI.Tracker.API.ApiExceptions.SwaggerExampleBaseApiException": { "type": "object", "properties": { "error": { "type": "string", "description": "Код ошибки", "nullable": true }, "reason": { "type": "string", "description": "Описание ошибки", "nullable": true } }, "additionalProperties": false, "description": "Тело ответа при ошибке API. [Подробнее про ошибки API](https://ati.su/developers/documentation/errors/)" }, "ATI.Tracker.API.ApiModels.PublicModels.PublicDealDigestResponse": { "type": "object", "properties": { "deal_id": { "type": "string", "description": "GUID заказа", "nullable": true, "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "initial_phone": { "type": "string", "description": "Номер телефона из запроса (до нормализации)", "nullable": true, "example": "+7(933)8508858" }, "phone": { "type": "string", "description": "Нормализованный номер телефона водителя", "nullable": true, "example": "79338508858" }, "tracker_offer_status": { "$ref": "#/components/schemas/ATI.Tracker.DataAccess.Models.Enums.TrackerOfferStatus" }, "reason_changing_offer_status": { "type": "string", "description": "Причина изменения статуса предложения", "nullable": true }, "status": { "$ref": "#/components/schemas/ATI.Tracker.DataAccess.Models.Enums.DealInWorkStatus" }, "extended_status": { "$ref": "#/components/schemas/ATI.Tracker.DataAccess.Models.Enums.ExtendedDealInWorkStatus" }, "tracker_finished_at": { "type": "string", "description": "Дата и время завершения отслеживания (UTC)", "format": "date-time", "nullable": true }, "last_active": { "type": "string", "description": "Дата и время последней активности водителя в приложении (UTC)", "format": "date-time", "nullable": true, "example": "2024-06-15T10:30:00Z" }, "has_tracker": { "type": "boolean", "description": "Установлено ли приложение АТИ Водитель на телефон водителя", "example": true }, "last_location": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.ResponseModels.DealMap.PointResponse" }, "gps_status_date": { "type": "string", "description": "Дата и время последнего GPS-статуса (UTC)", "format": "date-time", "nullable": true } }, "additionalProperties": false }, "ATI.Tracker.API.ApiModels.PublicModels.PublicDriverActivityDealRequest": { "required": [ "deal_id", "phone" ], "type": "object", "properties": { "phone": { "minLength": 1, "type": "string", "description": "Номер телефона водителя.\r\nМожно получить из [справочника водителей](https://ati.su/developers/api/catalogs/autopark/)", "example": "+7(933)8508858" }, "deal_id": { "type": "string", "description": "GUID заказа. Получить из [API заказов](https://ati.su/developers/api/orders/deals/)", "format": "uuid", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" } }, "additionalProperties": false }, "ATI.Tracker.API.ApiModels.PublicModels.PublicDriverActivityRequest": { "required": [ "deals" ], "type": "object", "properties": { "deals": { "minItems": 1, "type": "array", "items": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.PublicModels.PublicDriverActivityDealRequest" }, "description": "Список пар «телефон водителя — заказ» для запроса активности" } }, "additionalProperties": false }, "ATI.Tracker.API.ApiModels.PublicModels.PublicListDealsDigestResponse": { "type": "object", "properties": { "deals": { "type": "array", "items": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.PublicModels.PublicDealDigestResponse" }, "description": "Сводная информация по каждому запрошенному заказу", "nullable": true } }, "additionalProperties": false }, "ATI.Tracker.API.ApiModels.RequestModels.InviteUserByPhoneRequest": { "required": [ "Phone" ], "type": "object", "properties": { "Phone": { "minLength": 1, "type": "string", "description": "Номер телефона водителя.\r\nМожно получить из [справочника водителей](https://ati.su/developers/api/catalogs/autopark/)", "example": "+7(933)8508858" } }, "additionalProperties": false }, "ATI.Tracker.API.ApiModels.RequestModels.PublicDriverPresenceRequest": { "required": [ "phones" ], "type": "object", "properties": { "phones": { "minItems": 1, "type": "array", "items": { "type": "string" }, "description": "Номера телефонов водителей.\r\nМожно получить из [справочника водителей](https://ati.su/developers/api/catalogs/autopark/)", "example": [ "79338508858", "79031234567" ] } }, "additionalProperties": false }, "ATI.Tracker.API.ApiModels.RequestModels.Transportation.Points.ContactPersonPointRequest": { "type": "object", "properties": { "name": { "type": "string", "description": "Имя контактного лица", "nullable": true, "example": "Иванов Иван" }, "phone": { "type": "string", "description": "Телефон контактного лица", "nullable": true, "example": "+7(495)123-45-67" }, "ordinal_id": { "type": "integer", "description": "Порядковый номер контакта на точке", "format": "int32", "example": 1 } }, "additionalProperties": false }, "ATI.Tracker.API.ApiModels.RequestModels.Transportation.Points.TransportationPointRequest": { "required": [ "deal_point_id" ], "type": "object", "properties": { "deal_point_id": { "type": "string", "description": "Идентификатор точки заказа. Получить из [API заказов](https://ati.su/developers/api/orders/deals/)", "format": "uuid", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "ordinal_id": { "type": "integer", "description": "Порядковый номер точки в маршруте", "format": "int32", "nullable": true, "example": 1 }, "city_id": { "type": "integer", "description": "Id города. Значение из [словаря городов АТИ](https://ati.su/developers/api/dictionaries/geo/)", "format": "int32", "nullable": true, "example": 3611 }, "region_id": { "type": "integer", "description": "Id региона. Значение из [словаря регионов АТИ](https://ati.su/developers/api/dictionaries/geo/)", "format": "int32", "nullable": true, "example": 151 }, "country_id": { "type": "integer", "description": "Id страны. Значение из [словаря стран АТИ](https://ati.su/developers/api/dictionaries/geo/)", "format": "int32", "nullable": true, "example": 1 }, "point_type": { "$ref": "#/components/schemas/ATI.Tracker.DataAccess.Models.Enums.DealPointTypes" }, "organization_id": { "type": "string", "description": "Id организации. Получить из [справочника организаций](https://ati.su/developers/api/catalogs/organizations)", "format": "uuid", "nullable": true, "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901" }, "time": { "type": "string", "description": "Время начала (формат hh:mm)", "nullable": true, "example": "09:00" }, "date": { "type": "string", "description": "Дата начала (формат dd.MM.yyyy)", "nullable": true, "example": "20.06.2024" }, "time_to": { "type": "string", "description": "Время окончания (формат hh:mm)", "nullable": true, "example": "12:00" }, "date_to": { "type": "string", "description": "Дата окончания (формат dd.MM.yyyy)", "nullable": true, "example": "20.06.2024" }, "lat": { "type": "number", "description": "Широта", "format": "double", "nullable": true, "example": 55.7558 }, "lon": { "type": "number", "description": "Долгота", "format": "double", "nullable": true, "example": 37.6173 }, "address": { "type": "string", "description": "Адрес точки", "nullable": true, "example": "г. Москва, ул. Примерная, д. 1" }, "contact_persons": { "type": "array", "items": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.RequestModels.Transportation.Points.ContactPersonPointRequest" }, "description": "Контактные лица на точке", "nullable": true }, "note": { "type": "string", "description": "Примечание к точке", "nullable": true, "example": "Погрузка" }, "timeslots_warehouse_id": { "type": "integer", "description": "Id склада. Значение из [API временных окон](https://ati.su/developers/api/time-slots/time-slots/)", "format": "int32", "nullable": true, "example": 12345 } }, "additionalProperties": false }, "ATI.Tracker.API.ApiModels.RequestModels.TransportationStatuses.TransportationStatusRequest": { "required": [ "in_work_status" ], "type": "object", "properties": { "in_work_status": { "type": "integer", "description": "Статус перевозки", "format": "int32", "example": 1 } }, "additionalProperties": false }, "ATI.Tracker.API.ApiModels.ResponseModels.DealMap.CompanyInfoResponse": { "type": "object", "properties": { "ati_id": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ATI.Tracker.API.ApiModels.ResponseModels.DealMap.EventResponse": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ATI.Tracker.DataAccess.Models.Enums.EventType" }, "tag": { "type": "string", "description": "Тег события (код статуса или мета-события)", "nullable": true, "example": "loading" }, "date": { "type": "string", "description": "Дата события (UTC)", "format": "date-time", "nullable": true }, "date_to": { "type": "string", "description": "Дата окончания события (UTC)", "format": "date-time", "nullable": true }, "time": { "type": "string", "description": "Время события (формат hh:mm)", "nullable": true }, "time_to": { "type": "string", "description": "Время окончания события (формат hh:mm)", "nullable": true }, "location_name": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.ResponseModels.DealMap.LocationNameResponse" }, "company_info": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.ResponseModels.DealMap.CompanyInfoResponse" }, "manager": { "type": "string", "description": "Менеджер, связанный с событием", "nullable": true } }, "additionalProperties": false }, "ATI.Tracker.API.ApiModels.ResponseModels.DealMap.LocationNameResponse": { "type": "object", "properties": { "country": { "type": "string", "nullable": true }, "region": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "address": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ATI.Tracker.API.ApiModels.ResponseModels.DealMap.PointResponse": { "type": "object", "properties": { "lon": { "type": "number", "description": "Долгота", "format": "double", "example": 37.6173 }, "lat": { "type": "number", "description": "Широта", "format": "double", "example": 55.7558 }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.ResponseModels.DealMap.EventResponse" }, "description": "События в точке (статусы перевозки, мета-события GPS)", "nullable": true }, "is_fake": { "type": "boolean", "description": "Признак подмены GPS-координат" }, "is_disabled": { "type": "boolean", "description": "GPS отключён на устройстве водителя" }, "is_no_data": { "type": "boolean", "description": "Нет данных о местоположении" }, "is_power_saving": { "type": "boolean", "description": "Устройство в режиме энергосбережения" } }, "additionalProperties": false }, "ATI.Tracker.API.ApiModels.ResponseModels.PublicDriverPresenceResponse": { "type": "object", "properties": { "phone": { "type": "string", "description": "Нормализованный номер телефона водителя", "nullable": true, "example": "79338508858" }, "initial_phone": { "type": "string", "description": "Номер телефона из запроса (до нормализации)", "nullable": true, "example": "89338508858" }, "last_active": { "type": "string", "description": "Дата и время последней активности водителя в приложении АТИ Водитель (UTC)", "format": "date-time", "nullable": true, "example": "2024-06-15T10:30:00Z" }, "has_tracker": { "type": "boolean", "description": "Установлено ли приложение АТИ Водитель на телефон водителя", "example": true }, "sms_invite_status": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.ResponseModels.PublicSmsInviteStatusResponse" } }, "additionalProperties": false }, "ATI.Tracker.API.ApiModels.ResponseModels.PublicSmsInviteStatusResponse": { "type": "object", "properties": { "invite_sent": { "type": "boolean", "description": "Было ли отправлено SMS-приглашение водителю", "example": true }, "contact_name": { "type": "string", "description": "Имя контакта фирмы, от имени которого отправлено приглашение", "nullable": true, "example": "Иванов Иван" }, "ati_id": { "type": "integer", "description": "Код фирмы в АТИ, отправившей приглашение", "format": "int32", "nullable": true, "example": 14612 }, "contact_id": { "type": "integer", "description": "Идентификатор контакта фирмы, отправившей приглашение", "format": "int32", "nullable": true, "example": 0 }, "sms_status": { "$ref": "#/components/schemas/ATI.Tracker.DataAccess.Models.Enums.SmsStatus" }, "when": { "type": "string", "description": "Дата и время создания SMS-приглашения (UTC)", "format": "date-time", "nullable": true, "example": "2024-06-10T14:00:00Z" } }, "additionalProperties": false }, "ATI.Tracker.API.ApiModels.ResponseModels.SmsInviteResponse": { "type": "object", "properties": { "ok": { "type": "boolean", "description": "Успешно ли отправлено SMS-приглашение", "example": true }, "details": { "type": "string", "description": "Дополнительная информация: число отправленных приглашений за сегодня или описание ошибки", "nullable": true, "example": "Сегодня вами было отправлено приглашений: 1" } }, "additionalProperties": false }, "ATI.Tracker.API.ApiModels.ResponseModels.Transportation.Points.TransportationPointResponse": { "type": "object", "properties": { "deal_point_id": { "type": "string", "description": "Идентификатор точки заказа", "format": "uuid", "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890" }, "ordinal_id": { "type": "integer", "description": "Порядковый номер точки в маршруте", "format": "int32", "nullable": true, "example": 1 }, "time": { "type": "string", "description": "Время начала (формат hh:mm)", "nullable": true, "example": "09:00" }, "date": { "type": "string", "description": "Дата начала (формат dd.MM.yyyy)", "nullable": true, "example": "20.06.2024" }, "time_to": { "type": "string", "description": "Время окончания (формат hh:mm)", "nullable": true, "example": "12:00" }, "date_to": { "type": "string", "description": "Дата окончания (формат dd.MM.yyyy)", "nullable": true, "example": "20.06.2024" }, "lat": { "type": "number", "description": "Широта", "format": "double", "nullable": true, "example": 55.7558 }, "lon": { "type": "number", "description": "Долгота", "format": "double", "nullable": true, "example": 37.6173 }, "address": { "type": "string", "description": "Адрес точки", "nullable": true, "example": "г. Москва, ул. Примерная, д. 1" }, "city_id": { "type": "integer", "description": "Id города. Значение из [словаря городов АТИ](https://ati.su/developers/api/dictionaries/geo/)", "format": "int32", "nullable": true, "example": 3611 }, "region_id": { "type": "integer", "description": "Id региона. Значение из [словаря регионов АТИ](https://ati.su/developers/api/dictionaries/geo/)", "format": "int32", "nullable": true, "example": 151 }, "country_id": { "type": "integer", "description": "Id страны. Значение из [словаря стран АТИ](https://ati.su/developers/api/dictionaries/geo/)", "format": "int32", "nullable": true, "example": 1 }, "point_type": { "type": "integer", "description": "Тип точки: 1 — погрузка, 2 — разгрузка", "format": "int32", "nullable": true, "example": 1 }, "contact_persons": { "type": "array", "items": { "$ref": "#/components/schemas/ATI.Tracker.API.ApiModels.RequestModels.Transportation.Points.ContactPersonPointRequest" }, "description": "Контактные лица на точке", "nullable": true }, "note": { "type": "string", "description": "Примечание к точке", "nullable": true, "example": "Погрузка" }, "timeslots_warehouse_id": { "type": "integer", "description": "Id склада. Значение из [API временных окон](https://ati.su/developers/api/time-slots/time-slots/)", "format": "int32", "nullable": true, "example": 12345 }, "organization_id": { "type": "string", "description": "Id организации. Получить из [справочника организаций](https://ati.su/developers/api/catalogs/organizations)", "format": "uuid", "nullable": true, "example": "b2c3d4e5-f6a7-8901-bcde-f12345678901" } }, "additionalProperties": false }, "ATI.Tracker.DataAccess.Models.Enums.DealInWorkStatus": { "enum": [ "none", "go_to_loading", "ready_to_load", "loading", "loaded", "ready_to_unload", "unloading", "unloaded", "breakdown", "accident", "arrest", "container_received_to_loading", "container_on_loading", "container_finished_loading", "container_sent_from_loading", "container_received_to_unloading", "container_on_unloading", "container_finished_unloading", "container_sent_from_unloading", "empty_container_received", "empty_container_sent", "completed_by_driver" ], "type": "string", "x-enumNames": [ "None", "GoToLoading", "ReadyToLoad", "Loading", "Loaded", "ReadyToUnload", "Unloading", "Unloaded", "Breakdown", "Accident", "Arrest", "ContainerReceivedToLoading", "ContainerOnLoading", "ContainerFinishedLoading", "ContainerSentFromLoading", "ContainerReceivedToUnloading", "ContainerOnUnloading", "ContainerFinishedUnloading", "ContainerSentFromUnloading", "EmptyContainerReceived", "EmptyContainerSent", "CompletedByDriver" ] }, "ATI.Tracker.DataAccess.Models.Enums.DealPointTypes": { "enum": [ "loading", "unloading" ], "type": "string", "x-enumNames": [ "Loading", "Unloading" ] }, "ATI.Tracker.DataAccess.Models.Enums.EventType": { "enum": [ "not_set", "meta", "status", "photo", "other" ], "type": "string", "x-enumNames": [ "NotSet", "Meta", "Status", "Photo", "Other" ] }, "ATI.Tracker.DataAccess.Models.Enums.ExtendedDealInWorkStatus": { "enum": [ "none", "completed_by_driver" ], "type": "string", "x-enumNames": [ "None", "CompletedByDriver" ] }, "ATI.Tracker.DataAccess.Models.Enums.SmsStatus": { "enum": [ "empty", "created", "error", "sent" ], "type": "string", "x-enumNames": [ "Empty", "Created", "Error", "Sent" ] }, "ATI.Tracker.DataAccess.Models.Enums.TrackerOfferStatus": { "enum": [ "none", "sent", "accepted_by_driver", "rejected_by_driver" ], "type": "string", "x-enumNames": [ "None", "Sent", "AcceptedByDriver", "RejectedByDriver" ] }, "DateType": { "type": "integer", "description": "Готовность груза к перевозке\n \n* `0` — Готов к отправке сегодня или завтра\n* `1` — Готов к отправке между FirstDate и LastDate\n* `2` — Готов к отправке постоянно\n* `3` — Груза нет, запрос ставки", "x-enumNames": [ "ReadyToLoading", "BetweenTwoDates", "AlwaysReady", "MissingLoad" ], "enum": [ 0, 1, 2, 3 ] }, "Periodicity": { "type": "integer", "description": "Периодичность загрузки\n \n* `0` — Нет\n* `1` — Ежедневно\n* `100` — Только по рабочим дням", "x-enumNames": [ "None", "EveryDay", "OnlyWorkingDays" ], "enum": [ 0, 1, 100 ] }, "LoadPoint": { "type": "object", "description": "Точка маршрута груза", "additionalProperties": false, "properties": { "fias_id": { "type": "string", "description": "Id точки по базе ФИАС", "format": "guid", "nullable": true }, "city_id": { "type": "integer", "description": "Id города\\\nЗначение из [словаря городов АТИ](https://ati.su/developers/api/dictionaries/geo/) ", "format": "int32", "nullable": true }, "latitude": { "type": "number", "description": "Широта", "format": "decimal", "nullable": true }, "longitude": { "type": "number", "description": "Долгота", "format": "decimal", "nullable": true }, "street": { "type": "string", "description": "Адрес", "nullable": true }, "organization_id": { "type": "string", "description": "Id из справочника организаций", "format": "guid", "nullable": true }, "address_id": { "type": "string", "description": "Id адреса в организации", "format": "guid", "nullable": true }, "time_start": { "type": "string", "description": "Время \"От\"", "format": "date-time", "nullable": true }, "time_end": { "type": "string", "description": "Время \"До\"", "format": "date-time", "nullable": true }, "is_round_the_clock": { "type": "boolean", "description": "Круглосуточно", "nullable": true }, "large_cities": { "type": "array", "description": "Список Id ближайших крупных городов", "nullable": true, "items": { "type": "integer", "format": "int32" } }, "large_cities_with_distance": { "type": "array", "description": "Расстояния до ближайших крупных городов", "nullable": true, "items": { "$ref": "#/components/schemas/LargeCityWithDistance" } }, "loading_cargos": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/LoadingCargo" } }, "organization": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organization" } ] } } }, "LargeCityWithDistance": { "type": "object", "description": "Сущность, описывающая ближайший крупный город", "additionalProperties": false, "properties": { "city_id": { "type": "integer", "description": "Id города\\\nЗначение из [словаря городов АТИ](https://ati.su/developers/api/dictionaries/geo/) ", "format": "int64", "nullable": true }, "distance": { "type": "number", "description": "Расстояние", "format": "double", "nullable": true } } }, "LoadingCargo": { "type": "object", "additionalProperties": false, "properties": { "cargo_id": { "type": "integer", "description": "Id груза", "format": "int32" }, "name_id": { "type": "integer", "description": "Наименование груза", "format": "int32", "nullable": true }, "name": { "type": "string", "nullable": true }, "packaging_type": { "type": "integer", "description": "Упаковка", "format": "int32", "nullable": true }, "packaging_quantity": { "type": "integer", "format": "int32", "nullable": true }, "weight": { "type": "number", "format": "double", "nullable": true }, "volume": { "type": "number", "description": "Объем", "format": "double", "nullable": true }, "sizes": { "description": "Габариты", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/orders__LoadSize" } ] }, "packaging_type_name": { "type": "string", "nullable": true } } }, "orders__LoadSize": { "type": "object", "description": "Размеры груза", "additionalProperties": false, "properties": { "length": { "type": "number", "description": "Длина в метрах", "format": "double", "nullable": true }, "width": { "type": "number", "description": "Ширина в метрах", "format": "double", "nullable": true }, "height": { "type": "number", "description": "Высота в метрах", "format": "double", "nullable": true }, "diameter": { "type": "number", "description": "Диаметр в метрах", "format": "double", "nullable": true }, "length_highlight": { "type": "boolean", "description": "Подсвечивать ли длину", "nullable": true }, "width_highlight": { "type": "boolean", "description": "Подсвечивать ли ширину", "nullable": true }, "height_highlight": { "type": "boolean", "description": "Подсвечивать ли высоту", "nullable": true } } }, "Organization": { "type": "object", "additionalProperties": false, "properties": { "organization_id": { "type": "string", "format": "guid" }, "firm_id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "nullable": true }, "ownership": { "type": "integer", "format": "int32" }, "residency": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Residency" } ] }, "inn": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "extra_phone": { "type": "integer", "format": "int32", "nullable": true }, "docs_address": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/OrganizationDocsAddress" } ] }, "stocks": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/Stock" } }, "contact_persons": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/ContactPerson" } }, "ownership_name": { "type": "string", "nullable": true } } }, "OrganizationDocsAddress": { "type": "object", "additionalProperties": false, "properties": { "postcode": { "type": "string", "nullable": true }, "city_id": { "type": "integer", "format": "int32", "nullable": true }, "street_name": { "type": "string", "nullable": true }, "house_no": { "type": "string", "nullable": true }, "office_no": { "type": "string", "nullable": true } } }, "Stock": { "type": "object", "additionalProperties": false, "properties": { "stock_id": { "type": "string", "format": "guid" }, "address": { "type": "string", "nullable": true }, "address_city_id": { "type": "integer", "format": "int32" }, "address_latitude": { "type": "number", "format": "double" }, "address_longitude": { "type": "number", "format": "double" }, "note": { "type": "string", "nullable": true }, "work_schedules": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/StockSchedule" } }, "breaks_schedules": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/StockSchedule" } }, "contact_persons": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/ContactPerson" } }, "schedule_summary": { "type": "string", "nullable": true }, "stock_type": { "$ref": "#/components/schemas/StockType" }, "timeslots_binding": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TimeslotsBinding" } ] } } }, "StockSchedule": { "type": "object", "additionalProperties": false, "properties": { "stock_schedule_id": { "type": "string", "format": "guid" }, "day_of_week": { "$ref": "#/components/schemas/DayOfWeek" }, "start_time": { "type": "string", "format": "duration" }, "end_time": { "type": "string", "format": "duration" } } }, "ContactPerson": { "type": "object", "additionalProperties": false, "properties": { "contact_person_id": { "type": "string", "format": "guid" }, "name": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true } } }, "StockType": { "type": "integer", "description": "", "x-enumNames": [ "Stock", "Office", "Store" ], "enum": [ 1, 2, 3 ] }, "TimeslotsBinding": { "type": "object", "additionalProperties": false, "properties": { "warehouse_id": { "type": "integer", "format": "int32" }, "status": { "$ref": "#/components/schemas/TimeslotsBindingStatus" } } }, "LoadExtraPoint": { "type": "object", "additionalProperties": false, "properties": { "route_point_id": { "type": "string", "format": "guid" }, "id": { "type": "string", "format": "guid" }, "city_id": { "type": "integer", "description": "Id города\\\nЗначение из [словаря городов АТИ](https://ati.su/developers/api/dictionaries/geo/) ", "format": "int32", "nullable": true }, "point_type": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/LoadExtraPointType" } ] }, "ordinal_id": { "type": "integer", "description": "Порядковый номер в маршруте", "format": "int32", "nullable": true }, "distance": { "type": "integer", "description": "Расстояние", "format": "int32", "nullable": true }, "street": { "type": "string", "description": "Адрес", "nullable": true }, "latitude": { "type": "number", "description": "Широта", "format": "decimal", "nullable": true }, "longitude": { "type": "number", "description": "Долгота", "format": "decimal", "nullable": true }, "organization_id": { "type": "string", "description": "Id из справочника организаций", "format": "guid", "nullable": true }, "address_id": { "type": "string", "description": "Id адреса в организации", "format": "guid", "nullable": true }, "loading_date_start": { "type": "string", "description": "Дата начала загрузки", "format": "date-time", "nullable": true }, "loading_date_end": { "type": "string", "description": "Дата конца загрузки", "format": "date-time", "nullable": true }, "loading_time_start": { "type": "string", "description": "Время начала загрузки", "format": "duration", "nullable": true }, "loading_time_end": { "type": "string", "description": "Время конца загрузки", "format": "duration", "nullable": true }, "is_round_the_clock": { "type": "boolean", "description": "Круглосуточно", "nullable": true }, "city_name": { "type": "string", "nullable": true }, "loading_cargos": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/LoadingCargo" } }, "unloading_cargos": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/UnloadingCargo" } }, "organization": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organization" } ] } } }, "LoadExtraPointType": { "type": "integer", "description": "Тип дополнительной точки маршрута груза\n \n* `1` — Загрузка\n* `2` — Разгрузка\n* `3` — Таможня\n* `4` — Ближайший крупный город к городу загрузки\n* `5` — Ближайший крупный город к городу разгрузки\n* `8` — Проехать через", "x-enumNames": [ "LoadingExtraPoint", "UnloadingExtraPoint", "CustomExtraPoint", "LoadingLargeCity", "UnloadingLargeCity", "DriverThrough" ], "enum": [ 1, 2, 3, 4, 5, 8 ] }, "UnloadingCargo": { "type": "object", "additionalProperties": false, "properties": { "cargo_id": { "type": "integer", "description": "Id груза", "format": "int32" }, "weight": { "type": "number", "description": "Вес", "format": "double", "nullable": true }, "volume": { "type": "number", "description": "Объём", "format": "double", "nullable": true }, "packaging_quantity": { "type": "integer", "description": "Выгружаемая часть упаковки", "format": "int32", "nullable": true }, "is_defined_by_ttn": { "type": "boolean", "description": "Выгружаемая часть груза будет определена в ТТН", "nullable": true } } }, "LoadCargo": { "type": "object", "description": "Параметры груза", "additionalProperties": false, "properties": { "weight": { "type": "number", "description": "Вес", "format": "double", "nullable": true }, "volume": { "type": "number", "description": "Объем", "format": "double", "nullable": true }, "adr": { "type": "integer", "description": "Модификатор опасности груза с 0 до 9", "format": "int32", "nullable": true }, "cargo_type_id": { "type": "integer", "description": "Идентификатор наименования груза\\\nЗначение из [словаря наименований грузов](https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-cargoTypes)", "format": "int32", "nullable": true }, "cargo_type": { "type": "string", "description": "Строковое наименование груза. Выводится если CargoTypeId не указан, либо равен `59`", "nullable": true }, "pack_type": { "type": "integer", "description": "Тип упаковки(навалом, коробки, россыпью, запаллечен ... пирамида). Значение из словаря PackTypes", "format": "int32", "nullable": true }, "pallet_count": { "type": "integer", "description": "Количество паллетов", "format": "int32", "nullable": true }, "belt_count": { "type": "integer", "description": "Количество ремней", "format": "int32", "nullable": true }, "dogruz_type": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DogruzType" } ] }, "sbor_gruz": { "type": "boolean", "description": "Сборный груз", "nullable": true }, "size": { "description": "Размеры груза", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/orders__LoadSize" } ] } } }, "DogruzType": { "type": "integer", "description": "Параметр, отвечающий за способ перевозки груза\n \n* `1` — Только отдельной машиной\n* `2` — Догруз возможен\n* `3` — Догруз", "x-enumNames": [ "OnlyToSeparateCar", "DogruzPossible", "Dogruz" ], "enum": [ 1, 2, 3 ] }, "LoadTransport": { "type": "object", "description": "Параметры перевозки", "additionalProperties": false, "properties": { "car_type": { "type": "integer", "description": "Битовая сумма кузовов", "format": "int64", "nullable": true }, "car_type_string": { "type": "string", "nullable": true }, "loading_type": { "type": "integer", "description": "Битовая сумма типов загрузки", "format": "int32", "nullable": true }, "loading_logical_operator": { "type": "string", "description": "Тип условия загрузки\n\n* `OR`\n* `AND`", "default": "OR", "nullable": true }, "unloading_type": { "type": "integer", "description": "Битовая сумма типов разгрузки", "format": "int32", "nullable": true }, "unloading_logical_operator": { "type": "string", "description": "Тип условия разгрузки\n \n* `OR`\n* `AND`", "default": "OR", "nullable": true }, "trucks_quantity": { "type": "integer", "description": "Количество машин", "format": "int32", "nullable": true }, "temperature_from": { "type": "integer", "description": "Температура перевозки - нижнее значение", "format": "int32", "nullable": true }, "temperature_to": { "type": "integer", "description": "Температура перевозки - верхнее значение", "format": "int32", "nullable": true }, "truck_attribs": { "type": "integer", "description": "Настройки для машины, используются только в RMQ (Stsepka, Pnevmohod, Koniki)", "format": "int32", "nullable": true }, "stsepka": { "type": "boolean", "description": "Сцепка", "nullable": true }, "pnevmohod": { "type": "boolean", "description": "Пневмоход", "nullable": true }, "koniki": { "type": "boolean", "description": "Коники", "nullable": true }, "tir": { "type": "boolean", "description": "TIR", "nullable": true }, "cmr": { "type": "boolean", "description": "CMR", "nullable": true }, "t1": { "type": "boolean", "description": "Т1", "nullable": true }, "san_passport": { "type": "boolean", "description": "Мед книжка", "nullable": true }, "sanitation_logbook": { "type": "boolean", "description": "Сан. книжка", "nullable": true }, "is_tracking": { "type": "boolean", "description": "Запрос отслеживания через АТИ Водитель", "nullable": true }, "required_capacity": { "type": "number", "description": "Требуемая грузоподъёмность в тоннах", "format": "decimal", "nullable": true } } }, "LoadMeta": { "type": "object", "description": "Метаданные груза", "additionalProperties": false, "properties": { "load_meta_id": { "type": "string", "description": "Id", "format": "guid", "nullable": true }, "meta_data": { "type": "string", "description": "Данные", "nullable": true } } }, "DealState": { "type": "integer", "description": "Статус Заказа\n\n* `0` — Груз зарезервирован перевозчиком\n* `1` — Перевозчик заполнил информацию о реквизитах/водителе/машине и грузовладелец не просмотрел заявку\n* `2` — Перевозчик заполнил информацию о реквизитах/водителе/машине и грузовладелец просмотрел заявку\n* `3` — Грузовладелец отправил документ-заявку перевозчику\n* `4` — Заказ в исполнении (перевозчик дал согласие на документ-заявку)\n* `5` — Заказ завершен и перенесен в архив\n* `7` — Есть только приглашение на Заказ\n* `8` — Заказа нет, но есть Торги, у которых есть возможные победители\n* `9` — Заказ отклонен автоматически, так как после последней даты загрузки прошло уже более 20 дней\n* `10` — Заказ завершен, ожидается оплата\n* `11` — В Торгах лучшая ставка из других Торгов\n* `-11` — Заказ удален\n* `-10` — Резерв груза перевозчиком отменен\n* `-9` — Заказ отклонен грузовладельцем в Торгах после истечения срока подачи документов (смена победителя)\n* `-8` — Грузовладелец отменил Заказ в исполнении\n* `-7` — Перевозчик отменил Заказ в исполнении\n* `-6` — Заказ отклонен грузовладельцем после удаления Торгов\n* `-4` — Заказ отклонен грузовладельцем в Торгах (смена победителя)\n* `-3` — Заказ отклонен грузовладельцем\n* `-2` — Заказ отозван перевозчиком", "x-enumNames": [ "Reserve", "Taken", "TakenViewed", "DocumentSentByCargoOwner", "DocumentApprovedByTrucker", "Finished", "PersonalDealInvite", "AuctionWithPossibleWinner", "CancelAuto", "WaitPaymentAndDocuments", "BestRateFromOtherPassThroughAuction", "Deleted", "ReserveCanceled", "DenialInAuctionByDocExpired", "CancelInWorkByCargoOwner", "CancelInWorkByTrucker", "DenialBecauseDeleteAuction", "DenialInAuction", "DenialByCargoOwner", "DenialByTrucker" ], "enum": [ 0, 1, 2, 3, 4, 5, 7, 8, 9, 10, 11, -11, -10, -9, -8, -7, -6, -4, -3, -2 ] }, "RateType": { "type": "integer", "description": "Тип оплаты\n \n* `0` — Нет\n* `1` — Любая\n* `2` — С НДС\n* `3` — Без НДС", "x-enumNames": [ "None", "Common", "Nds", "WithoutNds" ], "enum": [ 0, 1, 2, 3 ] }, "DocumentType": { "type": "integer", "description": "Тип документа\n \n* `0` — Нет\n* `1` — Заказ\n* `2` — Договор-заявка\n* `3` — Поручение экспедитору\n* `4` — Акт\n* `5` — Счет\n* `6` — Одностороннее расторжение\n* `7` — Доверенность\n* `8` — Табличный заказ\n* `9` — Заявка к договору (табличный вид)", "x-enumNames": [ "None", "Order", "Application", "ForwarderInstruction", "Act", "Invoice", "UnilateralDissolution", "PowerOfAttorney", "TableOrder", "TableApplication" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ] }, "DealDocumentAccess": { "type": "integer", "description": "Доступ к документу\n \n* `0` — Обе стороны\n* `1` — Водитель", "x-enumFlags": true, "x-enumNames": [ "SharedWithCounterparty", "SharedWithAtiTrucker" ], "enum": [ 0, 1 ] }, "InWorkStatusModel": { "type": "integer", "description": "Статусная модель перевозки\n \n* `0` — Простая перевозка\n* `1` — Первая миля\n* `2` — Последняя миля\n* `3` — Порожний контейнер", "x-enumNames": [ "Default", "FirstMile", "LastMile", "EmptyContainer" ], "enum": [ 0, 1, 2, 3 ] }, "DealFileAccess": { "type": "integer", "description": "Доступ к файлу\n \n* `0` — только загрузивший файл\n* `1` — обе стороны\n* `2` — загрузивший файл и водитель\n* `3` — доступен обеим сторонам и водителю", "x-enumFlags": true, "x-enumNames": [ "OnlyYou", "SharedWithCounterparty", "SharedWithAtiTrucker", "SharedWithAtiTruckerAndCounterparty" ], "enum": [ 0, 1, 2, 3 ] }, "DealFileSourceTypes": { "type": "integer", "description": "Источник файла\n \n* `0` — Загружен в заказ\n* `1` — Скопирован из груза\n* `2` — Скопирован из данных о водителе\n* `3` — Скопироване из данных о грузовике\n* `4` — Скопирован из данных о прицепе\n* `5` — Скопирован из данных о полуприцепе\n* `6` — Скопирован из данных о тягаче\n* `7` — Загружен для Ати-водителя\n* `8` — Загружен из приложения АТИ-водитель\n* `9` — Загружен из Gallifrey (Временные окна)", "x-enumNames": [ "SimpleLoader", "Load", "Driver", "Truck", "Trailer", "SemiTrailer", "Tractor", "AtiTruckerPopupLoader", "FromAtiDriver", "FromGallifrey" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9 ] }, "DealFileSourceFileTypes": { "type": "integer", "description": "Тип загруженного файла\n \n* `0` — Обычный файл\n* `1` — Скан водительского удостоверения\n* `2` — Скан гражданского паспорта водителя\n* `3` — Скан ПТС\n* `4` — Скан пластикового ПТС\n* `5` — Фото ТС\n* `8` - Скан договора о безвоздмездном пользовании", "x-enumNames": [ "None", "DriverLicense", "DriverPassport", "TruckTechPassport", "TruckPlasticTechPassport", "TruckPhoto", "FreeUse" ], "enum": [ 0, 1, 2, 3, 4, 5, 8 ] }, "DealFileType": { "type": "integer", "description": "Тип файла\n \n* `0` — Другой документ\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* `13` — Доп. соглашение к договору\n* `14` — Доверенность\n* `15` — Поручение экспедитору\n* `16` — Информационное письмо\n* `17` — Документ о происшествии с грузом/ТС", "x-enumNames": [ "OtherDoc", "ConsignmentNote", "PackingList", "WayBill", "WayBillGeneral", "Invoice", "InvoiceForPayment", "PaymentOrder", "CertificateOfCompletion", "Request", "RequestForOrder", "Order", "Contract", "SupplementaryAgreement", "Dealership", "Assignment", "InfoLetter", "AccidentAct" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17 ] }, "DealPointTypes": { "type": "integer", "description": "Тип точки маршрута\n \n* `1` — Загрузка\n* `2` — Разгрузка\n* `3` — Таможня\n* `8` — Ехать через", "x-enumNames": [ "Loading", "Unloading", "Customs", "GoThrough" ], "enum": [ 1, 2, 3, 8 ] }, "InWorkStatus": { "type": "integer", "description": "Статус перевозки\n \n* `0` — Нет статуса\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* `13` — Погрузка контейнера окончена\n* `14` — Контейнер сдан с погрузки\n* `15` — Контейнер получен на выгрузку\n* `16` — Контейнер на выгрузке\n* `17` — Выгрузка контейнера окончена\n* `18` — Контейнер сдан с выгрузки\n* `19` — Пустой контейнер получен\n* `20` — Пустой контейнер сдан\n* `100` — Заказ завершён", "x-enumNames": [ "None", "GoToLoading", "ReadyToLoad", "Loading", "Loaded", "ReadyToUnload", "Unloading", "Unloaded", "Breakdown", "Accident", "Arrested", "ContainerReceivedToLoading", "ContainerOnLoading", "ContainerFinishedLoading", "ContainerSentFromLoading", "ContainerReceivedToUnloading", "ContainerOnUnloading", "ContainerFinishedUnloading", "ContainerSentFromUnloading", "EmptyContainerReceived", "EmptyContainerSent", "CompletedByDriver" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 100 ] }, "TrackerOwnerAccess": { "type": "integer", "description": "", "x-enumNames": [ "Hide", "Show" ], "enum": [ 0, 1 ] }, "DealKinds": { "type": "integer", "description": "Тип Заказа\n \n* `0` — Заказ невозможен \n* `1` — Взятие груза из поиска\n* `2` — Заказ из Торгов\n* `4` — Предложение груза\n* `8` — Из перехвата машин\n* `16` — Односторонний заказ\n* `32` — Предложение груза из встречного предложения\n* `64` — Предложение груза по контракту\n* `128` — Создан вручную для тестирования черновиков\n* `256` — Создан из АТИ-Доков", "x-enumFlags": true, "x-enumNames": [ "None", "OrdinaryDeal", "AuctionDeal", "PersonalDeal", "TruckInterDeal", "UnilateralDeal", "CounterOfferDeal", "ContractDeal", "DraftDeal", "AtiDocumentDeal" ], "enum": [ 0, 1, 2, 4, 8, 16, 32, 64, 128, 256 ] }, "PaymentSource": { "type": "integer", "description": "Источник параметров оплаты\n \n * `0` — Нет\n * `1` — Встречное предложение\n * `2` — Торги\n * `3` — Груз\n * `4` — Предложение груза\n * `5` — Предложение по контракту", "x-enumNames": [ "None", "CounterOffer", "Auction", "Load", "Invitation", "Contract" ], "enum": [ 0, 1, 2, 3, 4, 5 ] }, "OrderRole": { "type": "integer", "description": "Роль\n\n* `0` — Грузовладелец\n* `1` — Перевозчик", "x-enumNames": [ "CargoOwner", "Carrier" ], "enum": [ 0, 1 ] }, "Scan": { "type": "object", "description": "Скан документа ТС или водителя", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "ID ", "format": "guid" }, "owner_id": { "type": "string", "description": "ID сущности, котрой принадлежит скан", "format": "guid", "nullable": true }, "name": { "type": "string", "description": "Название", "nullable": true }, "file_id": { "type": "string", "description": "ID файла", "nullable": true }, "type": { "description": "Тип документа\n \n* `1` — Скан водительского удостоверения\n* `2` — Скан гражданского паспорта\n* `3` — Скан ПТС\n* `4` — Скан пластикового ПТС\n* `5` — Фото ТС\n* `8` — Договор о безвоздмездном пользовании", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/AutoparkDocumentType" } ] } } }, "AutoparkDocumentType": { "type": "integer", "description": "Тип документа сущности каталогов\n \n* `1` — Скан водительского удостоверения\n* `2` — Скан гражданского паспорта\n* `3` — Скан ПТС\n* `4` — Скан пластикового ПТС\n* `6` — Скан договора аренды\n* `5` — Фото ТС\n* `8` — Договор о безвоздмездном пользовании", "x-enumNames": [ "DriverLicense", "Passport", "TechPassport", "PlasticTechPassport", "TruckPhoto", "RentContract", "FreeUse" ], "enum": [ 1, 2, 3, 4, 5, 6, 8 ] }, "TrackerOfferStatus": { "type": "integer", "description": "", "x-enumNames": [ "None", "Sent", "AcceptedByDriver", "RejectedByDriver" ], "enum": [ 0, 1, 2, 3 ] }, "MapCarType": { "type": "integer", "description": "", "x-enumNames": [ "Ok", "GpsDisabled", "GpsSpoof", "NoData", "PowerSaving", "Parking" ], "enum": [ 0, 1, 2, 3, 4, 5 ] }, "DriverOrigin": { "type": "integer", "description": "Идентификатор источника информации о водителе\n \n* `0` — Неизвестно откуда указан водитель\n* `1` — Водитель указан на странице заказов у Заказа в исполнении\n* `2` — Водитель указан в АТИ-Доках", "x-enumNames": [ "Unknown", "OrdersUiFromDealInProgress", "AtiDocs" ], "enum": [ 0, 1, 2 ] }, "orders__TruckOwnershipType": { "type": "integer", "description": "Тип владения ТС\n \n* `0` - Собственное\n* `1` - Привлеченное\n* `2` - Аренда\n* `3` - Лизинг\n* `4` - Совместная собственность (супругов)\n* `5` - Безвозмездное пользование", "x-enumNames": [ "Own", "Attracted", "Rent", "Leasing", "JointOwnershipSpouses", "FreeUse" ], "enum": [ 0, 1, 2, 3, 4, 5 ] }, "TruckOrigin": { "type": "integer", "description": "Источник создания Транспорта\n \n* `0` — Неизвестно откуда указано ТС\n* `1` — ТС указано на странице заказов у Заказа в исполнении\n* `2` — ТС Указано в АТИ-доках", "x-enumNames": [ "Unknown", "OrdersUiFromDealInProgress", "ATIDocs" ], "enum": [ 0, 1, 2 ] }, "FinalExceptionModelOfFileAccessDeniedException": { "type": "object", "description": "Модель ошибки", "additionalProperties": false, "properties": { "reason": { "type": "string", "description": "Причина ошибки" }, "error": { "type": "string", "description": "Ключ ошибки" } } }, "DealDocumentAccessDto": { "type": "object", "additionalProperties": false, "properties": { "access": { "description": "Доступ к документу", "oneOf": [ { "$ref": "#/components/schemas/DealDocumentAccess" } ] }, "timeslots_warehouse_ids": { "type": "array", "description": "Список складов с Временными окнами с доступом к документу", "items": { "type": "integer", "format": "int32" } } } }, "DealFileView": { "type": "object", "description": "Файлы заказа", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "Id файла", "format": "guid", "nullable": true }, "storage_file_id": { "type": "string", "description": "Id файла в хранилище", "nullable": true }, "access": { "description": "Доступ к файлу\n \n* `0` — только загрузивший файл\n* `1` — обе стороны\n* `2` — загрузивший файл и водитель\n* `3` — доступен обеим сторонам и водителю", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DealFileAccess" } ] }, "add_date": { "type": "string", "description": "Время загрузки файла", "format": "date-time", "nullable": true }, "deal_id": { "type": "string", "description": "Id связанного Заказа", "format": "guid" }, "is_counterparty_file": { "type": "boolean", "description": "Файл контрагента", "nullable": true }, "file_name": { "type": "string", "description": "Имя файла", "nullable": true }, "size": { "type": "integer", "description": "Размер файла", "format": "int32", "nullable": true }, "link": { "type": "string", "description": "Ссылка на файл", "nullable": true }, "file_id": { "type": "string", "description": "ID файла", "nullable": true }, "source_type": { "description": "Источник файла\n \n* `0` — Загружен в заказ\n* `1` — Скопирован из груза\n* `2` — Скопирован из данных о водителе\n* `3` — Скопироване из данных о грузовике\n* `4` — Скопирован из данных о прицепе\n* `5` — Скопирован из данных о полуприцепе\n* `6` — Скопирован из данных о тягаче\n* `7` — Загружен для Ати-водителя", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DealFileSourceTypes" } ] }, "source_file_type": { "description": "Тип загруженного файла\n \n* `0` — Обычный файл\n* `1` — Водительское удостоверение\n* `2` — Паспорт водителя\n* `3` — Техпаспорт ТС\n* `4` — Пластик\n* `5` — Фото ТС", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DealFileSourceFileTypes" } ] }, "file_type": { "description": "Тип файла\n \n* `0` — Другой документ\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* `13` — Доп. соглашение (к договору)\n* `14` — Доверенность\n* `15` — Поручение экспедитору\n* `16` — Информационное письмо\n* `17` — Документ о происшествии с грузом/ТС", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DealFileType" } ] }, "timeslots_warehouse_ids": { "type": "array", "description": "Список складов с Временными окнами с доступом к файлу", "nullable": true, "items": { "type": "integer", "format": "int32" } } } }, "DealFileAccessDto": { "type": "object", "additionalProperties": false, "properties": { "access": { "description": "Доступ к файлу", "oneOf": [ { "$ref": "#/components/schemas/DealFileAccess" } ] }, "timeslots_warehouse_ids": { "type": "array", "description": "Список складов с Временными окнами с доступом к файлу", "items": { "type": "integer", "format": "int32" } } } }, "DealDocumentTemplateAccess": { "type": "integer", "description": "Доступ к файлу\n \n* `0` — только загрузивший файл\n* `1` — обе стороны", "x-enumFlags": true, "x-enumNames": [ "OnlyYou", "SharedWithCounterparty" ], "enum": [ 0, 1 ] }, "ContactPerson2": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "Контактное лицо", "nullable": true }, "phone": { "type": "string", "description": "Телефон контактного лица", "nullable": true }, "ordinal_id": { "type": "integer", "description": "Порядковый номер добавления контактного лица (от 1 до 10)", "format": "int32", "example": 1 } } }, "orders__ContactPersonView": { "type": "object", "additionalProperties": false, "properties": { "contact_person_id": { "type": "string", "format": "guid" }, "name": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" } } }, "RateView": { "type": "object", "additionalProperties": false, "properties": { "rate": { "type": "number", "description": "Сумма", "format": "decimal", "nullable": true }, "rate_type": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/RateType" } ] }, "currency": { "type": "integer", "description": "Id валюты", "format": "int32", "nullable": true }, "active": { "type": "boolean", "description": "Является ли ставка выбранной" } } }, "DocumentStatusInfoView": { "type": "object", "additionalProperties": false, "properties": { "checked": { "type": "boolean", "description": "Документ получен" }, "date": { "type": "string", "description": "Дата получения документов", "format": "date-time", "nullable": true } } }, "DocumentTrackingInfoView": { "type": "object", "additionalProperties": false, "properties": { "transport_company_id": { "type": "integer", "description": "Id транспортной компании, осуществляющей доставку документов", "format": "int32" }, "tracking_url": { "type": "string", "description": "Сссылка для отслеживания статуса отправления", "nullable": true }, "tracking_number": { "type": "string", "description": "Номер отправления", "nullable": true }, "sending_date": { "type": "string", "description": "Дата отправки документов", "format": "date-time", "nullable": true } } }, "PaymentStatusView": { "type": "object", "additionalProperties": false, "properties": { "checked": { "type": "boolean", "description": "Заказ оплачен" }, "date": { "type": "string", "description": "Дата оплаты", "format": "date-time", "nullable": true } } }, "CustomerView": { "type": "object", "additionalProperties": false, "properties": { "ati_id": { "type": "string", "description": "ID заказчика в ATI. Если заказчик является внешним контрагентом, то будет равняться ID из справочника \"Контрагенты не из АТИ\"", "nullable": true }, "source": { "description": "Источник информации о заказчике\n\n* `1` - Справочник \"Контрагенты не из АТИ\"\n* `2` - Глобальный поиск\n* `3` - Справочник \"Ваши реквизиты\"", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CustomerSource" } ] }, "name": { "type": "string", "description": "Имя заказчика", "nullable": true }, "ownership_id": { "type": "integer", "description": "ID типа фирмы (ИП/ООО/др.)", "format": "int32", "nullable": true }, "inn": { "type": "string", "description": "ИНН\n ", "nullable": true }, "ogrn": { "type": "string", "description": "ОГРН\n ", "nullable": true }, "requisite": { "description": "Реквизиты", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/RequisiteView2" } ] }, "gen_director": { "description": "Генеральный директор", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/GenDirectorView" } ] }, "contact": { "description": "Контакты\n ", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ContactView2" } ] }, "address": { "type": "array", "description": "Адрес", "nullable": true, "items": { "$ref": "#/components/schemas/orders__AddressView" } }, "claims_count": { "type": "integer", "description": "Количество претензий", "format": "int32", "nullable": true }, "recommendation_count": { "type": "integer", "description": "Количество рекомендаций", "format": "int32", "nullable": true }, "bad_partner_firms_count": { "type": "integer", "description": "Количество фирм, которые написали о данной фирме на форуме Недобросовестных партнеров", "format": "int32", "nullable": true } } }, "CustomerSource": { "type": "integer", "description": "Источник информации о заказчике\n\n* `1` - Справочник \"Контрагенты не из АТИ\"\n* `2` - Глобальный поиск\n* `3` - Справочник \"Ваши реквизиты\"", "x-enumNames": [ "Contractors", "GlobalSearch", "BillingRequisites" ], "enum": [ 1, 2, 3 ] }, "RequisiteView2": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "Наименование реквизитов", "nullable": true }, "bank": { "type": "string", "description": "Наименование банка", "nullable": true }, "ks": { "type": "string", "description": "Корреспондентский счёт", "nullable": true }, "registration_number": { "type": "string", "description": "Регистрационный номер", "nullable": true }, "rs": { "type": "string", "description": "Расчётный счёт", "nullable": true }, "bik": { "type": "string", "description": "БИК", "nullable": true } } }, "GenDirectorView": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "Имя", "nullable": true }, "surname": { "type": "string", "description": "Фамилия", "nullable": true }, "patronymic": { "type": "string", "description": "Отчество", "nullable": true }, "number_phone": { "type": "string", "description": "Номер телефона", "nullable": true } } }, "ContactView2": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string", "description": "Имя контакта", "nullable": true }, "surname": { "type": "string", "description": "Фамилия", "nullable": true }, "patronymic": { "type": "string", "description": "Отчество", "nullable": true }, "number_phone": { "type": "string", "description": "Номер мобильного телефона", "nullable": true }, "phone": { "type": "string", "description": "Номер городского телефона", "nullable": true }, "messenger_phone": { "type": "string", "description": "Дополнительный телефон", "nullable": true }, "fax": { "type": "string", "description": "Факс", "nullable": true }, "was_modified": { "type": "boolean", "description": "Флаг редактирования контакта", "nullable": true }, "selected_number": { "description": "Выбранный номер телефона", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/SelectedNumberView" } ] }, "is_confirmed": { "type": "boolean", "description": "Признак подтверждения контакта", "nullable": true } } }, "SelectedNumberView": { "type": "object", "additionalProperties": false, "properties": { "value": { "type": "string", "description": "Телефонный номер", "nullable": true }, "country_code": { "type": "string", "description": "Строковый двузначный код страны выбранного телефонного номера", "nullable": true } } }, "orders__AddressView": { "type": "object", "additionalProperties": false, "properties": { "is_legal": { "type": "boolean", "description": "True - Юридический адрес\nFalse - Фактический адрес" }, "post_index": { "type": "string", "description": "Почтовый индекс", "nullable": true }, "city_id": { "type": "integer", "description": "ID Города", "format": "int32", "nullable": true }, "street_name": { "type": "string", "description": "Название улицы", "nullable": true }, "house": { "type": "string", "description": "Номер дома", "nullable": true }, "entrance": { "type": "string", "description": "Вход", "nullable": true }, "litera": { "type": "string", "description": "Литера/корпус", "nullable": true }, "office_no": { "type": "string", "description": "Номер офиса", "nullable": true }, "recipient_full_name": { "type": "string", "description": "ФИО Получателя", "nullable": true }, "comment": { "type": "string", "description": "Комментарий", "nullable": true }, "region_id": { "type": "integer", "description": "ID региона", "format": "int32", "nullable": true } } }, "ChangeDriverDto": { "type": "object", "additionalProperties": false, "properties": { "deal_id": { "type": "string", "description": "Идентификатор Заказа", "format": "guid" }, "driver_id": { "type": "string", "description": "Идентификатор нового водителя", "format": "guid" } } }, "ChangeTruckDto": { "type": "object", "additionalProperties": false, "properties": { "deal_id": { "type": "string", "description": "Идентификатор Заказа", "format": "guid" }, "truck_id": { "type": "string", "description": "Идентификатор Грузовика или Тягача", "format": "guid", "nullable": true }, "trailer_id": { "type": "string", "description": "Идентификатор Прицепа", "format": "guid", "nullable": true }, "semitrailer_id": { "type": "string", "description": "Идентификатор Полуприцепа", "format": "guid", "nullable": true } } }, "ChangeRateDto": { "type": "object", "additionalProperties": false, "properties": { "deal_id": { "type": "string", "description": "Идентификатор Заказа", "format": "guid", "nullable": true, "example": "B3803262-B6BE-47C1-83AB-613DEEEFDCBC" }, "rate": { "type": "number", "description": "Размер ставки", "format": "decimal", "nullable": true, "example": 100000 }, "currency_id": { "type": "integer", "description": "Id валюты из [словаря валют АТИ](https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes)", "format": "int32", "nullable": true, "example": 1 }, "rate_type_id": { "type": "integer", "description": "Тип оплаты. 1 - наличные, 2 - с НДС, 3 - без НДС", "format": "int32", "nullable": true, "example": 1 }, "on_card": { "type": "boolean", "description": "Возможность отправлять наличные на карту" } } }, "PayDocsDto2": { "type": "object", "additionalProperties": false, "properties": { "documents_copies": { "description": "Информация о копиях документов", "oneOf": [ { "$ref": "#/components/schemas/DocumentStatusInfoView" } ] }, "documents_original": { "description": "Информация об оригиналах документов", "oneOf": [ { "$ref": "#/components/schemas/DocumentStatusInfoView" } ] }, "documents_original_track": { "description": "Информация об отслеживании отправки оригиналов документов (Только для Перевозчика)", "oneOf": [ { "$ref": "#/components/schemas/DocumentTrackingInfoDto" } ] }, "closing_documents": { "description": "Информация о закрывающих документах (Только для Перевозчика)", "oneOf": [ { "$ref": "#/components/schemas/DocumentStatusInfoView" } ] }, "payment": { "description": "Информация об оплате", "oneOf": [ { "$ref": "#/components/schemas/PaymentStatusView" } ] } } }, "DocumentTrackingInfoDto": { "type": "object", "additionalProperties": false, "properties": { "transport_company_id": { "type": "integer", "description": "ID транспортной компании, осуществляющей доставку документов", "format": "int32" }, "tracking_url": { "type": "string", "description": "Сссылка для отслеживания статуса отправления", "nullable": true }, "tracking_number": { "type": "string", "description": "Номер отправления" }, "sending_date": { "type": "string", "description": "Дата отправки документов", "format": "date-time", "nullable": true } } }, "DealInWorkDto2": { "type": "object", "additionalProperties": false, "properties": { "in_work_status": { "$ref": "#/components/schemas/InWorkStatus" } } }, "WeightType": { "type": "integer", "description": "Тип веса груза\n \n* `0` — Килограммы\n* `1` — Тонны", "x-enumNames": [ "Kilos", "Tons" ], "enum": [ 0, 1 ] }, "UnilateralOrderViewOfFullDealView": { "type": "object", "description": "Груз и связанный заказ", "additionalProperties": false, "properties": { "load_copy": { "description": "Груз", "oneOf": [ { "$ref": "#/components/schemas/LoadCopyView" } ] }, "deal": { "description": "Заказ", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FullDealView" } ] } } }, "LoadCopyView": { "type": "object", "description": "Копия груза\n\n*При взятии груз копируется, копия не отображается в поиске и её невозможно отредактировать*", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "Id копии груза ", "format": "guid" }, "load_number": { "type": "string", "description": "Сгенерированный номер груза" }, "load_meta": { "$ref": "#/components/schemas/LoadMeta" }, "auction_id": { "type": "string", "description": "Id Торгов (аукциона)", "format": "guid", "nullable": true }, "updated_at": { "type": "string", "description": "Дата последнего изменения груза", "format": "date-time" }, "added_at": { "type": "string", "description": "Дата добавления груза", "format": "date-time" }, "archive_date": { "type": "string", "description": "Дата помещения груза в архив\n\n*При взятии груза, он попадает в архив*", "format": "date-time", "nullable": true }, "distance": { "type": "integer", "description": "Расстояние для груза\n \n*При расчете учитываются дополнительные пункты разгрузки*", "format": "int32" }, "distance_type": { "type": "integer", "description": "Маршрут построен с проездом по МКАД или без МКАД\n \n* `0` — без МКАД\n* `1` — с МКАД", "format": "int32" }, "platon_roads_length": { "type": "integer", "description": "Расстояние по Платону", "format": "int32" }, "toll_roads_length": { "type": "integer", "description": "Расстояние по платным дорогам", "format": "int32" }, "travel_time": { "type": "string", "description": "Время в пути", "format": "duration" }, "true_price": { "type": "integer", "description": "Озвученная ставка", "format": "int32" }, "true_currency_id": { "type": "integer", "description": "Id валюты озвученной ставки", "format": "int32" }, "parent_id": { "type": "string", "description": "Id груза", "format": "guid", "nullable": true }, "is_unpublished": { "type": "boolean", "description": "Груз не опубликован" }, "firm_id": { "type": "integer", "description": "ID фирмы, выставившей груз", "format": "int32" }, "contact_id1": { "type": "integer", "description": "Контакт #1, указанный в грузе", "format": "int32" }, "contact_id2": { "type": "integer", "description": "Контакт #2, указанный в грузе", "format": "int32", "nullable": true }, "note": { "type": "string", "description": "Примечание к грузу" }, "first_date": { "type": "string", "description": "Дата, начиная с которой груз актуален", "format": "date-time" }, "last_date": { "type": "string", "description": "Дата, после которой груз не актуален", "format": "date-time" }, "date_type": { "$ref": "#/components/schemas/DateType" }, "periodicity_id": { "$ref": "#/components/schemas/Periodicity" }, "order_number": { "type": "string", "description": "Номер груза/заказа" }, "krugoreis": { "type": "boolean", "description": "Кругорейс" }, "zimnik": { "type": "boolean", "description": "Зимники" }, "ferries": { "type": "boolean", "description": "Паромные переправы" }, "loading": { "description": "Точка загрузки", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/orders__LoadPointView" } ] }, "extra_points": { "type": "array", "description": "Дополнительные точки ", "nullable": true, "items": { "$ref": "#/components/schemas/LoadExtraPointView2" } }, "unloading": { "description": "Точка разгрузки", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/orders__LoadPointView" } ] }, "cargo": { "description": "Параметры груза", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/orders__LoadCargoView" } ] }, "transport": { "description": "Параметры перевозки", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/LoadTransportView2" } ] }, "boards": { "type": "array", "description": "Площадки, на которых опубликован груз", "nullable": true, "items": { "$ref": "#/components/schemas/BoardView" } }, "unload_first_date": { "type": "string", "description": "Дата, начиная с которой можно разгрузить груз", "format": "date-time", "nullable": true }, "unload_last_date": { "type": "string", "description": "Дата, до которой можно разгрузить груз", "format": "date-time", "nullable": true } } }, "orders__LoadPointView": { "type": "object", "description": "Точка маршрута груза", "additionalProperties": false, "properties": { "fias_id": { "type": "string", "description": "Id точки по базе ФИАС", "format": "guid" }, "city_id": { "type": "integer", "description": "Id города\\\nЗначение из [словаря городов АТИ](https://ati.su/developers/api/dictionaries/geo/) ", "format": "int32" }, "latitude": { "type": "number", "description": "Широта", "format": "decimal", "nullable": true }, "longitude": { "type": "number", "description": "Долгота", "format": "decimal", "nullable": true }, "street": { "type": "string", "description": "Адрес", "nullable": true }, "organization_id": { "type": "string", "description": "Id из справочника организаций", "format": "guid", "nullable": true }, "address_id": { "type": "string", "description": "Id адреса в организации", "format": "guid", "nullable": true }, "time_start": { "type": "string", "description": "Время \"От\"", "format": "date-time", "nullable": true }, "time_end": { "type": "string", "description": "Время \"До\"", "format": "date-time", "nullable": true }, "is_round_the_clock": { "type": "boolean", "description": "Круглосуточно" }, "large_cities": { "type": "array", "description": "Список Id ближайших крупных городов", "nullable": true, "items": { "type": "integer", "format": "int32" } }, "large_cities_with_distance": { "type": "array", "description": "Расстояния до ближайших крупных городов", "nullable": true, "items": { "$ref": "#/components/schemas/LargeCityWithDistance" } }, "loading_cargos": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/LoadingCargo" } }, "organization": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organization" } ] } } }, "LoadExtraPointView2": { "type": "object", "additionalProperties": false, "properties": { "route_point_id": { "type": "string", "format": "guid" }, "id": { "type": "string", "format": "guid" }, "city_id": { "type": "integer", "description": "Id города\\\nЗначение из [словаря городов АТИ](https://ati.su/developers/api/dictionaries/geo/) ", "format": "int32" }, "point_type": { "$ref": "#/components/schemas/LoadExtraPointType" }, "ordinal_id": { "type": "integer", "description": "Порядковый номер в маршруте", "format": "int32" }, "distance": { "type": "integer", "description": "Расстояние", "format": "int32" }, "street": { "type": "string", "description": "Адрес", "nullable": true }, "latitude": { "type": "number", "description": "Широта", "format": "decimal", "nullable": true }, "longitude": { "type": "number", "description": "Долгота", "format": "decimal", "nullable": true }, "organization_id": { "type": "string", "description": "Id из справочника организаций", "format": "guid", "nullable": true }, "address_id": { "type": "string", "description": "Id адреса в организации", "format": "guid", "nullable": true }, "loading_date_start": { "type": "string", "description": "Дата начала загрузки", "format": "date-time", "nullable": true }, "loading_date_end": { "type": "string", "description": "Дата конца загрузки", "format": "date-time", "nullable": true }, "loading_time_start": { "type": "string", "description": "Время начала загрузки", "format": "duration", "nullable": true }, "loading_time_end": { "type": "string", "description": "Время конца загрузки", "format": "duration", "nullable": true }, "is_round_the_clock": { "type": "boolean", "description": "Круглосуточно" }, "city_name": { "type": "string", "nullable": true }, "loading_cargos": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/LoadingCargo" } }, "unloading_cargos": { "type": "array", "nullable": true, "items": { "$ref": "#/components/schemas/UnloadingCargo" } }, "organization": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/Organization" } ] } } }, "orders__LoadCargoView": { "type": "object", "description": "Параметры груза", "additionalProperties": false, "properties": { "weight": { "type": "number", "description": "Вес", "format": "double" }, "volume": { "type": "number", "description": "Объем", "format": "double" }, "adr": { "type": "integer", "description": "Модификатор опасности груза с 0 до 9", "format": "int32" }, "cargo_type_id": { "type": "integer", "description": "Идентификатор наименования груза\nЗначение из [словаря наименований грузов](https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-cargoTypes)", "format": "int32" }, "cargo_type": { "type": "string", "description": "Строковое наименование груза. Выводится если CargoTypeId не указан, либо равен `59`", "default": "", "nullable": true }, "pack_type": { "type": "integer", "description": "Тип упаковки(навалом, коробки, россыпью, запаллечен ... пирамида). Значение из словаря PackTypes", "format": "int32" }, "pallet_count": { "type": "integer", "description": "Количество паллетов", "format": "int32" }, "belt_count": { "type": "integer", "description": "Количество ремней", "format": "int32" }, "dogruz_type": { "$ref": "#/components/schemas/DogruzType" }, "sbor_gruz": { "type": "boolean", "description": "Сборный груз" }, "size": { "description": "Размеры груза", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/orders__LoadSize" } ] } } }, "LoadTransportView2": { "type": "object", "description": "Параметры перевозки", "additionalProperties": false, "properties": { "car_type": { "type": "integer", "description": "Битовая сумма кузовов", "format": "int64" }, "car_type_string": { "type": "string", "nullable": true }, "loading_type": { "type": "integer", "description": "Битовая сумма типов загрузки", "format": "int32" }, "loading_logical_operator": { "type": "string", "description": "Тип условия загрузки\n\n* `OR`\n* `AND`", "nullable": true }, "unloading_type": { "type": "integer", "description": "Битовая сумма типов разгрузки", "format": "int32" }, "unloading_logical_operator": { "type": "string", "description": "Тип условия разгрузки\n \n* `OR`\n* `AND`", "nullable": true }, "trucks_quantity": { "type": "integer", "description": "Количество машин", "format": "int32" }, "temperature_from": { "type": "integer", "description": "Температура перевозки - нижнее значение", "format": "int32", "nullable": true }, "temperature_to": { "type": "integer", "description": "Температура перевозки - верхнее значение", "format": "int32", "nullable": true }, "truck_attribs": { "type": "integer", "description": "Настройки для машины, используются только в RMQ (Stsepka, Pnevmohod, Koniki)", "format": "int32", "nullable": true }, "stsepka": { "type": "boolean", "description": "Сцепка" }, "pnevmohod": { "type": "boolean", "description": "Пневмоход" }, "koniki": { "type": "boolean", "description": "Коники" }, "tir": { "type": "boolean", "description": "TIR" }, "cmr": { "type": "boolean", "description": "CMR" }, "t1": { "type": "boolean", "description": "Т1" }, "san_passport": { "type": "boolean", "description": "Мед книжка" }, "sanitation_logbook": { "type": "boolean", "description": "Сан. книжка" }, "is_tracking": { "type": "boolean", "description": "Запрос отслеживания через АТИ Водитель" }, "required_capacity": { "type": "number", "description": "Требуемая грузоподъёмность в тоннах", "format": "decimal", "nullable": true } } }, "BoardView": { "type": "object", "additionalProperties": false, "properties": { "board_id": { "type": "string", "description": "Id площадки" }, "name": { "type": "string", "description": "Имя площадки" }, "color": { "type": "string", "description": "Цвет площадки" } } }, "FullDealView": { "allOf": [ { "$ref": "#/components/schemas/DealView3" }, { "type": "object", "description": "Заказ\n \n*Основная информация о Заказе*", "additionalProperties": false, "properties": { "started_at": { "type": "string", "description": "Дата взятия/резервирования груза", "format": "date-time", "nullable": true }, "finished_at": { "type": "string", "description": "Дата завершения заказа", "format": "date-time", "nullable": true }, "denial_reason": { "type": "string", "description": "Причина отклонения заказа\n \n*Присутствует когда Status `-2` или `-3`*" }, "requisite_id": { "type": "string", "description": "Id реквизитов\\\nсм. taker_requisites, в новой версии API это поле перестанет существовать", "format": "guid", "deprecated": true, "nullable": true }, "taker_requisites": { "description": "Реквизиты перевозчика", "oneOf": [ { "$ref": "#/components/schemas/RequisiteView3" } ] }, "signer_id": { "type": "string", "description": "Id подписанта\\\nсм. taker_requisites, в новой версии API это поле перестанет существовать", "format": "guid", "deprecated": true, "nullable": true }, "driver": { "description": "Копия водителя\n \n*При взятии груза, водитель копируется, копию редактировать невозможно*", "oneOf": [ { "$ref": "#/components/schemas/orders__DriverView2" } ] }, "truck": { "description": "Копия транспортного средства\n \n*При взятии груза, транспортное средство копируется, копию редактировать невозможно*", "oneOf": [ { "$ref": "#/components/schemas/orders__TruckView2" } ] }, "trailer": { "description": "Копия прицепа\n \n*При взятии груза, прицеп копируется, копию редактировать невозможно*", "oneOf": [ { "$ref": "#/components/schemas/orders__TruckView2" } ] }, "semi_trailer": { "description": "Копия полуприцепа\n \n*При взятии груза, полуприцеп копируется, копию редактировать невозможно*", "oneOf": [ { "$ref": "#/components/schemas/orders__TruckView2" } ] }, "document": { "description": "Основной документ в АТИ-Доках", "oneOf": [ { "$ref": "#/components/schemas/DocumentView" } ] }, "additional_documents": { "type": "array", "description": "Дополнительные документы", "items": { "$ref": "#/components/schemas/AdditionalDocumentView" } }, "in_work_status_model": { "description": "Статусная модель перевозки\n \n* `0` — Простая перевозка\n* `1` — Первая миля\n* `2` — Последняя миля\n* `3` — Порожний контейнер", "oneOf": [ { "$ref": "#/components/schemas/InWorkStatusModel" } ] }, "in_work": { "description": "Статус перевозки заказа", "oneOf": [ { "$ref": "#/components/schemas/DealInWorkView3" } ] }, "deal_note": { "type": "string", "description": "Предлагаемые правки к документу" }, "deal_kind": { "$ref": "#/components/schemas/DealKinds" }, "points": { "type": "array", "description": "Точки маршрута", "items": { "$ref": "#/components/schemas/DealPointView3" } } } } ] }, "RequisiteView3": { "type": "object", "additionalProperties": false, "properties": { "requisite_id": { "type": "string", "description": "Id реквизитов\\\nБолее подробную информацию о реквизитах можно посмотреть [здесь](https://ati.su/developers/api/firms/#firms-requisites)", "format": "guid", "nullable": true }, "requisite_firm_name": { "type": "string", "description": "Название компании" }, "signer_id": { "type": "string", "description": "Id подписанта", "format": "guid", "nullable": true }, "own_ship_id": { "type": "integer", "description": "Идентификатор формы собственности\\\nЗначение из [словаря ОПФ АТИ](https://ati.su/developers/api/dictionaries/firms/#get-v1.0-dictionaries-ownerships/) ", "format": "int32" }, "inn": { "type": "string", "description": "ИНН" }, "kpp": { "type": "string", "description": "КПП", "nullable": true }, "requisite_type_id": { "type": "integer", "description": "Тип реквизитов", "format": "int32", "nullable": true } } }, "orders__DriverView2": { "type": "object", "additionalProperties": false, "properties": { "driver_id": { "type": "string", "description": "Id копии водителя", "format": "guid" }, "parent_id": { "type": "string", "description": "Идентификатор водителя из [Справочника Водителей](/api/catalogs/#водители)", "format": "guid", "nullable": true }, "first_name": { "type": "string", "description": "Имя водителя" }, "second_name": { "type": "string", "description": "Фамилия водителя" }, "patronymic": { "type": "string", "description": "Отчество водителя" }, "phone_number": { "type": "string", "description": "Номер телефона" }, "driver_license_number": { "type": "string", "description": "Номер водительского удостоверения" }, "driver_license_when_issued": { "type": "string", "description": "Дата выдачи водительского удостоверения", "format": "date-time", "nullable": true }, "passport_series": { "type": "string", "description": "Серия паспорта" }, "passport_number": { "type": "string", "description": "Номер паспорта" }, "passport_issued_by": { "type": "string", "description": "Кем выдан" }, "passport_when_issued": { "type": "string", "description": "Когда выдан", "format": "date-time" }, "registration": { "type": "string", "description": "Прописка" }, "is_attracted_driver": { "type": "boolean", "description": "Флаг привлеченного водителя (со стороны)" }, "last_deal_related_id": { "type": "string", "description": "Id связанной сущности по Заказу", "format": "guid", "nullable": true }, "description": { "type": "string", "description": "Краткое описание водителя" }, "attracted_from": { "type": "string", "description": "Фирма от которой привлечен водитель." }, "scans": { "type": "array", "description": "Сканы паспорта / водительского удостоверения", "items": { "$ref": "#/components/schemas/Scan" } }, "origin": { "description": "Идентификатор источника информации о водителе\n \n* `0` — Неизвестно откуда указан водитель\n* `1` — Водитель указан на странице заказов у Заказа в исполнении\n* `2` — Водитель указан в АТИ-Доках", "oneOf": [ { "$ref": "#/components/schemas/DriverOrigin" } ] }, "date_of_birth": { "type": "string", "description": "Дата рождения", "format": "date-time", "nullable": true }, "department_code_in_passport": { "type": "string", "description": "Код подразделения" }, "driver_inn": { "type": "string", "description": "ИНН водителя" }, "in_cargo_owner_black_list": { "type": "boolean", "description": "Есть в Черном списке" }, "external_id": { "type": "string", "description": "Внешний идентификатор" }, "black_list_reasons": { "type": "array", "description": "Причины добавления в Черный список", "items": { "type": "string" } } } }, "orders__TruckView2": { "type": "object", "description": "Транспортное средство", "additionalProperties": false, "properties": { "truck_id": { "type": "string", "description": "Id копии транспортного средства", "format": "guid" }, "parent_id": { "type": "string", "description": "Id транспортного средства из [Автопарка](/api/catalogs/#автопарк)", "format": "guid", "nullable": true }, "last_deal_related_id": { "type": "string", "description": "Id ТС, с которым было связано ТС во время выполнения последнего Заказа", "format": "guid", "nullable": true }, "type": { "description": "Тип транспортного средства\n \n* `1` — Грузовик\n* `2` — Тягач\n* `4` — Полуприцеп\n* `8` — Прицеп", "oneOf": [ { "$ref": "#/components/schemas/TruckKinds" } ] }, "description": { "type": "string", "description": "Описание транспортного средства" }, "brand_id": { "type": "integer", "description": "Марка", "format": "int32", "nullable": true }, "model": { "type": "string", "description": "Модель" }, "number": { "type": "string", "description": "Номер" }, "phone_number": { "type": "string", "description": "Телефон" }, "is_attracted_truck": { "type": "boolean", "description": "Привлеченное ТС" }, "ownership_type": { "description": "Тип владения ТС\n \n* `0` - Собственное\n* `1` - Привлеченное\n* `2` - Аренда\n* `3` - Лизинг\n* `4` - Совместная собственность (супругов)\n* `5` - Безвозмездное пользование", "oneOf": [ { "$ref": "#/components/schemas/orders__TruckOwnershipType" } ] }, "car_type_id": { "type": "integer", "description": "Тип Кузова", "format": "int32" }, "capacity": { "type": "number", "description": "Грузоподъемность", "format": "decimal", "nullable": true }, "volume": { "type": "number", "description": "Объем", "format": "decimal", "nullable": true }, "length": { "type": "number", "description": "Длина", "format": "decimal", "nullable": true }, "width": { "type": "number", "description": "Ширина", "format": "decimal", "nullable": true }, "height": { "type": "number", "description": "Высота", "format": "decimal", "nullable": true }, "manufacture_year": { "type": "integer", "description": "Год выпуска", "format": "int32", "nullable": true }, "vin": { "type": "string", "description": "VIN" }, "vrc": { "type": "string", "description": "СТС" }, "body_number": { "type": "string", "description": "Номер кузова" }, "dimension": { "type": "integer", "description": "Размерность контейнера", "format": "int32", "nullable": true }, "truck_passport_number": { "type": "string", "description": "Номер ПТС" }, "can_refrigerator": { "type": "boolean", "description": "Способность возить реф-контейнеры", "nullable": true }, "has_gen_set": { "type": "boolean", "description": "Есть GenSet", "nullable": true }, "truck_owner_name": { "type": "string", "description": "Имя владельца по СТС" }, "can_carry_heavy_container": { "type": "boolean", "description": "Способность перевозить тяжелые контейнеры\n ", "nullable": true }, "can_carry_tall_container": { "type": "boolean", "description": "Способность перевозить высокие контейнеры", "nullable": true }, "external_id": { "type": "string", "description": "Внешний идентификатор" }, "verified": { "type": "boolean", "description": "Проверено" }, "modification_restricted": { "type": "boolean", "description": "Запрещено редактирование и удаление ТС." }, "scans": { "type": "array", "description": "Сканы ПТС", "items": { "$ref": "#/components/schemas/Scan" } }, "origin": { "description": "Источник создания Транспорта\n \n* `0` — Неизвестно откуда указано ТС\n* `1` — ТС указано на странице заказов у Заказа в исполнении\n* `2` — ТС Указано в АТИ-доках", "oneOf": [ { "$ref": "#/components/schemas/TruckOrigin" } ] } } }, "DocumentView": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "ID документа" }, "old_id": { "type": "string", "description": "ID старого документа" }, "editor": { "type": "string", "description": "Фирма, отредактировавшая документ" }, "url": { "type": "string", "description": "Адрес просмотра договора" }, "old_url": { "type": "string", "description": "Адрес просмотра старого договора" }, "name": { "type": "string", "description": "Имя документа" }, "is_signed": { "type": "boolean", "description": "Документ подписан перевозчиком" }, "access": { "description": "Доступ к документу\n \n* `0` — Обе стороны\n* `1` — Водитель", "oneOf": [ { "$ref": "#/components/schemas/DealDocumentAccess" } ] } } }, "AdditionalDocumentView": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "Id документа" }, "is_counterparty_file": { "type": "boolean", "description": "Файл контрагента" }, "url": { "type": "string", "description": "Адрес документа" }, "name": { "type": "string", "description": "Имя документа" }, "is_signed": { "type": "boolean", "description": "Документ подписан перевозчиком" }, "document_type": { "description": "Тип документа\n \n* `0` — Нет\n* `1` — Заказ\n* `2` — Договор-заявка\n* `3` — Поручение экспедитору\n* `4` — Акт\n* `5` — Счет\n* `6` — Одностороннее расторжение\n* `7` — Доверенность\n* `8` — Табличный заказ\n* `9` — Заявка к договору (табличный вид)", "oneOf": [ { "$ref": "#/components/schemas/DocumentType" } ] }, "access": { "description": "Доступ к документу\n \n* `0` — Обе стороны\n* `1` — Водитель", "oneOf": [ { "$ref": "#/components/schemas/DealDocumentAccess" } ] } } }, "DealInWorkView3": { "type": "object", "additionalProperties": false, "properties": { "deal_id": { "type": "string", "description": "Id Заказа", "format": "guid" }, "in_work_status": { "description": "Статус перевозки\n \n* `0` — Нет статуса\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* `13` — Погрузка контейнера окончена\n* `14` — Контейнер сдан с погрузки\n* `15` — Контейнер получен на выгрузку\n* `16` — Контейнер на выгрузке\n* `17` — Выгрузка контейнера окончена\n* `18` — Контейнер сдан с выгрузки\n* `19` — Пустой контейнер получен\n* `20` — Пустой контейнер сдан", "oneOf": [ { "$ref": "#/components/schemas/InWorkStatus" } ] }, "in_work_date": { "type": "string", "description": "Дата выставления статуса", "format": "date-time", "nullable": true }, "ati_id": { "type": "string", "description": "Фирма, выставившая статус (перевозчик или грузовладелец)", "nullable": true }, "contact_id": { "type": "integer", "description": "Контакт, выставивший статус", "format": "int32", "nullable": true }, "tracker_phone": { "type": "number", "description": "Номер телефона трекера, откуда получен статус", "format": "decimal", "nullable": true } } }, "DealPointView3": { "type": "object", "description": "Точка маршрута заказа", "additionalProperties": false, "properties": { "deal_point_id": { "type": "string", "description": "Id точки заказа", "format": "guid" }, "ordinal_id": { "type": "integer", "description": "Порядковый номер", "format": "int32" }, "point_type": { "description": "Тип точки маршрута\n \n* `1` — Загрузка\n* `2` — Разгрузка", "oneOf": [ { "$ref": "#/components/schemas/DealPointTypes" } ] }, "city_id": { "type": "integer", "description": "Id города\\\nЗначение из [словаря городов АТИ](https://ati.su/developers/api/dictionaries/geo/) ", "format": "int32" }, "lat": { "type": "number", "description": "Широта", "format": "double", "nullable": true }, "lon": { "type": "number", "description": "Долгота", "format": "double", "nullable": true }, "address": { "type": "string", "description": "Адрес", "nullable": true }, "participant_name": { "type": "string", "description": "Название организации", "nullable": true }, "region_id": { "type": "integer", "description": "Id региона\nЗначение из [словаря регионов АТИ](https://ati.su/developers/api/dictionaries/geo/) ", "format": "int32" }, "contact_name": { "type": "string", "nullable": true }, "organization_id": { "type": "string", "format": "guid", "nullable": true }, "stock_id": { "type": "string", "format": "guid", "nullable": true }, "stock": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/PointStockDocView2" } ] }, "organization": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/orders__OrganizationView2" } ] } } }, "PointStockDocView2": { "type": "object", "additionalProperties": false, "properties": { "stock_id": { "type": "string", "format": "guid" }, "address": { "type": "string", "nullable": true }, "address_city_id": { "type": "integer", "format": "int32", "nullable": true }, "note": { "type": "string", "nullable": true }, "contact_persons": { "type": "array", "items": { "$ref": "#/components/schemas/orders__ContactPersonView" } }, "schedule_summary": { "type": "string", "nullable": true }, "stock_type": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/StockType" } ] }, "timeslots_warehouse_id": { "type": "integer", "format": "int32", "nullable": true } } }, "orders__OrganizationView2": { "type": "object", "additionalProperties": false, "properties": { "organization_id": { "type": "string", "format": "guid" }, "name": { "type": "string" }, "phone": { "type": "string" }, "contact_persons": { "type": "array", "items": { "$ref": "#/components/schemas/orders__ContactPersonView" } } } }, "DealView3": { "type": "object", "description": "Заказ\n \n*Основная информация о Заказе*", "additionalProperties": false, "properties": { "deal_id": { "type": "string", "description": "Id Заказа", "format": "guid" }, "load_copy_id": { "type": "string", "description": "Id связанной копии груза", "format": "guid" }, "load_id": { "type": "string", "description": "Id груза", "format": "guid" }, "taker_ati_id": { "type": "string", "description": "Код фирмы, взявшей груз" }, "taker_persistent_user_id": { "type": "integer", "description": "Идентификатор пользователя, взявшего груз", "format": "int32" }, "taker_contact_id": { "type": "integer", "description": "Id контакта, взявшего груз", "format": "int32" }, "cargo_owner_ati_id": { "type": "string", "description": "Код фирмы опубликовавшей груз" }, "cargo_owner_persistent_user_id": { "type": "integer", "description": "Идентификатор пользователя, опубликовавшего груз", "format": "int32" }, "updated_at": { "type": "string", "description": "Время изменения информации по Заказу", "format": "date-time" }, "end_of_reservation": { "type": "string", "description": "Время до которого груз зарезервирован", "format": "date-time", "nullable": true }, "auction_id": { "type": "string", "description": "Id Торгов (аукциона)", "format": "guid", "nullable": true }, "status": { "description": "Статус Заказа\n\n* `0` — Груз зарезервирован перевозчиком\n* `1` — Перевозчик заполнил информацию о реквизитах/водителе/машине и грузовладелец не просмотрел заявку\n* `2` — Перевозчик заполнил информацию о реквизитах/водителе/машине и грузовладелец просмотрел заявку\n* `3` — Грузовладелец отправил документ-заявку перевозчику\n* `4` — Заказ в исполнении (перевозчик дал согласие на документ-заявку)\n* `5` — Заказ завершен и перенесен в архив\n* `7` — Есть только приглашение на Заказ\n* `8` — Заказа нет, но есть Торги, у которых есть возможные победители\n* `9` — Заказ отклонен автоматически, так как после последней даты загрузки прошло уже более 7 дней\n* `10` — Заказ завершен, ожидается оплата\n* `11` — В Торгах лучшая ставка из других Торгов\n* `-11` — Заказ удален\n* `-10` — Резерв груза перевозчиком отменен\n* `-9` — Заказ отклонен грузовладельцем в Торгах после истечения срока подачи документов (смена победителя)\n* `-8` — Грузовладелец отменил Заказ в исполнении\n* `-7` — Перевозчик отменил Заказ в исполнении\n* `-6` — Заказ отклонен грузовладельцем после удаления Торгов\n* `-4` — Заказ отклонен грузовладельцем в Торгах (смена победителя)\n* `-3` — Заказ отклонен грузовладельцем\n* `-2` — Заказ отозван перевозчиком", "oneOf": [ { "$ref": "#/components/schemas/DealState" } ] }, "counterparty_status": { "description": "Статус Заказа у контрагента\n\n* `0` — Груз зарезервирован перевозчиком\n* `1` — Перевозчик заполнил информацию о реквизитах/водителе/машине и грузовладелец не просмотрел заявку\n* `2` — Перевозчик заполнил информацию о реквизитах/водителе/машине и грузовладелец просмотрел заявку\n* `3` — Грузовладелец отправил документ-заявку перевозчику\n* `4` — Заказ в исполнении (перевозчик дал согласие на документ-заявку)\n* `5` — Заказ завершен и перенесен в архив\n* `7` — Есть только приглашение на Заказ\n* `8` — Заказа нет, но есть Торги, у которых есть возможные победители\n* `9` — Заказ отклонен автоматически, так как после последней даты загрузки прошло уже более 7 дней\n* `10` — Заказ завершен, ожидается оплата\n* `11` — В Торгах лучшая ставка из других Торгов\n* `-11` — Заказ удален\n* `-10` — Резерв груза перевозчиком отменен\n* `-9` — Заказ отклонен грузовладельцем в Торгах после истечения срока подачи документов (смена победителя)\n* `-8` — Грузовладелец отменил Заказ в исполнении\n* `-7` — Перевозчик отменил Заказ в исполнении\n* `-6` — Заказ отклонен грузовладельцем после удаления Торгов\n* `-4` — Заказ отклонен грузовладельцем в Торгах (смена победителя)\n* `-3` — Заказ отклонен грузовладельцем\n* `-2` — Заказ отозван перевозчиком", "oneOf": [ { "$ref": "#/components/schemas/DealState" } ] }, "payment": { "description": "Параметры оплаты Заказа", "oneOf": [ { "$ref": "#/components/schemas/DealPaymentView3" } ] }, "pay_docs": { "description": "Информация об оплате заказа", "oneOf": [ { "$ref": "#/components/schemas/PayDocsView2" } ] }, "files": { "type": "array", "description": "Файлы Заказа", "items": { "$ref": "#/components/schemas/DealFileView2" } }, "document_templates": { "type": "array", "description": "Информация о шаблонах документов в заказах", "items": { "$ref": "#/components/schemas/DealDocumentTemplatesView" } }, "customer": { "description": "Информация о заказчике", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CustomerView" } ] }, "is_tracking": { "type": "boolean", "description": "Запрос отслеживания через АТИ Водитель" }, "should_show_rate_to_driver": { "type": "boolean", "description": "Показывать ли ставку водителю (для ОЗ)", "nullable": true } } }, "DealPaymentView3": { "type": "object", "additionalProperties": false, "properties": { "rates": { "type": "array", "description": "Список возможных ставок перевозки", "items": { "$ref": "#/components/schemas/RateView" } }, "prepay_percent": { "type": "integer", "description": "Процент предоплаты", "format": "int32" }, "prepay_percent_enabled": { "type": "boolean", "description": "Есть ли предоплата" }, "on_unloading": { "type": "boolean", "description": "Оплата на выгрузке" }, "in_fuel": { "type": "boolean", "description": "Оплата топливом" }, "pay_days_enabled": { "type": "boolean", "description": "Есть ли срок оплаты" }, "pay_days": { "type": "integer", "description": "Срок оплаты", "format": "int32" }, "fixed_rate": { "type": "boolean", "description": "Указана ли в грузе ставка" }, "torg": { "type": "boolean", "description": "Возможен ли торг" }, "direct_contract": { "type": "boolean", "description": "Прямой договор" }, "money_type": { "type": "integer", "description": "Способ оплаты", "format": "int32", "nullable": true } } }, "PayDocsView2": { "type": "object", "additionalProperties": false, "properties": { "documents_copies": { "description": "Информация о копиях документов", "oneOf": [ { "$ref": "#/components/schemas/DocumentStatusInfoView" } ] }, "documents_original": { "description": "Информация о оригиналах документов", "oneOf": [ { "$ref": "#/components/schemas/DocumentStatusInfoView" } ] }, "documents_original_track": { "description": "Информация об отслеживании оригиналов документов", "oneOf": [ { "$ref": "#/components/schemas/DocumentTrackingInfoView" } ] }, "payment": { "description": "Информация об оплате", "oneOf": [ { "$ref": "#/components/schemas/PaymentStatusView" } ] } } }, "DealFileView2": { "type": "object", "description": "Файлы заказа", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "Id файла", "format": "guid", "nullable": true }, "storage_file_id": { "type": "string", "description": "Id файла в хранилище", "nullable": true }, "access": { "description": "Доступ к файлу\n \n* `0` — только загрузивший файл\n* `1` — обе стороны\n* `2` — загрузивший файл и водитель\n* `3` — доступен обеим сторонам и водителю", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DealFileAccess" } ] }, "add_date": { "type": "string", "description": "Время загрузки файла", "format": "date-time", "nullable": true }, "deal_id": { "type": "string", "description": "Id связанного Заказа", "format": "guid" }, "is_counterparty_file": { "type": "boolean", "description": "Файл контрагента" }, "file_name": { "type": "string", "description": "Имя файла", "nullable": true }, "size": { "type": "integer", "description": "Размер файла", "format": "int32" }, "link": { "type": "string", "description": "Ссылка на файл", "nullable": true }, "file_id": { "type": "string", "description": "ID файла", "nullable": true }, "source_type": { "description": "Источник файла\n \n* `0` — Загружен в заказ\n* `1` — Скопирован из груза\n* `2` — Скопирован из данных о водителе\n* `3` — Скопироване из данных о грузовике\n* `4` — Скопирован из данных о прицепе\n* `5` — Скопирован из данных о полуприцепе\n* `6` — Скопирован из данных о тягаче\n* `7` — Загружен для Ати-водителя", "oneOf": [ { "$ref": "#/components/schemas/DealFileSourceTypes" } ] }, "source_file_type": { "description": "Тип загруженного файла\n \n* `0` — Обычный файл\n* `1` — Водительское удостоверение\n* `2` — Паспорт водителя\n* `3` — Техпаспорт ТС\n* `4` — Пластик\n* `5` — Фото ТС", "oneOf": [ { "$ref": "#/components/schemas/DealFileSourceFileTypes" } ] }, "file_type": { "description": "Тип файла\n \n* `0` — Другой документ\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* `13` — Доп. соглашение (к договору)\n* `14` — Доверенность\n* `15` — Поручение экспедитору\n* `16` — Информационное письмо\n* `17` — Документ о происшествии с грузом/ТС", "oneOf": [ { "$ref": "#/components/schemas/DealFileType" } ] }, "timeslots_warehouse_ids": { "type": "array", "description": "Список складов с Временными окнами с доступом к файлу", "nullable": true, "items": { "type": "integer", "format": "int32" } } } }, "DealDocumentTemplatesView": { "type": "object", "additionalProperties": false, "properties": { "organization_address": { "type": "string", "description": "Адрес организации" }, "templates": { "type": "array", "description": "Шаблоны документов", "items": { "$ref": "#/components/schemas/DocumentTemplateView2" } } } }, "DocumentTemplateView2": { "type": "object", "additionalProperties": false, "properties": { "add_date": { "type": "string", "description": "Время загрузки документа", "format": "date-time", "nullable": true }, "access": { "description": "Доступ к документу\n \n* `0` — только загрузивший документ\n* `1` — обе стороны", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DealDocumentTemplateAccess" } ] }, "timeslots_warehouse_ids": { "type": "array", "description": "Список складов с Временными окнами с доступом к документу", "nullable": true, "items": { "type": "integer", "format": "int32" } }, "deal_id": { "type": "string", "description": "Id связанного Заказа", "format": "guid", "nullable": true }, "deal_point_id": { "type": "string", "description": "Id точки в заказе, к которой привязан документ", "format": "guid", "nullable": true }, "owner_firm_id": { "type": "integer", "description": "Id фирмы, загрузившей документ", "format": "int32", "nullable": true }, "cargoes_ids_hash": { "type": "integer", "description": "Поле-хэш, рассчитывается на основе id грузов, выгружаемых в точке DealPointId. Если выгружаемые грузы не указаны - будет равно 0", "format": "int32", "nullable": true }, "contact_id": { "type": "integer", "description": "Id контакта", "format": "int32", "nullable": true }, "file_name": { "type": "string", "description": "Название документа", "nullable": true }, "file_id": { "type": "string", "description": "Id файла документа", "nullable": true }, "id": { "type": "string", "description": "Id документа", "format": "guid", "nullable": true }, "size": { "type": "integer", "description": "Размер документа", "format": "int32", "nullable": true }, "link": { "type": "string", "description": "Ссылка на документ (только для сайта)" } } }, "SaveUnilateralOrderDtoNew": { "type": "object", "additionalProperties": false, "properties": { "points": { "type": "array", "description": "Точки маршрута, включая загрузку и разгрузку", "nullable": true, "items": { "$ref": "#/components/schemas/UnilateralOrderPointDtoInboxNew" } }, "driver_id": { "type": "string", "description": "Идентификатор водителя", "format": "guid", "nullable": true }, "truck_id": { "type": "string", "description": "Идентификатор транспорта", "format": "guid", "nullable": true }, "trailer_id": { "type": "string", "description": "Идентификатор прицепа", "format": "guid", "nullable": true }, "semitrailer_id": { "type": "string", "description": "Идентификатор полуприцепа", "format": "guid", "nullable": true }, "deal_id": { "type": "string", "description": "Идентификатор Заказа\n\nУказывается, когда необходимо изменить заказ", "format": "guid", "nullable": true }, "rate": { "type": "number", "description": "Ставка\n\nЕсли ставка указана, то должны быть заполнены поля `currency`, `money_type` и `rate_type`", "format": "decimal", "nullable": true, "example": 1000 }, "currency": { "type": "integer", "description": "Идентификатор валюты ставки\n \nПоле является обязательным, если указана ставка (`rate`)\n\nЗначение из [словаря валют АТИ](https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes)", "format": "int32", "nullable": true, "example": 1 }, "rate_type": { "description": "Типы оплаты\n \nПоле является обязательным, если указана ставка (`rate`)\n\n* `0` — Нет\n* `1` — Любая\n* `2` — С НДС\n* `3` — Без НДС", "nullable": true, "example": 1, "oneOf": [ { "$ref": "#/components/schemas/RateType" } ] }, "money_type": { "type": "integer", "description": "Ставка (любая, на карту, нал)\n \n* `1` — Нал\n* `22` — Любая\n* `23` — На карту\n* `24` — Нал без НДС\n* `25` — Безнал без НДС", "format": "int32", "nullable": true, "example": 1 }, "order_number": { "type": "string", "description": "Номер заказа или груза", "nullable": true }, "should_show_rate_to_driver": { "type": "boolean", "description": "Показывать ли ставку водителю" }, "adr": { "type": "integer", "description": "Параметр, определяющий степень опасности груза\n \nВозможны значения с 1 до 9", "format": "int32", "nullable": true, "example": 0 }, "loading_type": { "type": "integer", "description": "Битовая сумма Id типов загрузки ", "format": "int32", "nullable": true, "example": 0 }, "unloading_type": { "type": "integer", "description": "Битовая сумма Id типов разгрузки ", "format": "int32", "nullable": true, "example": 0 }, "belt_count": { "type": "integer", "description": "Кол-во ремней", "format": "int32", "nullable": true, "example": 0 }, "file_ids": { "type": "array", "description": "Список ID файлов", "nullable": true, "items": { "type": "string" } } } }, "UnilateralOrderPointDtoInboxNew": { "type": "object", "additionalProperties": false, "required": [ "city_id", "time", "lat", "lon" ], "properties": { "ordinal_id": { "type": "integer", "description": "Порядковый номер точки, начиная с 0", "format": "int32", "example": 0 }, "country_id": { "type": "integer", "description": "Id страны\\\nЗначение из [словаря стран АТИ](https://ati.su/developers/api/dictionaries/geo/) ", "format": "int32", "example": 1 }, "region_id": { "type": "integer", "description": "Id региона\\\nЗначение из [словаря регионов АТИ](https://ati.su/developers/api/dictionaries/geo/) ", "format": "int32", "nullable": true, "example": 21 }, "city_id": { "type": "integer", "description": "Id города\\\nЗначение из [словаря городов АТИ](https://ati.su/developers/api/dictionaries/geo/) ", "format": "int32", "example": 60 }, "time": { "type": "string", "description": "Время прибытия (при наличии значения time_to, time означает начало периода времени прибытия)", "minLength": 1, "example": "10:00" }, "time_to": { "type": "string", "description": "Время до (если есть)", "nullable": true, "example": "01:00" }, "date": { "type": "string", "description": "Дата прибытия (при наличии значения date_to, date означает начало периода дат прибытия) ", "nullable": true, "example": "02.05.2029" }, "date_to": { "type": "string", "description": "Дата до (если есть)", "nullable": true, "example": "13.05.2029" }, "lat": { "type": "number", "description": "Широта точки", "format": "double", "example": 56.8256736 }, "lon": { "type": "number", "description": "Долгота точки", "format": "double", "example": 60.5484352 }, "address": { "type": "string", "description": "Адрес", "example": "ул. Ленина" }, "contact_persons": { "type": "array", "description": "Список контактов (не более 10 контактов)", "nullable": true, "items": { "$ref": "#/components/schemas/ContactPerson2" } }, "note": { "type": "string", "description": "Примечание (до 160 символов)", "nullable": true }, "point_type": { "description": "Тип точки\n* `1` — Загрузка\n* `2` — Разгрузка\n* `3` — Таможня\n* `8` — Ехать через", "example": 1, "oneOf": [ { "$ref": "#/components/schemas/UnilateralLoadPointType" } ] }, "is_round_the_clock": { "type": "boolean", "description": "Круглосуточная загрузка", "example": false }, "cargos": { "type": "array", "description": "Груз", "nullable": true, "items": { "$ref": "#/components/schemas/CargoDto" } } } }, "UnilateralLoadPointType": { "type": "integer", "description": "Тип дополнительной точки маршрута груза\n \n* `1` — Загрузка\n* `2` — Разгрузка\n* `3` — Таможня\n* `8` — Ехать через", "x-enumNames": [ "LoadingExtraPoint", "UnloadingExtraPoint", "CustomExtraPoint", "GoThrough" ], "enum": [ 1, 2, 3, 8 ] }, "CargoDto": { "type": "object", "additionalProperties": false, "properties": { "cargo_id": { "type": "integer", "description": "Id груза", "format": "int32", "example": 0 }, "name_id": { "type": "integer", "description": "ID наименования груза", "format": "int32", "nullable": true, "example": 59 }, "name": { "type": "string", "description": "Наименование груза", "nullable": true }, "packaging_type": { "type": "integer", "description": "Упаковка", "format": "int32", "nullable": true, "example": 0 }, "packaging_quantity": { "type": "integer", "description": "Кол-во упаковок", "format": "int32", "nullable": true, "example": 10 }, "weight": { "description": "Вес", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/CargoWeight" } ] }, "volume": { "type": "number", "description": "Объем", "format": "double", "nullable": true, "example": 10 }, "sizes": { "description": "Габариты", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/LoadSizeDto" } ] } } }, "CargoWeight": { "type": "object", "additionalProperties": false, "properties": { "quantity": { "type": "number", "description": "Вес", "format": "double", "nullable": true, "example": 10 }, "type": { "description": "Тип веса груза\n \n* `0` — Килограммы\n* `1` — Тонны", "nullable": true, "example": 0, "oneOf": [ { "$ref": "#/components/schemas/WeightType" } ] } } }, "LoadSizeDto": { "type": "object", "additionalProperties": false, "properties": { "length": { "type": "number", "description": "Длина в метрах", "format": "double", "nullable": true, "example": 0 }, "width": { "type": "number", "description": "Ширина в метрах", "format": "double", "nullable": true, "example": 0 }, "height": { "type": "number", "description": "Высота в метрах", "format": "double", "nullable": true, "example": 0 }, "diameter": { "type": "number", "description": "Диаметр в метрах", "format": "double", "nullable": true, "example": 0 } } }, "DocumentMinView": { "type": "object", "additionalProperties": false, "properties": { "document_id": { "type": "string", "description": "ID документа" }, "url": { "type": "string", "description": "Адрес просмотра договора" } } }, "DealMapView": { "type": "object", "additionalProperties": false, "properties": { "goals": { "type": "array", "description": "Точки загрузки/разгрузки", "items": { "$ref": "#/components/schemas/GoalView" } }, "traces": { "type": "array", "description": "Точки траектории движения водителя", "items": { "$ref": "#/components/schemas/TraceView" } } } }, "GoalView": { "type": "object", "additionalProperties": false, "properties": { "longitude": { "type": "number", "description": "Долгота", "format": "double" }, "latitude": { "type": "number", "description": "Широта", "format": "double" }, "events": { "type": "array", "description": "События", "items": { "$ref": "#/components/schemas/EventView" } }, "ordinal_id": { "type": "integer", "description": "Номер по порядку", "format": "int32" }, "trace": { "type": "boolean", "description": "Нужно ли прокладывать маршрут для этой точки" } } }, "EventView": { "type": "object", "additionalProperties": false, "properties": { "type": { "description": "Тип события\n\n* `0` — Значение по умолчанию\n* `1` — Метаинформация об устройстве. Включает в себя события выключения GPS, подмены GPS координат, выключения телефона.\n* `2` — Информация о статусе заказа (статусы выбираются водителем в приложении)", "oneOf": [ { "$ref": "#/components/schemas/TrackerEventType" } ] }, "tag": { "type": "string", "description": "Тэг произошедшего события" }, "date": { "type": "string", "description": "Дата начала", "format": "date-time" }, "date_to": { "type": "string", "description": "Дата окончания", "format": "date-time", "nullable": true }, "time": { "type": "string", "description": "Время начала" }, "time_to": { "type": "string", "description": "Время окончания" }, "location_name": { "description": "Информация о местоположении", "oneOf": [ { "$ref": "#/components/schemas/LocationNameView" } ] } } }, "TrackerEventType": { "type": "integer", "description": "", "x-enumNames": [ "NotSet", "Meta", "Status" ], "enum": [ 0, 1, 2 ] }, "LocationNameView": { "type": "object", "additionalProperties": false, "properties": { "country": { "type": "string", "description": "Страна" }, "region": { "type": "string", "description": "Регион" }, "city": { "type": "string", "description": "Город" }, "address": { "type": "string", "description": "Адрес" } } }, "TraceView": { "type": "object", "additionalProperties": false, "properties": { "car": { "description": "Транспортное средство", "oneOf": [ { "$ref": "#/components/schemas/CarView" } ] }, "first_action": { "type": "string", "description": "Время начала действия", "format": "date-time" }, "last_action": { "type": "string", "description": "Время окончания действия", "format": "date-time" }, "points": { "type": "array", "description": "Точки маршрута", "items": { "$ref": "#/components/schemas/PointView" } } } }, "CarView": { "type": "object", "additionalProperties": false, "properties": { "driver_phone": { "type": "string", "description": "Номер телефона водителя" }, "car_status": { "description": "Тип события\n \n* `0` — Без происшествий\n* `1` — GPS был выключен\n* `2` — Попытка подделки GPS\n* `3` — Не было данных\n* `4` — Режим энергосбережения\n* `5` — Стоянка", "oneOf": [ { "$ref": "#/components/schemas/MapCarType" } ] } } }, "PointView": { "type": "object", "additionalProperties": false, "properties": { "longitude": { "type": "number", "description": "Долгота", "format": "double" }, "latitude": { "type": "number", "description": "Широта", "format": "double" }, "events": { "type": "array", "description": "События", "items": { "$ref": "#/components/schemas/EventView" } }, "location_date": { "type": "string", "description": "Время местоположения", "format": "date-time" }, "is_fake": { "type": "boolean", "description": "Флаг поддельного сигнала GPS" }, "is_disabled": { "type": "boolean", "description": "Фдаг выключенности GPS" }, "is_no_data": { "type": "boolean", "description": "Флаг наличия данных" }, "is_power_saving": { "type": "boolean", "description": "Флаг включенности режима энергосбережения" }, "is_empty_run": { "type": "boolean", "description": "Флаг холостого хода" }, "is_parking": { "type": "boolean", "description": "Стоянка" } } }, "MapHistoryView": { "type": "object", "additionalProperties": false, "properties": { "events": { "type": "array", "description": "События в пути", "items": { "$ref": "#/components/schemas/UserDealsHistoryView" } } } }, "UserDealsHistoryView": { "type": "object", "additionalProperties": false, "properties": { "date": { "type": "string", "description": "Время события", "format": "date-time" }, "event": { "description": "Событие", "oneOf": [ { "$ref": "#/components/schemas/EventView" } ] }, "longitude": { "type": "number", "description": "Долгота", "format": "double" }, "latitude": { "type": "number", "description": "Широта", "format": "double" }, "params": { "type": "array", "items": { "type": "string" } } } }, "DealFileInfoDto3": { "type": "object", "additionalProperties": false, "properties": { "deal_id": { "type": "string", "description": "ID заказа", "format": "guid" }, "file_info": { "description": "Данные о загруженном файле", "oneOf": [ { "$ref": "#/components/schemas/FileInfoDto3" } ] }, "file_type": { "description": "Тип файла", "oneOf": [ { "$ref": "#/components/schemas/DealFileType" } ] } } }, "FileInfoDto3": { "type": "object", "additionalProperties": false, "properties": { "file_id": { "type": "string", "description": "Id файла" }, "file_name": { "type": "string", "description": "Название файла" } } }, "OrderViewOfFullDealView": { "type": "object", "additionalProperties": false, "properties": { "load_copy": { "description": "Копия груза\n\n*При создании заказа груз копируется, копия не отображается в поиске и её невозможно отредактировать*", "oneOf": [ { "$ref": "#/components/schemas/LoadCopyView" } ] }, "deal": { "description": "Заказ\n \n*Основная информация о заказе*", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FullDealView" } ] } } }, "OrderFilter2": { "type": "object", "description": "Фильтр по заказам", "additionalProperties": false, "properties": { "role": { "description": "Роль пользователя, по умолчанию: Грузовладелец\n\n* `0` — Грузовладелец\n* `1` — Перевозчик", "oneOf": [ { "$ref": "#/components/schemas/OrderRole" } ] }, "statuses": { "type": "array", "description": "Список статусов для фильтрации заказов. Если передать null или пустой список, то вернутся все заказы пользователя\n\n* `0` — Груз зарезервирован перевозчиком\n* `1` — Перевозчик заполнил информацию о реквизитах/водителе/машине и грузовладелец не просмотрел заявку\n* `2` — Перевозчик заполнил информацию о реквизитах/водителе/машине и грузовладелец просмотрел заявку\n* `3` — Грузовладелец отправил документ-заявку перевозчику\n* `4` — Заказ в исполнении (перевозчик дал согласие на документ-заявку)\n* `5` — Заказ завершен и перенесен в архив\n* `7` — Есть только приглашение на Заказ\n* `8` — Заказа нет, но есть Торги, у которых есть возможные победители\n* `9` — Заказ отклонен автоматически, так как после последней даты загрузки прошло уже более 7 дней\n* `10` — Заказ завершен, ожидается оплата\n* `11` — В Торгах лучшая ставка из других Торгов\n* `-11` — Заказ удален\n* `-10` — Резерв груза перевозчиком отменен\n* `-9` — Заказ отклонен грузовладельцем в Торгах после истечения срока подачи документов (смена победителя)\n* `-8` — Грузовладелец отменил Заказ в исполнении\n* `-7` — Перевозчик отменил Заказ в исполнении\n* `-6` — Заказ отклонен грузовладельцем после удаления Торгов\n* `-4` — Заказ отклонен грузовладельцем в Торгах (смена победителя)\n* `-3` — Заказ отклонен грузовладельцем\n* `-2` — Заказ отозван перевозчиком", "items": { "$ref": "#/components/schemas/DealState" } }, "load_ids": { "type": "array", "description": "Список id грузов", "items": { "type": "string", "format": "guid" } } } }, "DealStatusView": { "type": "object", "description": "Информация о статусе заказа", "additionalProperties": false, "properties": { "deal_id": { "type": "string", "description": "Id заказа", "format": "guid" }, "status": { "$ref": "#/components/schemas/DealState" }, "deal_kind": { "$ref": "#/components/schemas/DealKinds" }, "inwork_status": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/InWorkStatus" } ] }, "tracker_offer_status": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/TrackerOfferStatus" } ] }, "status_change_date_time": { "type": "string", "description": "Время изменения статуса", "format": "date-time" } } }, "OrderToWorkDtoInbox": { "type": "object", "additionalProperties": false, "properties": { "in_work_status_model": { "description": "Статусная модель перевозки\n \n* `0` — Простая перевозка\n* `1` — Первая миля\n* `2` — Последняя миля\n* `3` — Порожний контейнер", "oneOf": [ { "$ref": "#/components/schemas/InWorkStatusModel" } ] } } }, "DocumentInfoShortView": { "type": "object", "description": "Параметры ссылки для открытия Заказа в АТИ-Доках ", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "Id документа" }, "url": { "type": "string", "description": "Url документа" }, "is_signed": { "type": "boolean", "description": "Подписан ли документ" } } }, "DealAcceptFromLoadIntegratorsDtoInbox": { "type": "object", "description": "Данные грузовладельца для Заказа", "additionalProperties": false, "properties": { "template_id": { "type": "string", "description": "Id шаблона документа а АТИ Доках", "nullable": true }, "document_type": { "type": "string", "description": "Тип документа (\"заказ\", \"заказ (табличный вид)\", \"заявка (к договору)\", \"поручение экспедитору\", \"Заявка к договору (табличный вид)\")", "nullable": true }, "requisite_id": { "type": "string", "description": "Id реквизитов", "format": "guid", "nullable": true }, "signer_id": { "type": "string", "description": "Id подписанта", "format": "guid", "nullable": true }, "contract_number": { "type": "string", "description": "Номер договора произвольного формата не длинее 50 символов. Обязателен, если тип документа -- заявка или поручение экспедитору.", "nullable": true }, "contract_start_date": { "type": "string", "description": "Дата начала договора. Обязателен, если тип документа -- заявка или поручение экспедитору.", "format": "date-time", "nullable": true }, "point_ids": { "type": "array", "description": "Список адресов загрузки/разгрузки с организациями для Заказа", "nullable": true, "items": { "$ref": "#/components/schemas/DealPointIntegratorsDtoInbox" } } } }, "DealPointIntegratorsDtoInbox": { "type": "object", "description": "Адрес загрузки/разгрузки в Заказе", "additionalProperties": false, "properties": { "deal_point_id": { "type": "string", "description": "Id адреса загрузки/разгрузки из Заказа", "format": "guid" }, "organization_id": { "type": "string", "description": "Id организации", "format": "guid" }, "contact_person_id": { "type": "string", "description": "Id контакта адреса", "format": "guid", "nullable": true }, "address_id": { "type": "string", "description": "Id адреса", "format": "guid", "nullable": true } } }, "LoadTakeInfoIntegratorsDto": { "type": "object", "description": "Параметры Заказа", "additionalProperties": false, "properties": { "rate_type": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/RateType" } ] }, "driver_id": { "type": "string", "description": "Id водителя", "format": "guid", "nullable": true }, "truck_info_id": { "type": "string", "description": "Id транспортного средства", "format": "guid", "nullable": true }, "semitrailer_id": { "type": "string", "description": "Id полуприцепа\n \n*Может быть указан только если транспортное средство — тягач*", "format": "guid", "nullable": true }, "trailer_id": { "type": "string", "description": "Id прицепа\n \n*Может быть указан только если указан полуприцеп или транспортное средство — грузовик*", "format": "guid", "nullable": true }, "requisites_id": { "type": "string", "description": "Id реквизитов", "format": "guid", "nullable": true }, "signer_id": { "type": "string", "description": "Id подписанта", "format": "guid", "nullable": true }, "is_drop_docs": { "type": "boolean", "description": "Отзывать ли привязанные документы\n \n*Используется при редактировании*" }, "deal_kind": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/DealKinds" } ] }, "taker_note": { "type": "string", "description": "Комментарий перевозчика" } } }, "ChangeAddressDto": { "type": "object", "additionalProperties": false, "properties": { "deal_id": { "type": "string", "description": "Идентификатор Заказа", "format": "guid", "nullable": true, "example": "B3803262-B6BE-47C1-83AB-613DEEEFDCBC" }, "changed": { "type": "boolean", "description": "Признак изменения", "example": false }, "routes": { "type": "array", "description": "Точки маршрута", "nullable": true, "items": { "$ref": "#/components/schemas/ChangeRouteDto" } } } }, "ChangeRouteDto": { "type": "object", "additionalProperties": false, "properties": { "ordinal_id": { "type": "integer", "description": "Порядковый номер точки", "format": "int32", "example": 1 }, "deal_point_id": { "type": "string", "description": "Id точки", "format": "guid", "nullable": true, "example": "3b4e4312-6fe3-ed11-bb95-0025906a774d" }, "point_type": { "description": "Тип точки маршрута\n \n* `1` — Загрузка\n* `2` — Разгрузка\n* `3` — Таможня\n* `8` — Ехать через", "oneOf": [ { "$ref": "#/components/schemas/DealPointTypes" } ] }, "address": { "type": "string", "description": "Адрес", "nullable": true, "example": "улица Пальшиной" }, "city_id": { "type": "integer", "description": "Id города\\\nЗначение из [словаря городов АТИ](https://ati.su/developers/api/dictionaries/geo/) ", "format": "int32", "nullable": true, "example": 1422 }, "latitude": { "type": "number", "description": "Широта", "format": "double", "nullable": true, "example": 30.3330562 }, "longitude": { "type": "number", "description": "Долгота точки", "format": "double", "nullable": true, "example": 59.974006 }, "organization_id": { "type": "string", "description": "Id организации из справочника ", "format": "guid", "nullable": true, "example": "a7a47bac-c4a5-ec11-bbc4-0cc47af31075" }, "address_id": { "type": "string", "description": "Id адреса в организации из справочника ", "format": "guid", "nullable": true, "example": "69044dcd-c7a5-ec11-bbc4-0cc47af31075" } } }, "ChangeDatesDto": { "type": "object", "additionalProperties": false, "properties": { "deal_id": { "type": "string", "description": "Идентификатор Заказа", "format": "guid", "nullable": true, "example": "B3803262-B6BE-47C1-83AB-613DEEEFDCBC" }, "loading": { "description": "Загрузка", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ChangePointDto" } ] }, "unloading": { "description": "Разгрузка", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ChangePointDto" } ] }, "way_points": { "type": "object", "description": "Точки маршрута (в качестве ключа ordinal_id)", "nullable": true, "additionalProperties": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ChangePointDto" } ] } } } }, "ChangePointDto": { "type": "object", "additionalProperties": false, "properties": { "first_date": { "description": "Дата начала", "example": "2025-09-15", "oneOf": [ { "$ref": "#/components/schemas/SettableOfNullableDateTimeOffset" } ] }, "last_date": { "description": "Дата конца", "example": "2025-09-16", "oneOf": [ { "$ref": "#/components/schemas/SettableOfNullableDateTimeOffset" } ] }, "time": { "description": "Время загрузки ($type: bounded - c-по; round-the-clock - круглосуточно)", "oneOf": [ { "$ref": "#/components/schemas/SettableOfChangeTimeDto" } ] } } }, "SettableOfNullableDateTimeOffset": { "type": "object", "additionalProperties": false, "properties": { "value": { "type": "string", "format": "date-time", "nullable": true }, "is_set": { "type": "boolean" } } }, "SettableOfChangeTimeDto": { "type": "object", "additionalProperties": false, "properties": { "value": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/ChangeTimeDto" } ] }, "is_set": { "type": "boolean" } } }, "ChangeTimeDto": { "type": "object", "discriminator": { "propertyName": "$type", "mapping": { "bounded": "#/components/schemas/ChangeTimeBoundedDto", "round-the-clock": "#/components/schemas/ChangeTimeRoundTheClockDto" } }, "x-abstract": true, "additionalProperties": false, "required": [ "$type" ], "properties": { "$type": { "type": "string" } } }, "ChangeContactsDto": { "type": "object", "additionalProperties": false, "required": [ "deal_id", "contact_id1" ], "properties": { "deal_id": { "type": "string", "description": "Идентификатор Заказа", "format": "guid", "minLength": 1, "example": "B3803262-B6BE-47C1-83AB-613DEEEFDCBC" }, "contact_id1": { "type": "integer", "description": "Основной контакт", "format": "int32" }, "contact_id2": { "type": "integer", "description": "Второй контакт", "format": "int32", "nullable": true } } }, "ChangeNoteDto": { "type": "object", "additionalProperties": false, "properties": { "deal_id": { "type": "string", "description": "Идентификатор Заказа", "format": "guid", "example": "B3803262-B6BE-47C1-83AB-613DEEEFDCBC" }, "note": { "type": "string", "description": "Новое значение примечания", "nullable": true, "example": "Новый текст примечания" } } }, "DeclineOrderIntegratorsDto": { "type": "object", "additionalProperties": false, "properties": { "reason": { "type": "string" }, "action": { "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/FinishActionIntegrators" } ] } } }, "FinishActionIntegrators": { "type": "integer", "description": "Действие после отмены заказа\n* `1` — Восстановить груз\n* `2` — Оставить груз в Архиве (если по грузу есть торги, они отменятся)\n* `3` — Сменить победителя\n* `4` — Перезапустить Торги", "x-enumNames": [ "PublishLoad", "DeleteLoad", "SelectNewWinner", "RestartAuction" ], "enum": [ 1, 2, 3, 4 ] }, "PersonalInvitationDTO": { "type": "object", "additionalProperties": false, "required": [ "load_id", "taker_ati_id", "taker_contacts_list", "payment" ], "properties": { "load_id": { "type": "string", "description": "Id груза", "format": "guid", "minLength": 1, "example": "7a48a9d3-55cb-48a2-8527-35ff461eeb8c" }, "taker_ati_id": { "type": "string", "description": "Id аккаунта приглашаемой фирмы", "minLength": 1, "example": "14612" }, "taker_contacts_list": { "type": "array", "description": "Список контактов приглашаемой фирмы", "example": [ 0, 2, 5 ], "items": { "type": "integer", "format": "int32" } }, "payment": { "description": "Параметры оплаты заказа. Обязательно указание хотя бы одной ставки и валюты для неё.", "oneOf": [ { "$ref": "#/components/schemas/PersonalInvitationPaymentDTO" } ] }, "cancel_after_in_minutes": { "type": "integer", "description": "Через сколько минут отменить приглашение \"Оформить Заказ\".\nДопустимое значение от 1 до 4320 минут. По умолчанию - 4320 (3 суток)", "format": "int32", "deprecated": true, "x-deprecatedMessage": "удалить после выкладки ATIS-7844/ATIS-8074 и перехода приглашения из встречек на отдельный апи/указание точного времени", "nullable": true, "example": 60 }, "cancellation_date": { "type": "string", "description": "Дата отмены предложения на перевозку груза, формат ISO 8601", "format": "date-time", "nullable": true }, "is_tracking": { "type": "boolean", "description": "Запрос отслеживания через АТИ Водитель" } } }, "PersonalInvitationPaymentDTO": { "type": "object", "description": "Параметры оплаты заказа. Обязательно указание хотя бы одной ставки и валюты для неё.", "additionalProperties": false, "properties": { "price": { "type": "number", "description": "Сумма", "format": "decimal", "nullable": true, "example": 10000 }, "currency_id": { "type": "integer", "description": "ID валюты", "format": "int32", "nullable": true, "example": 32 }, "nds_price": { "type": "number", "description": "Сумма с НДС", "format": "decimal", "nullable": true }, "nds_currency_id": { "type": "integer", "description": "ID валюты c НДС", "format": "int32", "nullable": true }, "not_nds_price": { "type": "number", "description": "Сумма без НДС", "format": "decimal", "nullable": true }, "not_nds_currency_id": { "type": "integer", "description": "ID валюты без НДС", "format": "int32", "nullable": true } } }, "PersonalOfferInvitationDTO": { "type": "object", "additionalProperties": false, "properties": { "load_id": { "type": "string", "description": "Id груза", "format": "guid", "example": "7a48a9d3-55cb-48a2-8527-35ff461eeb8c" }, "response_id": { "type": "string", "description": "Id встречного приглашения.\nЗначение из метода [получения отзывов](https://ati.su/developers/api/loads/published/#get-v1.0-loads-new-responses)", "format": "guid", "example": "5026ffdd-4c2a-eb11-bb90-0025906a774d" }, "rate_types": { "type": "array", "description": "По каким ставкам отправить приглашение. \nТипы ставок:\n \n* `0` — наличные\n* `1` — б/нал с НДС\n* `2` — б/нал без НДС", "example": [ 0, 2 ], "items": { "$ref": "#/components/schemas/PriceType" } }, "cancel_after_in_minutes": { "type": "integer", "description": "Через сколько минут отменить приглашение \"Оформить Заказ\".\nДопустимое значение от 1 до 4320 минут. По умолчанию - 4320 (3 суток)", "format": "int32", "nullable": true, "example": 60 }, "is_auto": { "type": "boolean", "description": "Приглашение создано автоматически" }, "need_archive_on_invite": { "type": "boolean", "description": "Архивировать заявку при срабатывании автоматического приглашения" } } }, "PriceType": { "type": "integer", "description": "Тип ставки\n \n* `0` — наличные\n* `1` — б/нал с НДС\n* `2` — б/нал без НДС", "x-enumNames": [ "Cash", "CashlessWithNds", "CashlessWithoutNds" ], "enum": [ 0, 1, 2 ] }, "LoadPersonalInvitationView": { "type": "object", "additionalProperties": false, "properties": { "load_id": { "type": "string", "description": "Id груза", "format": "guid" }, "taker_ati_id": { "type": "string", "description": "Id приглашенной фирмы" }, "taker_persistent_user_id": { "type": "integer", "description": "Постоянный Id приглашенной фирмы", "format": "int32" }, "taker_contacts_list": { "type": "array", "description": "Список контактов приглашенной фирмы", "items": { "type": "integer", "format": "int32" } }, "taker_contact_id": { "type": "integer", "description": "Id контакта приглашенной фирмы", "format": "int32", "deprecated": true }, "date": { "type": "string", "description": "Время отправки приглашения", "format": "date-time" }, "cancellation_date": { "type": "string", "description": "Время отмены приглашения", "format": "date-time", "nullable": true }, "deal_kind": { "description": "Тип Заказа\n \n* `0` — Заказ невозможен \n* `1` — Взятие груза из поиска\n* `2` — Заказ из Торгов\n* `4` — Предложение груза\n* `8` — Из перехвата машин\n* `16` — Односторонний заказ\n* `32` — Предложение груза из встречного предложения\n* `64` — Предложение груза по контракту", "oneOf": [ { "$ref": "#/components/schemas/DealKinds" } ] }, "payment": { "description": "Предложенные параметры оплаты", "oneOf": [ { "$ref": "#/components/schemas/InvitationPaymentView" } ] }, "is_tracking": { "type": "boolean", "description": "Запрос отслеживания через АТИ Водитель" } } }, "InvitationPaymentView": { "type": "object", "additionalProperties": false, "properties": { "rates": { "type": "array", "description": "Список возможных ставок перевозки", "items": { "$ref": "#/components/schemas/InvitationRateView" } }, "prepay_percent": { "type": "integer", "description": "Процент предоплаты", "format": "int32" }, "prepay_percent_enabled": { "type": "boolean", "description": "Есть ли предоплата" }, "on_unloading": { "type": "boolean", "description": "Оплата на выгрузке" }, "in_fuel": { "type": "boolean", "description": "Оплата топливом" }, "pay_days_enabled": { "type": "boolean", "description": "Есть ли срок оплаты" }, "pay_days": { "type": "integer", "description": "Срок оплаты", "format": "int32" }, "fixed_rate": { "type": "boolean", "description": "Указана ли в грузе ставка" }, "torg": { "type": "boolean", "description": "Возможен ли торг" }, "direct_contract": { "type": "boolean", "description": "Прямой договор" }, "money_type": { "type": "integer", "description": "Способ оплаты", "format": "int32", "nullable": true }, "payment_source": { "$ref": "#/components/schemas/PaymentSource" } } }, "InvitationRateView": { "type": "object", "additionalProperties": false, "properties": { "rate": { "type": "number", "description": "Сумма", "format": "decimal", "nullable": true }, "rate_type": { "description": "Тип оплаты\n \n* `0` — Нет\n* `1` — Любая\n* `2` — С НДС\n* `3` — Без НДС", "nullable": true, "oneOf": [ { "$ref": "#/components/schemas/RateType" } ] }, "currency": { "type": "integer", "description": "Id валюты\\\nЗначение из [словаря валют АТИ](https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-currencyTypes)", "format": "int32", "nullable": true } } }, "PersonalInvitationView3": { "type": "object", "additionalProperties": false, "properties": { "owner_ati_id": { "type": "string", "description": "Id фирмы грузовладельца" }, "owner_persistent_user_id": { "type": "integer", "description": "Постоянный Id фирмы грузовладельца", "format": "int32" }, "owner_contact_id": { "type": "integer", "description": "Id контакта, который отправил приглашение", "format": "int32", "nullable": true }, "taker_ati_id": { "type": "string", "description": "Id приглашенной фирмы" }, "taker_persistent_user_id": { "type": "integer", "description": "Постоянный Id приглашенной фирмы", "format": "int32" }, "taker_contact_id": { "type": "integer", "description": "Id контакта приглашенной фирмы", "format": "int32" }, "taker_contacts_list": { "type": "array", "description": "Список контактов приглашенной фирмы", "items": { "type": "integer", "format": "int32" } }, "date": { "type": "string", "description": "Время отправки приглашения", "format": "date-time" }, "cancellation_date": { "type": "string", "description": "Время отмены приглашения", "format": "date-time", "nullable": true }, "payment": { "description": "Предложенные параметры оплаты", "oneOf": [ { "$ref": "#/components/schemas/InvitationPaymentView" } ] }, "load": { "description": "Параметры предложенного груза", "oneOf": [ { "$ref": "#/components/schemas/ShortLoadView" } ] }, "is_tracking": { "type": "boolean", "description": "Запрос отслеживания через АТИ Водитель" }, "deal_kind": { "description": "Тип Заказа", "oneOf": [ { "$ref": "#/components/schemas/DealKinds" } ] } } }, "ShortLoadView": { "type": "object", "description": "Краткая информация по грузу", "additionalProperties": false, "properties": { "id": { "type": "string", "description": "ID груза", "format": "guid" }, "load_number": { "type": "string", "description": "Сгенерированный номер груза" }, "distance": { "type": "integer", "description": "Расстояние для груза\n \n*При расчете учитываются дополнительные пункты разгрузки*", "format": "int32" }, "distance_type": { "type": "integer", "description": "Маршрут построен с проездом по МКАД или без МКАД\n \n* `0` — без МКАД\n* `1` — с МКАД", "format": "int32" }, "platon_roads_length": { "type": "integer", "description": "Расстояние по Платону", "format": "int32" }, "toll_roads_length": { "type": "integer", "description": "Расстояние по платным дорогам", "format": "int32" }, "travel_time": { "type": "string", "description": "Время в пути", "format": "duration" }, "true_price": { "type": "integer", "description": "Озвученная ставка", "format": "int32" }, "true_currency_id": { "type": "integer", "description": "ID валюты озвученной ставки", "format": "int32" }, "note": { "type": "string", "description": "Примечание к грузу" }, "first_date": { "type": "string", "description": "Дата, начиная с которой груз актуален", "format": "date-time" }, "last_date": { "type": "string", "description": "Дата, после которой груз не актуален", "format": "date-time" }, "date_type": { "$ref": "#/components/schemas/DateType" }, "periodicity_id": { "$ref": "#/components/schemas/Periodicity" }, "order_number": { "type": "string", "description": "Номер груза/заказа" }, "krugoreis": { "type": "boolean", "description": "Кругорейс" }, "zimnik": { "type": "boolean", "description": "Зимники" }, "ferries": { "type": "boolean", "description": "Паромные переправы" }, "loading": { "description": "Точка загрузки", "oneOf": [ { "$ref": "#/components/schemas/LoadPoint" } ] }, "extra_points": { "type": "array", "description": "Дополнительные точки ", "items": { "$ref": "#/components/schemas/LoadExtraPoint" } }, "unloading": { "description": "Точка разгрузки", "oneOf": [ { "$ref": "#/components/schemas/LoadPoint" } ] }, "cargo": { "description": "Параметры груза", "oneOf": [ { "$ref": "#/components/schemas/LoadCargo" } ] }, "transport": { "description": "Параметры перевозки", "oneOf": [ { "$ref": "#/components/schemas/LoadTransport" } ] }, "unload_first_date": { "type": "string", "description": "Дата, начиная с которой можно разгрузить груз", "format": "date-time", "nullable": true }, "unload_last_date": { "type": "string", "description": "Дата, до которой можно разгрузить груз", "format": "date-time", "nullable": true } } }, "presence__User": { "type": "object", "properties": { "code_id": { "type": "string", "description": "id пользователя", "example": "123.0" }, "state": { "type": "string", "description": "состояние пользователя", "example": "offline" } } }, "StatesOfUsers": { "type": "array", "items": { "$ref": "#/components/schemas/presence__User" } }, "ApproveStatus": { "type": "string", "description": "Статус бронирования", "enum": [ "approved", "decline", "await_reaction", "await_client" ] }, "time-slots_v1__DayOfWeek": { "type": "integer", "description": "Идентификатор дня недели. 1-Понедельник, 2-Вторник, 3-Среда и т. д.", "required": "true", "minimum": 1, "maximum": 7 }, "ScheduleItem": { "type": "object", "properties": { "time_from": { "type": "string", "required": "true", "description": "Время начала работы склада" }, "time_to": { "type": "string", "description": "Время окончания работы склада", "required": "true" }, "day_of_week": { "type": "integer", "description": "Идентификатор дня недели. 1-Понедельник, 2-Вторник, 3-Среда и т. д.", "required": "true", "minimum": 1, "maximum": 7 } }, "required": [ "time_from", "time_to", "day_of_week" ] }, "time-slots_v1__LoadingType": { "type": "string", "enum": [ "any", "gates", "up", "lateral" ], "description": "Тип загрузки" }, "WarehouseContact": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор контакта во временных окнах" }, "name": { "type": "string", "description": "Имя контактного лица", "required": "true" }, "phone": { "type": "string", "description": "Телефон контактного лица", "required": "true" }, "country_phone_id": { "type": "integer", "description": "Идентификатор страны телефона контактного лица. 0-Россия, 1-Украина, 2-Казахстан, 3-Беларусь, 4-Другие", "required": "true", "minimum": 0, "maximum": 4 } }, "required": [ "name", "phone", "country_phone_id" ] }, "Warehouse": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор склада" }, "owner": { "type": "integer", "description": "Идентификатор фирмы владельца склада" }, "country_id": { "type": "integer", "description": "Идентификатор страны. Ему соответствует название страны из [словаря](https://ati.su/developers/api/dictionaries/geo/)" }, "region_id": { "type": "integer", "description": "Идентификатор региона. Ему соответствует название региона из [словаря](https://ati.su/developers/api/dictionaries/geo/)" }, "city_verbose": { "type": "string", "description": "Название города" }, "utc_offset": { "type": "integer", "description": "Количество минут, на которые время склада отличается от UTC" }, "date_creation": { "type": "string", "description": "Дата создания склада" }, "date_modified": { "type": "string", "description": "Дата изменения склада" }, "deleted": { "type": "boolean", "description": "Флаг, показывающий удален склад или нет" }, "is_test": { "type": "boolean", "description": "Флаг, показывающий является ли склад тестовым" }, "name": { "type": "string", "description": "Название склада" }, "address": { "type": "string", "description": "Адрес склада" }, "city_id": { "type": "integer", "description": "Идентификатор города. Ему соответствует название города из [словаря](https://ati.su/developers/api/dictionaries/geo/)" }, "contacts": { "type": "array", "description": "Контакты контактного лица/лиц склада", "items": { "$ref": "#/components/schemas/WarehouseContact" } }, "schedule": { "type": "array", "description": "Список рабочих дней склада", "items": { "$ref": "#/components/schemas/ScheduleItem" } } } }, "Gate": { "type": "object" }, "Terminal": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор площадки погрузки-выгрузки" }, "gates": { "type": "array", "description": "Список ворот площадки погрузки-выгрузки", "items": { "$ref": "#/components/schemas/Gate" } }, "schedule": { "type": "array", "description": "Расписание работы площадки погрузки-выгрузки", "items": { "$ref": "#/components/schemas/ScheduleItem" } }, "contacts": { "description": "Контактные данные ответственных лиц", "type": "array", "items": { "$ref": "#/components/schemas/WarehouseContact" } }, "name": { "type": "string", "description": "Название площадки погрузки-выгрузки" }, "gates_count": { "type": "integer", "description": "Количество ворот" }, "loading_type": { "$ref": "#/components/schemas/time-slots_v1__LoadingType" }, "date_creation": { "type": "string", "description": "Дата создания площадки погрузки-выгрузки" }, "date_modified": { "type": "string", "description": "Дата изменения площадки погрузки-выгрузки" }, "deleted": { "description": "Флаг, указывающий существует ли площадка погрузки-выгрузки или была удалена", "type": "boolean" }, "is_test": { "description": "Флаг, указывающий является ли площадка погрузки-выгрузки тестовой", "type": "boolean" }, "warehouse": { "type": "integer", "description": "Идентификатор склада" } }, "required": [ "gates_count", "loading_type", "contacts", "name", "schedule", "warehouse" ] }, "WarehouseWorkloadItem": { "type": "object", "properties": { "date": { "type": "string" }, "weekday": { "$ref": "#/components/schemas/time-slots_v1__DayOfWeek" }, "possible_slots_count": { "type": "integer" }, "available_slots_count": { "type": "integer" }, "loading_level": { "type": "string", "enum": [ "low", "middle", "high" ] } } }, "TimeSlot": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор бронирования. Если передан, то бронирование будет обновлено" }, "time_from": { "type": "string", "description": "Время начала брони" }, "time_to": { "type": "string", "description": "Время окончания брони" }, "warehouse_info": { "type": "object", "description": "Информация о складе, на котором создано бронирование", "properties": { "id": { "type": "integer", "description": "Идентификатор склада" }, "name": { "type": "string", "description": "Название склада" }, "address": { "type": "string", "description": "Адрес склада" }, "city_verbose": { "type": "string", "description": "Название города, в котором находится склад" }, "utc_offset": { "type": "integer", "description": "Количество минут, на которые время склада отличается от UTC" }, "owner": { "type": "integer", "description": "Идентификатор фирмы, которой принадлежит склад" } } }, "attached_files": { "type": "array", "description": "Список приложенных к бронированию файлов" }, "can_be_edited": { "type": "boolean", "description": "Флаг, указывающий на возможность редактирования бронирования" }, "is_expired": { "type": "boolean", "description": "Флаг, указывающий просрочено ли временя бронирования" }, "timeslot_readable_id": { "type": "string", "description": "Человекочитаемый идентификатор бронирования" }, "approve_status": { "$ref": "#/components/schemas/ApproveStatus" }, "action_type": { "type": "string", "description": "Тип действия на складе", "enum": [ "unloading", "loading", "loading_unloading" ] }, "slot_owner": { "type": "integer", "description": "Идентификатор фирмы пользователя, создавшего бронирования" }, "contact_id": { "type": "integer", "description": "Идентификатор контакта пользователя, создавшего бронирование" }, "email": { "type": "string", "description": "Адрес электронной почты создателя бронирования" }, "contact_name": { "type": "string", "description": "ФИО водителя" }, "contact_phone": { "type": "string", "description": "Телефон водителя" }, "country_phone_id": { "type": "integer", "description": "Идентификатор страны телефона контактного лица. 0-Россия, 1-Украина, 2-Казахстан, 3-Беларусь, 4-Другие", "required": "true", "minimum": 0, "maximum": 4 }, "gate_number": { "type": "integer", "description": "Идентификатор склада" }, "car_number": { "type": "string", "description": "Государственный регистрационный номер автомобиля" }, "car_capacity": { "type": "integer", "description": "Грузоподъемность транспортного средства" }, "body_type": { "type": "string", "description": "Тип кузова" }, "cargo": { "type": "string", "description": "Наименование груза" }, "cargo_count": { "type": "integer", "description": "Количество грура" }, "cargo_unit": { "type": "string", "description": "Единицы измерения груза" }, "cargo_owner": { "type": "string", "description": "Владелец груза" }, "cargo_owner_contact_name": { "type": "string", "description": "Имя грузовладельца" }, "cargo_owner_contact_number": { "type": "string", "description": "Телефонный номер грузовладельца" }, "comment": { "type": "string", "description": "Комментарий" }, "firm_name": { "type": "string", "description": "Название фирмы перевозчика" }, "date_from": { "type": "string", "description": "Дата начала бронирования" }, "data_to": { "type": "string", "description": "Дата окончания бронирования" }, "date_creation": { "type": "string", "description": "Дата и время создания бронирования" }, "date_modified": { "type": "string", "description": "Дата и время изменения бронирования" }, "deleted": { "type": "boolean", "description": "Флаг, показывающий удалено бронирование или нет" }, "is_test": { "type": "boolean", "description": "Флаг, показывающий является ли бронирование тестовым" }, "warehouse": { "type": "integer", "description": "Идентификатор склада" }, "terminal": { "type": "integer", "description": "Идентификатор площадки погрузки-выгрузки" }, "order_point": { "$ref": "#/components/schemas/OrderPoint" }, "warehouse_name": { "type": "string", "description": "Название склада" }, "terminal_name": { "type": "string", "description": "Название площадки погрузки-выгрузки" } } }, "FieldHistory": { "type": "object", "properties": { "field": { "type": "object", "properties": { "name": { "type": "string" }, "old_value": { "type": "string" }, "new_value": { "type": "string" } } } } }, "TimeSlotHistoryItem": { "type": "object", "properties": { "iso_warehouse_local_datetime": { "type": "string", "description": "Время изменения в локальном времени склада" }, "editor_info": { "type": "object", "properties": { "name": { "type": "string" } } }, "changes": { "type": "object", "properties": { "created": { "type": "array", "items": { "$ref": "#/components/schemas/FieldHistory" } }, "updated": { "type": "array", "items": { "$ref": "#/components/schemas/FieldHistory" } }, "deleted": { "type": "array", "items": { "$ref": "#/components/schemas/FieldHistory" } } } } } }, "time-slots_v1__Account": { "type": "object", "additionalProperties": { "type": "object", "properties": { "firm_type": { "type": "string", "description": "Тип фирмы" }, "firm_id": { "type": "integer" }, "account_id": { "type": "string" }, "full_firm_name": { "type": "string" }, "firm_name": { "type": "string" }, "brand": { "type": "string" }, "location": { "type": "object", "properties": { "city_id": { "type": "integer" }, "region_id": { "type": "integer" }, "country_id": { "type": "integer" }, "full_name": { "type": "string" }, "short_name": { "type": "string" }, "is_regional_center": { "type": "boolean" }, "city_size": { "type": "integer" }, "fias_id": { "type": "string" }, "attributes": { "type": "integer" }, "city_name": { "type": "string" }, "region_name": { "type": "string" }, "country_code_name": { "type": "string" } } }, "passport": { "type": "object", "properties": { "ati_id": { "type": "string" }, "total_score": { "type": "number", "format": "float" }, "ati_data_match_point": { "type": "number", "format": "float" }, "account_lifetime_point": { "type": "number", "format": "float" }, "business_activity_point": { "type": "number", "format": "float" }, "round_table_point": { "type": "number", "format": "float" }, "claim_point": { "type": "number", "format": "float" }, "prof_activity_point": { "type": "number", "format": "float" }, "ati_administration_point": { "type": "number", "format": "float" }, "clones_point": { "type": "number", "format": "float" }, "egr_point": { "type": "number", "format": "float" }, "mass_registration_point": { "type": "number", "format": "float" }, "mass_founder_point": { "type": "number", "format": "float" }, "firm_lifetime_point": { "type": "number", "format": "float" }, "guaranteed_payment_point": { "type": "number", "format": "float" }, "virtual_account_debts_point": { "type": "number", "format": "float" }, "bad_partner_mentions_point": { "type": "number", "format": "float" }, "ri_users_attributes": { "type": "integer" }, "recommendations_count": { "type": "integer" }, "status": { "type": "integer" }, "status_description": { "type": "string" }, "negative_points_sum": { "type": "number", "format": "float" } } }, "contacts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } } } } } } }, "OrderLoad": { "type": "object", "properties": { "ordinal_number": { "type": "integer" }, "weight": { "type": "number", "format": "float" }, "volume": { "type": "number", "format": "float", "nullable": true }, "cargo_type": { "type": "string", "description": "Тип груза. Может быть введен пользователем" } } }, "OrderRouteItem": { "type": "object", "properties": { "name": { "type": "string", "description": "Название города" }, "type": { "type": "string", "enum": [ "loading", "unloading" ], "description": "Тип точки" } } }, "OrderPoint": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор точки заказа во Временных окнах" }, "can_be_created": { "type": "boolean" }, "load_number": { "type": "string" }, "deal_id": { "type": "string", "description": "Идентификатор сделки" }, "warehouse": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор склада во Временных окнах" }, "name": { "type": "string", "description": "Название склада" }, "address": { "type": "string", "description": "Адрес склада" }, "city_verbose": { "type": "string", "description": "Название города, в котором расположен склад" } } }, "driver_name": { "type": "string", "description": "ФИО водителя" }, "driver_phone": { "type": "string", "description": "Телефон водителя" }, "car_number": { "type": "string", "description": "Государственный регистрационный номер автомобиля" }, "car_load_capacity": { "type": "number", "format": "float" }, "load_owner_contact_id": { "type": "integer", "nullable": true }, "order_loads": { "type": "array", "items": { "$ref": "#/components/schemas/OrderLoad" } }, "warehouse_owner": { "type": "integer", "description": "Идентификатор фирмы, которая владеет складом" }, "order_route": { "type": "array", "items": { "$ref": "#/components/schemas/OrderRouteItem" } }, "ordinal_id": { "type": "integer" }, "point_type": { "type": "string" }, "car_type": { "type": "string" } }, "nullable": true }, "SingleError": { "description": "Одиночная ошибка", "properties": { "error": { "description": "Текстовый код ошибки", "type": "string" }, "reason": { "description": "Человекочитаемый текст ошибки", "type": "string" } } }, "MultipleError": { "type": "object", "description": "Множественная ошибка", "properties": { "error": { "description": "Текстовый код ошибки", "type": "string" }, "reason": { "description": "Человекочитаемый текст ошибки", "type": "string" }, "error_list": { "description": "Список возникших ошибок", "type": "array", "items": { "$ref": "#/components/schemas/SingleError" } } } }, "trucks-search-public__AccountView": { "type": "object", "properties": { "ati_id": { "type": "string", "description": "Код фирмы в ATI.SU", "nullable": true }, "firm_name": { "type": "string", "description": "Название фирмы", "nullable": true }, "full_firm_name": { "type": "string", "description": "Полное имя фирмы: Брэнд (Название фирмы, ОПФ)", "nullable": true }, "brand": { "type": "string", "description": "Брэнд фирмы", "nullable": true }, "ownership": { "type": "string", "description": "Идентификатор формы собственности", "nullable": true }, "ownership_id": { "type": "integer", "description": "Право собственности фирмы", "format": "int32" }, "firm_type_id": { "type": "integer", "description": "Идентификатор профиля деятельности фирмы", "format": "int32" }, "firm_type": { "type": "string", "description": "Профиль деятельности фирмы", "nullable": true }, "claims_sum": { "type": "number", "description": "Сумма претензий к данной фирме в рублях", "format": "double", "nullable": true }, "claims_count": { "type": "integer", "description": "Количество претензий к данной фирме", "format": "int32" }, "bad_partner_mentions_count": { "type": "integer", "description": "Количество упоминаний о данной фирме на форуме \"Недобросовестные партнеры\"", "format": "int32" }, "bad_partner_firms_count": { "type": "integer", "description": "Количество фирм, которые написали о данной фирме на форуме Недобросовестных партнеров", "format": "int32" }, "recommendation_count": { "type": "integer", "description": "Количество рекомендаций к фирме", "format": "int32" }, "recommendations_count": { "type": "integer", "description": "Количество рекомендаций к фирме", "format": "int32" }, "is_ati_partner": { "type": "boolean", "description": "Партнер ATI.SU" }, "is_odks_member": { "type": "boolean", "description": "Член общ. движения Круглый Стол" }, "city_id": { "type": "integer", "description": "Id города откуда фирма", "format": "int32" }, "passport": { "allOf": [ { "$ref": "#/components/schemas/trucks-search-public__PassportView" } ], "description": "Паспорт фирмы", "nullable": true }, "contacts": { "type": "array", "items": { "$ref": "#/components/schemas/trucks-search-public__ContactView" }, "description": "Контакты фирмы", "nullable": true }, "user_lists": { "allOf": [ { "$ref": "#/components/schemas/CustomLists" } ], "description": "Пользовательские списки", "nullable": true }, "comment": { "type": "string", "description": "Комментарий к фирме", "nullable": true } }, "additionalProperties": false }, "BodyType": { "enum": [ 0, 1, 2, 4 ], "type": "integer", "description": "", "format": "int32" }, "trucks-search-public__ContactView": { "type": "object", "properties": { "id": { "type": "integer", "description": "Идентификатор контакта", "format": "int32" }, "name": { "type": "string", "description": "Имя контакта", "nullable": true }, "telephone": { "type": "string", "description": "Телефон контакта", "nullable": true }, "telephone_brand": { "type": "string", "description": "Телефонный брэнд", "nullable": true }, "telephone_region": { "type": "string", "description": "Регион, в котором зарегистрирован телефонный номер", "nullable": true }, "email": { "type": "boolean", "description": "Есть ли Email у контакта" }, "icq": { "type": "string", "description": "Icq контакта", "nullable": true }, "mobile": { "type": "string", "description": "Мобильный телефон контакта", "nullable": true }, "mobile_brand": { "type": "string", "description": "Мобильный брэнд", "nullable": true }, "mobile_region": { "type": "string", "description": "Регион, в котором зарегистрирован мобильный телефонный номер", "nullable": true }, "skype_name": { "type": "string", "description": "Скайп контакта", "nullable": true }, "fax": { "type": "string", "description": "Факс контакта", "nullable": true }, "mobile_operator": { "type": "string", "description": "Мобильный оператор", "nullable": true }, "city_id": { "type": "integer", "description": "Id города контакта", "format": "int32", "nullable": true } }, "additionalProperties": false }, "CustomLists": { "type": "object", "properties": { "emoji_firm_lists": { "type": "array", "items": { "$ref": "#/components/schemas/FirmListsGroupingByEmojiInfo" }, "description": "Принадлежность фирмы к спискам пользователя, выполняющего поиск", "nullable": true } }, "additionalProperties": false, "description": "Пользовательские списки" }, "DatesParameterModel": { "type": "object", "properties": { "date_option": { "type": "string", "description": "Когда доступна машина.\r\n", "nullable": true }, "date_from": { "type": "string", "description": "С какого числа доступна машина. Используется только при значении date_option \"manual\"", "format": "date-time", "nullable": true }, "date_to": { "type": "string", "description": "До какого числа доступна машина. Используется только при значении date_option \"manual\"", "format": "date-time", "nullable": true } }, "additionalProperties": false, "description": "Когда доступна машина" }, "trucks-search-public__DateType": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "", "format": "int32" }, "DimensionsModel": { "type": "object", "properties": { "length": { "allOf": [ { "$ref": "#/components/schemas/SegmentModel" } ], "description": "Длина", "nullable": true }, "width": { "allOf": [ { "$ref": "#/components/schemas/SegmentModel" } ], "description": "Ширина", "nullable": true }, "height": { "allOf": [ { "$ref": "#/components/schemas/SegmentModel" } ], "description": "Высота", "nullable": true }, "include_empty": { "type": "boolean", "description": "Подходят ли машины с неуказанными габаритами", "nullable": true } }, "additionalProperties": false, "description": "Габариты машины" }, "ExtraParamsModel": { "type": "object", "properties": { "dogruz_type": { "type": "integer", "description": "Возможность догруза\r\n", "format": "int32", "nullable": true }, "hydrolysis": { "type": "boolean", "description": "Гидролифт", "nullable": true }, "conics": { "type": "boolean", "description": "Коники", "nullable": true }, "do_not_show_regular": { "type": "boolean", "description": "Не показывать постоянные", "nullable": true }, "adr_type": { "type": "integer", "description": "Тип опасности груза (ADR). [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 100, 101]\r\n
  • 0 - Неважно
  • 1-9 - Тип ADR
  • 100 - С любым ADR
  • 101 - Без ADR
    • ", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Дополнительные параметры" }, "FirmGeoModel": { "type": "object", "properties": { "id": { "type": "integer", "description": "Id гео-пункта", "format": "int32", "nullable": true }, "type": { "type": "integer", "description": "Тип гео-пункта\r\n", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Место регистрации фирмы" }, "FirmListsGroupingByEmojiInfo": { "type": "object", "properties": { "emoji": { "type": "string", "description": "Эмоджи группы списков", "nullable": true }, "total_lists_count": { "type": "integer", "description": "Общее кол-во списков в группе", "format": "int32" }, "head_lists": { "type": "array", "items": { "$ref": "#/components/schemas/FirmListWithEmoji" }, "description": "Вложенная структура со списками группы", "nullable": true } }, "additionalProperties": false }, "FirmListWithEmoji": { "type": "object", "properties": { "list_name": { "type": "string", "description": "Название списка", "nullable": true }, "list_id": { "type": "string", "description": "Id списка", "format": "uuid" }, "emoji": { "type": "string", "description": "Эмоджи списка", "nullable": true }, "type": { "allOf": [ { "$ref": "#/components/schemas/ListKey" } ] }, "fixed": { "type": "boolean", "description": "Принадлежность к дефолтным спискам" } }, "additionalProperties": false }, "trucks-search-public__FirmStatus": { "enum": [ 0, 1, 2, 3, 4, 5, 6, 7 ], "type": "integer", "description": "", "format": "int32" }, "FromGeoModel": { "type": "object", "properties": { "id": { "type": "integer", "description": "Id гео-пункта. Используется для страны, региона или города", "format": "int32", "nullable": true }, "type": { "type": "integer", "description": "Тип гео-пункта\r\n", "format": "int32", "nullable": true }, "exact_only": { "type": "boolean", "description": "Только по точным.\r\nУчитывается только при type = 2", "nullable": true }, "list_id": { "type": "string", "description": "Id гео-списка.\r\nИспользуется только при type = 5", "format": "uuid", "nullable": true }, "radius": { "type": "integer", "description": "Радиус, в котором ищутся города.\r\nУчитывается только при type = 2", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Место загрузки" }, "IntegratorAbsent": { "type": "object", "properties": { "truck_id": { "type": "string", "description": "Идентификатор машины", "format": "uuid" }, "add_date": { "type": "string", "description": "Время добавления жалобы", "format": "date-time" }, "sender_firm_info": { "allOf": [ { "$ref": "#/components/schemas/IntegratorFirmSummary" } ], "description": "Информация о фирме", "nullable": true } }, "additionalProperties": false }, "IntegratorComplaint": { "type": "object", "properties": { "truck_id": { "type": "string", "description": "Идентификатор машины", "format": "uuid" }, "add_date": { "type": "string", "description": "Время добавления жалобы", "format": "date-time" }, "change_date": { "type": "string", "description": "Время последнего редактирования жалобы", "format": "date-time" }, "note": { "type": "string", "description": "Текст жалобы", "nullable": true }, "sender_firm_info": { "allOf": [ { "$ref": "#/components/schemas/IntegratorFirmSummary" } ], "description": "Информация о фирме, оставившей жалобу", "nullable": true } }, "additionalProperties": false }, "IntegratorContactSummary": { "type": "object", "properties": { "name": { "type": "string", "description": "Имя контакта", "nullable": true }, "phone": { "type": "string", "description": "Телефон контакта", "nullable": true }, "mobile_phone": { "type": "string", "description": "Мобильный телефон контакта", "nullable": true }, "city": { "type": "string", "description": "Город контакта", "nullable": true }, "icq": { "type": "string", "description": "Icq контакта", "nullable": true }, "skype_name": { "type": "string", "description": "Skype контакта", "nullable": true }, "fax": { "type": "string", "description": "Факс контакта", "nullable": true }, "email": { "type": "string", "description": "Email контакта", "nullable": true } }, "additionalProperties": false, "description": "Информация о контакте" }, "IntegratorCounterOffer": { "type": "object", "properties": { "truck_id": { "type": "string", "description": "Идентификатор машины", "format": "uuid" }, "addition_date": { "type": "string", "description": "Время добавления встречного предложения", "format": "date-time" }, "change_date": { "type": "string", "description": "Время последнего редактирования встречного предложения", "format": "date-time" }, "cash_sum": { "type": "number", "description": "Ставка наличными", "format": "double", "nullable": true }, "currency_id": { "type": "integer", "description": "Валюта для ставки наличными", "format": "int32", "nullable": true }, "sum_with_nds": { "type": "number", "description": "Ставка с НДС", "format": "double", "nullable": true }, "nds_currency_id": { "type": "integer", "description": "Валюта ставки с НДС", "format": "int32", "nullable": true }, "sum_without_nds": { "type": "number", "description": "Ставка без НДС", "format": "double", "nullable": true }, "not_nds_currency_id": { "type": "integer", "description": "Валюта ставки без НДС", "format": "int32", "nullable": true }, "note": { "type": "string", "description": "Примечание", "nullable": true }, "prepay_percent": { "type": "integer", "description": "Процент предоплаты", "format": "int32", "nullable": true }, "delay_payment_days": { "type": "integer", "description": "Постоплата (количество банковских дней)", "format": "int32", "nullable": true }, "loading_city_id": { "type": "integer", "description": "Город загрузки", "format": "int64", "nullable": true }, "unloading_city_id": { "type": "integer", "description": "Город разгрузки", "format": "int64", "nullable": true }, "weight": { "type": "number", "description": "Вес", "format": "double", "nullable": true }, "volume": { "type": "number", "description": "Объём", "format": "double", "nullable": true }, "car_delivery_date": { "type": "string", "description": "Дата", "format": "date-time" }, "unload_payment": { "type": "boolean", "description": "Оплата на выгрузке" }, "coloading": { "type": "boolean", "description": "Догруз" }, "sender_firm_info": { "allOf": [ { "$ref": "#/components/schemas/IntegratorFirmSummary" } ], "description": "Информация о фирме", "nullable": true } }, "additionalProperties": false }, "IntegratorFirmSummary": { "type": "object", "properties": { "ati_id": { "type": "string", "description": "Код пользователя в ATI.SU", "nullable": true }, "contact_id": { "type": "integer", "description": "Идентификатор контакта", "format": "int32" }, "contact": { "allOf": [ { "$ref": "#/components/schemas/IntegratorContactSummary" } ], "description": "Информация о контакте", "nullable": true }, "name": { "type": "string", "description": "Название фирмы", "nullable": true }, "score": { "type": "number", "description": "Балл фирмы", "format": "double" }, "status": { "allOf": [ { "$ref": "#/components/schemas/trucks-search-public__FirmStatus" } ], "description": "Статус фирмы" } }, "additionalProperties": false, "description": "Информация о фирме" }, "IntegratorSearchResultTruck": { "type": "object", "properties": { "ati_id": { "type": "string", "description": "Код пользователя", "nullable": true }, "truck_id": { "type": "string", "description": "Id машины", "format": "uuid" }, "added_at": { "type": "string", "description": "Время добавления данных машины в формате UTC", "format": "date-time" }, "updated_at": { "type": "string", "description": "Дата последнего изменения данных машины в формате UTC", "format": "date-time" }, "contact_id1": { "type": "integer", "description": "Идентификатор первого выбранного контакта", "format": "int32" }, "contact_id2": { "type": "integer", "description": "Идентификатор второго выбранного контакта, если не выбрано, то null", "format": "int32", "nullable": true }, "department_id": { "type": "integer", "description": "Подразделение машины", "format": "int32", "nullable": true }, "note": { "type": "string", "description": "Примечание к машине", "nullable": true }, "first_date": { "type": "string", "description": "Дата, начиная с которой машина актуальна, UTC", "format": "date-time" }, "last_date": { "type": "string", "description": "Дата, после которой машина не актуальна, в формате UTC", "format": "date-time" }, "periodicity_id": { "allOf": [ { "$ref": "#/components/schemas/PeriodicityType" } ], "description": "Периодичность загрузки" }, "date_type": { "allOf": [ { "$ref": "#/components/schemas/trucks-search-public__DateType" } ], "description": "Выбор типа готовности машины к перевозке" }, "true_price": { "type": "number", "description": "Озвученная ставка", "format": "double" }, "true_currency_id": { "type": "integer", "description": "Валюта озвученной ставки", "format": "int32" }, "transport": { "allOf": [ { "$ref": "#/components/schemas/IntegratorTruckParams" } ], "description": "Характеристики машины", "nullable": true }, "loading": { "allOf": [ { "$ref": "#/components/schemas/IntegratorTruckLoading" } ], "description": "Загрузка", "nullable": true }, "unloading_list": { "type": "array", "items": { "$ref": "#/components/schemas/IntegratorTruckUnloading" }, "description": "Список пунктов разгрузки", "nullable": true }, "payment_options": { "allOf": [ { "$ref": "#/components/schemas/IntegratorTruckPaymentOptions" } ], "description": "Оплата", "nullable": true }, "show_contacts": { "type": "boolean", "description": "Флаг видимости контактов для незарегистрированных пользователей" }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/IntegratorTruckComment" }, "description": "Комментарии к машинам", "nullable": true } }, "additionalProperties": false }, "IntegratorSearchResultView": { "type": "object", "properties": { "total_count": { "type": "integer", "description": "Найдено машин", "format": "int32" }, "hidden_count": { "type": "integer", "description": "Скрыто машин, подходящих под фильтр", "format": "int32" }, "accounts": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/trucks-search-public__AccountView" }, "description": "Аккаунты для найденных машин. Ключ - код фирмы в ATI.SU", "nullable": true }, "trucks": { "type": "array", "items": { "$ref": "#/components/schemas/IntegratorSearchResultTruck" }, "description": "Поисковая выдача. Список машин", "nullable": true }, "responses": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/IntegratorTruckResponseCollection" }, "description": "Словарь отзывов на машину. Ключ - id машины", "nullable": true } }, "additionalProperties": false, "description": "Результат поиска" }, "IntegratorTruckComment": { "type": "object", "properties": { "comment_id": { "type": "string", "description": "Id комментария", "format": "uuid" }, "message": { "type": "string", "description": "Сообщение", "nullable": true }, "contact_id": { "type": "integer", "description": "Id контакта, оставившего сообщение", "format": "int32" }, "contact_name": { "type": "string", "description": "Имя контакта, оставившего сообщение", "nullable": true }, "comment_date_time": { "type": "string", "description": "Время добавления комментария", "format": "date-time" } }, "additionalProperties": false }, "IntegratorTruckLoading": { "type": "object", "properties": { "city_id": { "type": "integer", "description": "Id города загрузки", "format": "int32" }, "radius": { "type": "integer", "description": "Радиус, в котором машина может быть загружена, в км", "format": "int32" }, "distance": { "type": "integer", "description": "Расстояние от пункта указанного в поиске до пункта указанного в машине", "format": "int32" } }, "additionalProperties": false, "description": "Загрузка" }, "IntegratorTruckParams": { "type": "object", "properties": { "car_type": { "type": "integer", "description": "Идентификатор кузова", "format": "int64" }, "body_type": { "allOf": [ { "$ref": "#/components/schemas/BodyType" } ], "description": "Описывает тип самого грузового автомобиля" }, "loading_type": { "type": "integer", "description": "Битовая сумма id типов загрузки, значения из [словаря вариантов типов загрузки](https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-loadingTypes)", "format": "int32" }, "weight": { "type": "number", "description": "Максимальный вес перевозки в тоннах", "format": "double" }, "volume": { "type": "number", "description": "Объем кузова в кубических метрах", "format": "double" }, "truck_length": { "type": "number", "description": "Длина кузова в метрах", "format": "double" }, "truck_width": { "type": "number", "description": "Ширина кузова в метрах", "format": "double" }, "truck_height": { "type": "number", "description": "Высота кузова в метрах", "format": "double" }, "trailer_length": { "type": "number", "description": "Длина прицепа в метрах", "format": "double" }, "trailer_width": { "type": "number", "description": "Ширина прицепа в метрах", "format": "double" }, "trailer_height": { "type": "number", "description": "Высота прицепа в метрах", "format": "double" }, "hydrolift": { "type": "boolean", "description": "Параметр, определяющий, имеется ли в кузове гидролифт" }, "partial_load": { "type": "boolean", "description": "Параметр, определяющий, возможен ли догруз" }, "koniki": { "type": "boolean", "description": "Определяет, присутствуют ли коники" }, "tir": { "type": "boolean", "description": "Параметр, определяющий, имеются ли у машины документы TIR" }, "ekmt": { "type": "boolean", "description": "Параметр, определяющий, имеются ли у машины документы EKMT" }, "adr_types": { "type": "integer", "description": "Параметр, определяющий уровни опасности грузов, которые можно провозить на данной машине.", "format": "int32" } }, "additionalProperties": false, "description": "Основные характеристики кузова" }, "IntegratorTruckPaymentOptions": { "type": "object", "properties": { "card": { "type": "boolean", "description": "Оплата на карту" }, "torg": { "type": "boolean", "description": "Торг" } }, "additionalProperties": false, "description": "Оплата" }, "IntegratorTruckResponseCollection": { "type": "object", "properties": { "offers": { "type": "array", "items": { "$ref": "#/components/schemas/IntegratorCounterOffer" }, "description": "Список встречных предложений", "nullable": true }, "absents": { "type": "array", "items": { "$ref": "#/components/schemas/IntegratorAbsent" }, "description": "Список жалоб \"Машины нет\"", "nullable": true }, "complaints": { "type": "array", "items": { "$ref": "#/components/schemas/IntegratorComplaint" }, "description": "Список жалоб на машину", "nullable": true } }, "additionalProperties": false }, "IntegratorTruckUnloading": { "type": "object", "properties": { "main": { "type": "boolean", "description": "Флаг главного пункта разгрузки" }, "visible": { "type": "boolean", "description": "Видимость пункта в выдаче (зависит от фильтра)" }, "cash_sum": { "type": "number", "description": "Ставка наличными", "format": "double" }, "sum_with_nds": { "type": "number", "description": "Ставка с НДС", "format": "double" }, "sum_without_nds": { "type": "number", "description": "Ставка без НДС", "format": "double" }, "currency_id": { "type": "integer", "description": "Валюта ставки", "format": "int32" }, "point_type": { "type": "integer", "description": "Тип гео-пункта\r\n", "format": "int32" }, "point_id": { "type": "integer", "description": "Id гео-пункта", "format": "int32" }, "radius": { "type": "integer", "description": "Радиус относительно пункта, в котором возможна разгрузка. Только при point_type = 2 (город)", "format": "int32" }, "distance": { "type": "integer", "description": "Расстояние до пункта \"откуда\" из фильтра. Заполняется, если point_type = 2 и искали в город.", "format": "int32" } }, "additionalProperties": false }, "ListKey": { "enum": [ 0, 1, 2 ], "type": "integer", "description": "", "format": "int32" }, "trucks-search-public__PassportView": { "type": "object", "properties": { "ati_data_match_point": { "type": "number", "description": "За подтверждение аккаунта", "format": "double" }, "account_lifetime_point": { "type": "number", "description": "За срок \"существования\" фирмы", "format": "double" }, "business_activity_point": { "type": "number", "description": "Свидетельство ведения фирмой текущей хозяйственной деятельности", "format": "double" }, "round_table_point": { "type": "number", "description": "Балл по решению общественного движения пользователей ATI.SU \"Круглый стол\"", "format": "double" }, "claim_point": { "type": "number", "description": "Балл за имеющиеся Претензии к пользователю", "format": "double" }, "prof_activity_point": { "type": "number", "description": "За проф. деятельность в ATI.SU", "format": "double" }, "ati_administration_point": { "type": "number", "description": "По решению администрации ATI.SU", "format": "double" }, "clones_point": { "type": "number", "description": "Балл за клонов участника системы", "format": "double" }, "egr_point": { "type": "number", "description": "По данным Единых Государственных Реестров Юридических Лиц и ИП", "format": "double" }, "mass_registration_point": { "type": "number", "description": "Юридическое лицо зарегистрировано по адресу массовой регистрации", "format": "double" }, "mass_founder_point": { "type": "number", "description": "Учредитель юридического лица является учредителем множества других юридических лиц", "format": "double" }, "firm_lifetime_point": { "type": "number", "description": "За давность регистрации в АвтоТрансИнфо", "format": "double" }, "negative_points_sum": { "type": "number", "description": "Отрицательных баллов", "format": "double" }, "total_score": { "type": "number", "description": "Общее количество звезд", "format": "double" }, "status": { "allOf": [ { "$ref": "#/components/schemas/trucks-search-public__FirmStatus" } ], "description": "Тип звезд" }, "status_description": { "type": "string", "description": "Описание статуса", "nullable": true } }, "additionalProperties": false, "description": "Паспорт фирмы" }, "PaymentModel": { "type": "object", "properties": { "rate_value": { "type": "number", "description": "Максимальная ставка", "format": "double", "nullable": true }, "rate_type": { "allOf": [ { "$ref": "#/components/schemas/trucks-search-public__RateType" } ], "description": "Тип ставки" }, "cash": { "type": "boolean", "description": "Наличными" }, "with_nds": { "type": "boolean", "description": "С НДС" }, "without_nds": { "type": "boolean", "description": "Без НДС" } }, "additionalProperties": false, "description": "Ограничения по ставке" }, "PeriodicityType": { "enum": [ 0, 1, 5, 10, 20, 40, 50, 100 ], "type": "integer", "description": "", "format": "int32" }, "trucks-search-public__RateType": { "enum": [ 0, 1, 2, 3, 4 ], "type": "integer", "description": "", "format": "int32" }, "SearchDescriptorModel": { "required": [ "filter", "items_per_page", "page" ], "type": "object", "properties": { "page": { "type": "integer", "description": "Номер страницы", "format": "int32" }, "items_per_page": { "type": "integer", "description": "Количество машин на странице. [10, 20, 30, 40, 50, 100]", "format": "int32" }, "filter": { "allOf": [ { "$ref": "#/components/schemas/SearchFilterModel" } ], "description": "Фильтр" } }, "additionalProperties": false }, "SearchFilterModel": { "type": "object", "properties": { "dates": { "allOf": [ { "$ref": "#/components/schemas/DatesParameterModel" } ], "description": "Когда доступна машина", "nullable": true }, "from": { "allOf": [ { "$ref": "#/components/schemas/FromGeoModel" } ], "description": "Откуда машина", "nullable": true }, "to": { "allOf": [ { "$ref": "#/components/schemas/ToGeoModel" } ], "description": "Куда машина", "nullable": true }, "dimensions": { "allOf": [ { "$ref": "#/components/schemas/DimensionsModel" } ], "description": "Габариты", "nullable": true }, "weight": { "allOf": [ { "$ref": "#/components/schemas/SegmentModel" } ], "description": "Вес", "nullable": true }, "volume": { "allOf": [ { "$ref": "#/components/schemas/SegmentModel" } ], "description": "Объем", "nullable": true }, "extra_params": { "allOf": [ { "$ref": "#/components/schemas/ExtraParamsModel" } ], "description": "Дополнительные параметры", "nullable": true }, "with_rate": { "type": "boolean", "description": "Показывать машины только со ставкой", "nullable": true }, "change_date": { "type": "string", "description": "Промежуток времени, когда машина добавлена в систему\r\n", "nullable": true }, "truck_type": { "type": "integer", "description": "Битовая сумма id типов кузова, значения из [словаря вариантов типов кузова](https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-carTypes)", "format": "int64", "nullable": true }, "loading_type": { "type": "integer", "description": "Битовая сумма id типов загрузки, значения из [словаря вариантов типов загрузки](https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-loadingTypes)", "format": "int64", "nullable": true }, "firm": { "allOf": [ { "$ref": "#/components/schemas/SearchFirmModel" } ], "description": "Параметр фирм", "nullable": true }, "sorting_type": { "allOf": [ { "$ref": "#/components/schemas/SortingType" } ], "description": "Сортировка" }, "payment": { "allOf": [ { "$ref": "#/components/schemas/PaymentModel" } ], "description": "Оплата", "nullable": true } }, "additionalProperties": false, "description": "Параметры для фильтрации машин" }, "SearchFirmModel": { "type": "object", "properties": { "ati_id": { "type": "string", "description": "Код пользователя", "nullable": true }, "firm_rating": { "type": "integer", "description": "Минимальный рейтинг пользователя", "format": "int32", "nullable": true }, "firm_geo": { "allOf": [ { "$ref": "#/components/schemas/FirmGeoModel" } ], "description": "Откуда фирма", "nullable": true }, "firm_list": { "type": "string", "description": "Id списка фирм", "format": "uuid", "nullable": true }, "firm_list_exclusive": { "type": "boolean", "description": "
  • \r\n false - Искать только машины фирм из списка
    • \r\n
  • \r\n true - Искать только машины фирм не из списка
    • ", "nullable": true } }, "additionalProperties": false, "description": "Ограничение на фирму. Параметр доступен только платным пользователям ATI.SU." }, "SegmentModel": { "type": "object", "properties": { "min": { "type": "number", "description": "Минимальное значение", "format": "double", "nullable": true }, "max": { "type": "number", "description": "Максимальное значение", "format": "double", "nullable": true } }, "additionalProperties": false }, "SortingType": { "enum": [ 0, 1 ], "type": "integer", "description": "", "format": "int32" }, "ToGeoModel": { "type": "object", "properties": { "id": { "type": "integer", "description": "Id гео-пункта. Используется для страны, региона или города", "format": "int32", "nullable": true }, "type": { "type": "integer", "description": "Тип гео-пункта\r\n", "format": "int32", "nullable": true }, "exact_only": { "type": "boolean", "description": "Только по точным.\r\nУчитывается только при type = 2", "nullable": true }, "list_id": { "type": "string", "description": "Id гео-списка.\r\nИспользуется только при type = 5", "format": "uuid", "nullable": true }, "radius": { "type": "integer", "description": "Радиус, в котором ищутся города.\r\nУчитывается только при type = 2", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Место разгрузки" }, "IntegratorErrorItemResponse": { "type": "object", "description": "Ошибка отдельного поля.", "additionalProperties": false, "properties": { "error": { "type": "string", "description": "Машиночитаемый код ошибки.", "nullable": true, "example": "contact_id1" }, "reason": { "type": "string", "description": "Описание ошибки.", "nullable": true, "example": "Параметр contact_id1 должен существовать" } } }, "TruckViewV1": { "description": "Машина в интеграторском контракте v1.", "allOf": [ { "$ref": "#/components/schemas/BaseTruckV1" }, { "type": "object", "description": "Опубликованная или архивная машина в интеграторском контракте v1.", "additionalProperties": false, "properties": { "truck_id": { "type": "string", "description": "Идентификатор машины.", "format": "guid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "ati_id": { "type": "string", "description": "Публичный номер машины в ATI.SU.", "example": 123456 }, "added_at": { "type": "string", "description": "Дата и время создания машины.", "format": "date-time", "example": "2026-08-17T08:00:00Z" }, "updated_at": { "type": "string", "description": "Дата и время последнего изменения машины.", "format": "date-time", "example": "2026-08-17T08:30:00Z" }, "archived_at": { "type": "string", "description": "Дата и время переноса машины в архив; null для опубликованной машины.", "format": "date-time", "nullable": true, "example": "2026-08-18T18:00:00Z" }, "archive_reason": { "description": "Причина переноса машины в архив.", "nullable": true, "example": "manual", "allOf": [ { "$ref": "#/components/schemas/trucks-api__ArchiveReason" } ] }, "can_be_edited": { "type": "boolean", "description": "Признак доступности редактирования машины текущему пользователю.", "example": true }, "can_be_renewed": { "type": "boolean", "description": "Признак доступности обновления публикации машины текущему пользователю.", "example": true }, "can_be_deleted": { "type": "boolean", "description": "Признак доступности удаления машины текущему пользователю.", "example": true }, "edit_restriction": { "description": "Причина, по которой редактирование машины недоступно.", "example": 0, "allOf": [ { "$ref": "#/components/schemas/trucks-api__OperationStatus" } ] }, "renew_restriction": { "type": "string", "description": "Причина, по которой обновление публикации машины недоступно.", "example": "Обновление будет доступно через 10 минут" }, "delete_restriction": { "description": "Причина, по которой удаление машины недоступно.", "example": 0, "allOf": [ { "$ref": "#/components/schemas/trucks-api__OperationStatus" } ] }, "is_archive_truck": { "type": "boolean", "description": "Признак нахождения машины в архиве.", "example": false }, "true_price": { "type": "number", "description": "Устаревшая стоимость приоритетного показа.", "format": "decimal", "deprecated": true, "x-deprecatedMessage": "Выпилить после задачи мобилок https://kaiten.ati.st/space/47/card/128402", "example": 10 }, "true_currency_id": { "type": "integer", "description": "Устаревший идентификатор валюты стоимости приоритетного показа.", "format": "int32", "deprecated": true, "x-deprecatedMessage": "Выпилить после задачи мобилок https://kaiten.ati.st/space/47/card/128402", "example": 1 } } } ] }, "TruckForInsertV1Request": { "allOf": [ { "$ref": "#/components/schemas/BaseTruckV1Request" }, { "type": "object", "description": "Данные для создания или восстановления машины.", "additionalProperties": false } ] }, "LegacyCommentView": { "type": "object", "description": "Комментарий к машине в интеграторском контракте v1.", "additionalProperties": false, "properties": { "id": { "type": "integer", "description": "Числовой идентификатор комментария.", "format": "int32", "example": 42 }, "message": { "type": "string", "description": "Текст комментария.", "example": "Машина готова к загрузке" }, "contact_id": { "type": "integer", "description": "Идентификатор автора комментария.", "format": "int32", "example": 123456 }, "truck_id": { "type": "string", "description": "Идентификатор машины.", "format": "guid", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "contact_name": { "type": "string", "description": "Имя автора комментария.", "nullable": true, "example": "Иван Иванов" }, "comment_date_time": { "type": "string", "description": "Дата и время создания комментария.", "format": "date-time", "example": "2026-08-17T08:30:00Z" }, "comment_id": { "type": "string", "description": "Устаревший идентификатор комментария; совпадает с идентификатором машины.", "format": "guid", "deprecated": true, "x-deprecatedMessage": "use Id instead", "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } }, "TruckCounters": { "type": "object", "description": "Счётчики опубликованных и архивных машин.", "additionalProperties": false, "properties": { "firm_trucks_count": { "type": "integer", "description": "Количество опубликованных машин фирмы.", "format": "int32", "example": 10 }, "contact_trucks_count": { "type": "integer", "description": "Количество опубликованных машин контакта.", "format": "int32", "nullable": true, "example": 3 }, "unpublished_firm_trucks_count": { "type": "integer", "description": "Количество архивных машин фирмы.", "format": "int32", "nullable": true, "example": 5 }, "unpublished_contact_trucks_count": { "type": "integer", "description": "Количество архивных машин контакта.", "format": "int32", "nullable": true, "example": 2 }, "responses_for_contact_count": { "type": "integer", "description": "Количество откликов на машины контакта.", "format": "int32", "nullable": true, "example": 4 }, "responses_for_firm_count": { "type": "integer", "description": "Количество откликов на машины фирмы.", "format": "int32", "nullable": true, "example": 8 } } }, "UserAccessToAddTruckSummary": { "type": "object", "description": "Состояние доступа пользователя к добавлению машин.", "additionalProperties": false, "properties": { "access": { "description": "Устаревший числовой код состояния доступа; используйте Error и Reason.", "deprecated": true, "x-deprecatedMessage": "Необходимо завязываться на поле Error", "example": 0, "allOf": [ { "$ref": "#/components/schemas/trucks-api__OperationStatus" } ] }, "can_add_own_truck": { "type": "boolean", "description": "Признак возможности добавлять собственные машины.", "example": true }, "can_add_other_truck": { "type": "boolean", "description": "Признак возможности добавлять машины других владельцев.", "example": false }, "error": { "type": "string", "description": "Код причины недоступности добавления; null, если доступ разрешён.", "nullable": true, "example": "limit_exceeded" }, "reason": { "type": "string", "description": "Описание причины недоступности добавления; null, если доступ разрешён.", "nullable": true, "example": "Превышен лимит машин" } } }, "ObsoleteSuccessView": { "type": "object", "description": "Результат успешной legacy-операции.", "additionalProperties": false, "properties": { "success": { "type": "boolean", "description": "Признак успешного выполнения операции.", "example": true } } }, "TruckForUpdateV1Request": { "allOf": [ { "$ref": "#/components/schemas/TruckForInsertV1Request" }, { "type": "object", "description": "Данные для редактирования опубликованной машины.", "additionalProperties": false } ] }, "PriorityDtoRequest": { "type": "object", "description": "Настройки приоритетного показа машины.", "additionalProperties": false, "required": [ "view_rate" ], "properties": { "view_rate": { "type": "number", "description": "Ставка за просмотр", "format": "decimal", "example": 10 }, "order_limit": { "type": "number", "description": "Лимит на заявку", "format": "decimal", "example": 500 }, "daily_limit": { "type": "number", "description": "Суточный лимит списания по услуге", "format": "decimal", "example": 1000 }, "is_for_payed_only": { "type": "boolean", "description": "Показывать приоритетный показ только платным пользователям", "example": false } } }, "BaseTruckV1": { "type": "object", "description": "Основные данные машины в интеграторском контракте v1.", "additionalProperties": false, "properties": { "contact_id1": { "type": "integer", "description": "Идентификатор основного контакта, управляющего машиной.", "format": "int32", "example": 123456 }, "contact_id2": { "type": "integer", "description": "Идентификатор дополнительного контакта, управляющего машиной.", "format": "int32", "nullable": true, "example": 123457 }, "department_id": { "type": "integer", "description": "Идентификатор подразделения, к которому относится машина.", "format": "int32", "nullable": true, "example": 10 }, "note": { "type": "string", "description": "Комментарий владельца к машине.", "example": "Тент, готов к загрузке" }, "first_date": { "type": "string", "description": "Начало периода доступности машины. Обязательно при date_type = 1.", "format": "date-time", "example": "2026-08-17T08:00:00Z" }, "last_date": { "type": "string", "description": "Окончание периода доступности машины. Обязательно при date_type = 1.", "format": "date-time", "example": "2026-08-18T18:00:00Z" }, "periodicity_id": { "type": "integer", "description": "Код периодичности публикации. Используется при date_type = 2.", "format": "int32", "example": 0 }, "date_type": { "type": "integer", "description": "Тип периода доступности машины. Если не указан, используется значение 0.", "format": "int32", "example": 0 }, "is_team_driving": { "type": "boolean", "description": "Признак работы экипажа из двух водителей.", "nullable": true, "example": false }, "transport": { "description": "Параметры кузова и грузоподъёмности машины.", "allOf": [ { "$ref": "#/components/schemas/TruckParams" } ] }, "loading": { "description": "География загрузки машины.", "allOf": [ { "$ref": "#/components/schemas/TruckLoading" } ] }, "payment": { "description": "Условия оплаты.", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/TruckPaymentV1" } ] }, "priority": { "description": "Настройки и состояние приоритетного показа.", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/PriorityBo" } ] }, "stealth": { "description": "Настройки скрытия машины от выбранных фирм.", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/StealthDto" } ] }, "unloading": { "description": "География разгрузки машины.", "allOf": [ { "$ref": "#/components/schemas/TruckUnloading" } ] } } }, "trucks-api__ArchiveReason": { "type": "string", "description": "Причина переноса машины в архив: unknown — не указана; system — системная; manual — вручную;\ncomplaints — жалобы; unwanted_content — нежелательный контент; firm_is_banned — фирма заблокирована.\n - `0` — Не указана\n - `1` — Системная\n - `2` — Вручную\n - `3` — Жалобы\n - `4` — Нежелательный контент\n - `5` — Фирма заблокирована", "x-enumNames": [ "Unknown", "System", "Manual", "Complaints", "UnwantedContent", "FirmIsBanned" ], "enum": [ "unknown", "system", "manual", "complaints", "unwanted_content", "firm_is_banned" ] }, "trucks-api__OperationStatus": { "type": "integer", "description": "Код результата legacy-операции: 0 — успешно; 1 — у фирмы нет доступа; 2 — контакту запрещён доступ;\n3 — превышен лимит; 4 — не истёк интервал обновления; 5 — значение справочника не найдено;\n6 — комментарий не найден; 7 — машина не найдена; 8 — ошибка авторизации; 9 — ошибка десериализации;\n10 — ошибка проверки JSON; 11 — ошибка проверки запроса; 12 — машины объединены;\n13 — найдена дублирующая машина; 14 — контакт не найден; 15 — не истёк интервал архивирования;\n16 — неверное подразделение контакта.\n - `0` — Успешно\n - `1` — У фирмы нет доступа\n - `2` — Контакту запрещён доступ\n - `3` — Превышен лимит\n - `4` — Не истёк интервал обновления\n - `5` — Значение справочника не найдено\n - `6` — Комментарий не найден\n - `7` — Машина не найдена\n - `8` — Ошибка авторизации\n - `9` — Ошибка десериализации\n - `10` — Ошибка проверки JSON\n - `11` — Ошибка проверки запроса\n - `12` — Машины объединены\n - `13` — Найдена дублирующая машина\n - `14` — Контакт не найден\n - `15` — Не истёк интервал архивирования\n - `16` — Неверное подразделение контакта", "x-enumNames": [ "None", "FirmDoesNotHaveAccess", "ContactAccessDeniedError", "LimitExceededError", "TruckRenewDelayNotElapsedError", "DictionaryElementNotFoundError", "TruckCommentNotFoundError", "TruckNotFoundError", "AuthError", "DeserializationError", "JsonValidationError", "RequestValidationError", "TruckMerge", "TruckDuplicate", "ContactNotFoundError", "ArchiveDelayNotElapsedError", "ContactDepartmentIdError" ], "enum": [ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] }, "BaseTruckV1Request": { "type": "object", "description": "Основные данные машины в интеграторском контракте v1.", "additionalProperties": false, "required": [ "contact_id1", "transport", "loading", "unloading" ], "properties": { "contact_id1": { "type": "integer", "description": "Идентификатор основного контакта, управляющего машиной.", "format": "int32", "example": 123456 }, "contact_id2": { "type": "integer", "description": "Идентификатор дополнительного контакта, управляющего машиной.", "format": "int32", "nullable": true, "example": 123457 }, "department_id": { "type": "integer", "description": "Идентификатор подразделения, к которому относится машина.", "format": "int32", "nullable": true, "example": 10 }, "note": { "type": "string", "description": "Комментарий владельца к машине.", "example": "Тент, готов к загрузке" }, "first_date": { "type": "string", "description": "Начало периода доступности машины. Обязательно при date_type = 1.", "format": "date-time", "example": "2026-08-17T08:00:00Z" }, "last_date": { "type": "string", "description": "Окончание периода доступности машины. Обязательно при date_type = 1.", "format": "date-time", "example": "2026-08-18T18:00:00Z" }, "periodicity_id": { "type": "integer", "description": "Код периодичности публикации. Используется при date_type = 2.", "format": "int32", "example": 0 }, "date_type": { "type": "integer", "description": "Тип периода доступности машины. Если не указан, используется значение 0.", "format": "int32", "example": 0 }, "is_team_driving": { "type": "boolean", "description": "Признак работы экипажа из двух водителей.", "nullable": true, "example": false }, "transport": { "description": "Параметры кузова и грузоподъёмности машины.", "allOf": [ { "$ref": "#/components/schemas/TruckParamsRequest" } ] }, "loading": { "description": "География загрузки машины.", "allOf": [ { "$ref": "#/components/schemas/TruckLoadingRequest" } ] }, "payment": { "description": "Условия оплаты.", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/TruckPaymentV1" } ] }, "priority": { "description": "Настройки и состояние приоритетного показа.", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/PriorityBoRequest" } ] }, "stealth": { "description": "Настройки скрытия машины от выбранных фирм.", "nullable": true, "allOf": [ { "$ref": "#/components/schemas/StealthDto" } ] }, "unloading": { "description": "География разгрузки машины.", "allOf": [ { "$ref": "#/components/schemas/TruckUnloadingRequest" } ] } } }, "TruckParams": { "type": "object", "description": "Параметры кузова и грузоподъёмности машины.", "additionalProperties": false, "properties": { "car_type": { "type": "integer", "description": "Идентификатор типа кузова из [справочника ATI.SU](https://ati.su/developers/api/dictionaries/trucks/).", "format": "int64", "example": 1 }, "car_type_mask": { "type": "integer", "description": "Битовая маска типов кузова.", "format": "int64", "example": 1 }, "body_type": { "description": "Тип состава транспортного средства.", "example": 2, "allOf": [ { "$ref": "#/components/schemas/trucks-api__BodyType" } ] }, "loading_type": { "type": "integer", "description": "Идентификатор типа загрузки из [справочника ATI.SU](https://ati.su/developers/api/dictionaries/trucks/).", "format": "int32", "example": 1 }, "weight": { "type": "number", "description": "Грузоподъёмность машины в тоннах.", "format": "decimal", "example": 20 }, "volume": { "type": "number", "description": "Объём кузова машины в кубических метрах. Для типов кузова, допускающих отсутствие объёма, поле можно не передавать.", "format": "decimal", "example": 82 }, "truck_length": { "type": "number", "description": "Длина кузова грузовика в метрах.", "format": "decimal", "example": 7.2 }, "truck_width": { "type": "number", "description": "Ширина кузова грузовика в метрах.", "format": "decimal", "example": 2.45 }, "truck_height": { "type": "number", "description": "Высота кузова грузовика в метрах.", "format": "decimal", "example": 2.7 }, "trailer_length": { "type": "number", "description": "Длина прицепа в метрах.", "format": "decimal", "example": 13.6 }, "trailer_width": { "type": "number", "description": "Ширина прицепа в метрах.", "format": "decimal", "example": 2.45 }, "trailer_height": { "type": "number", "description": "Высота прицепа в метрах.", "format": "decimal", "example": 2.7 }, "hydrolift": { "type": "boolean", "description": "Признак наличия гидроборта.", "example": false }, "partial_load": { "type": "boolean", "description": "Признак готовности перевозить догруз.", "example": false }, "koniki": { "type": "boolean", "description": "Признак наличия коников для перевозки длинномерных грузов.", "example": false }, "tir": { "type": "boolean", "description": "Признак наличия допуска TIR.", "example": false }, "ekmt": { "type": "boolean", "description": "Признак наличия разрешения ЕКМТ.", "example": false }, "adr": { "type": "integer", "description": "Устаревшая категория допуска ADR; используйте поле ADRTypes.", "format": "int32", "deprecated": true, "x-deprecatedMessage": "Актуальная информация в поле ADRTypes", "example": 0 }, "adr_types": { "type": "integer", "description": "Битовая маска категорий допуска ADR.", "format": "int32", "example": 0 }, "is_tracking": { "type": "boolean", "description": "Признак подключения мониторинга местоположения машины.", "example": false } } }, "TruckLoading": { "type": "object", "description": "География загрузки машины.", "additionalProperties": false, "properties": { "city_id": { "type": "integer", "description": "Идентификатор города загрузки", "format": "int32", "example": 3611 }, "radius": { "type": "integer", "description": "Радиус загрузки в км", "format": "int32", "example": 50 }, "region_id": { "type": "integer", "description": "Идентификатор региона загрузки", "format": "int32", "nullable": true, "example": 77 }, "country_id": { "type": "integer", "description": "Идентификатор страны загрузки", "format": "int32", "nullable": true, "example": 1 } } }, "TruckPaymentV1": { "type": "object", "description": "Условия оплаты в интеграторском контракте v1.", "additionalProperties": false, "properties": { "rate_sum": { "type": "number", "description": "Ставка за перевозку.", "format": "decimal", "example": 50000 }, "currency_id": { "type": "integer", "description": "Идентификатор валюты из [справочника ATI.SU](https://ati.su/developers/api/dictionaries/trucks/).", "format": "int32", "example": 1 }, "cashless": { "type": "boolean", "description": "Признак возможности безналичной оплаты.", "example": true }, "nds": { "type": "boolean", "description": "Признак включения НДС в ставку.", "example": true }, "card": { "type": "boolean", "description": "Признак возможности оплаты картой АТИ.", "example": false }, "nal": { "type": "boolean", "description": "Признак возможности оплаты наличными.", "example": false } } }, "PriorityBo": { "type": "object", "description": "Состояние и лимиты приоритетного показа машины.", "additionalProperties": false, "properties": { "status": { "description": "Статус приоритетного показа", "example": 1, "allOf": [ { "$ref": "#/components/schemas/PriorityStatus" } ] }, "view_rate": { "type": "number", "description": "Ставка за просмотр", "format": "decimal", "example": 10 }, "order_limit": { "type": "number", "description": "Лимит на заявку", "format": "decimal", "example": 500 }, "daily_limit": { "type": "number", "description": "Суточный лимит списания по услуге", "format": "decimal", "example": 1000 }, "is_for_payed_only": { "type": "boolean", "description": "Показывать приоритетный показ только платным пользователям", "example": false }, "money_spent_per_day": { "type": "number", "description": "Деньги потраченные на машину за день", "format": "decimal", "example": 100 }, "money_spent_per_order": { "type": "number", "description": "Деньги потраченные на машину за заявку", "format": "decimal", "example": 20 } } }, "StealthDto": { "type": "object", "description": "Настройки скрытия машины от выбранных фирм.", "additionalProperties": false, "properties": { "rating": { "type": "integer", "description": "Минимальный рейтинг фирмы", "format": "int32", "nullable": true, "example": 5 }, "registration_date": { "type": "string", "description": "Минимальная дата регистрации фирмы", "format": "date-time", "nullable": true, "example": "2020-01-15T00:00:00Z" }, "firm_list": { "type": "string", "description": "Список фирм для скрытия машины", "format": "guid", "nullable": true, "example": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } } }, "TruckUnloading": { "type": "object", "description": "География разгрузки машины.", "additionalProperties": false, "properties": { "point_type": { "type": "integer", "description": "Тип гео объекта разгрузки\nЕсли не указан, используется значение 0 — страна", "format": "int32", "example": 1 }, "point_id": { "type": "integer", "description": "Идентификатор гео объекта", "format": "int32", "example": 3611 }, "radius": { "type": "integer", "description": "Радиус разгрузки", "format": "int32", "example": 50 }, "additional_points": { "type": "array", "description": "Доподнительные точки разгрузки", "example": [], "items": { "$ref": "#/components/schemas/AdditionalUnloadingPoint" } }, "region_id": { "type": "integer", "description": "Идентификатор региона разгрузки", "format": "int32", "nullable": true, "example": 77 }, "country_id": { "type": "integer", "description": "Идентификатор страны разгрузки", "format": "int32", "nullable": true, "example": 1 } } }, "TruckParamsRequest": { "type": "object", "description": "Параметры кузова и грузоподъёмности машины.", "additionalProperties": false, "required": [ "car_type", "body_type", "weight" ], "properties": { "car_type": { "type": "integer", "description": "Идентификатор типа кузова из [справочника ATI.SU](https://ati.su/developers/api/dictionaries/trucks/).", "format": "int64", "example": 1 }, "car_type_mask": { "type": "integer", "description": "Битовая маска типов кузова.", "format": "int64", "example": 1 }, "body_type": { "description": "Тип состава транспортного средства.", "example": 2, "allOf": [ { "$ref": "#/components/schemas/trucks-api__BodyType" } ] }, "loading_type": { "type": "integer", "description": "Идентификатор типа загрузки из [справочника ATI.SU](https://ati.su/developers/api/dictionaries/trucks/).", "format": "int32", "example": 1 }, "weight": { "type": "number", "description": "Грузоподъёмность машины в тоннах.", "format": "decimal", "example": 20 }, "volume": { "type": "number", "description": "Объём кузова машины в кубических метрах. Для типов кузова, допускающих отсутствие объёма, поле можно не передавать.", "format": "decimal", "example": 82 }, "truck_length": { "type": "number", "description": "Длина кузова грузовика в метрах.", "format": "decimal", "example": 7.2 }, "truck_width": { "type": "number", "description": "Ширина кузова грузовика в метрах.", "format": "decimal", "example": 2.45 }, "truck_height": { "type": "number", "description": "Высота кузова грузовика в метрах.", "format": "decimal", "example": 2.7 }, "trailer_length": { "type": "number", "description": "Длина прицепа в метрах.", "format": "decimal", "example": 13.6 }, "trailer_width": { "type": "number", "description": "Ширина прицепа в метрах.", "format": "decimal", "example": 2.45 }, "trailer_height": { "type": "number", "description": "Высота прицепа в метрах.", "format": "decimal", "example": 2.7 }, "hydrolift": { "type": "boolean", "description": "Признак наличия гидроборта.", "example": false }, "partial_load": { "type": "boolean", "description": "Признак готовности перевозить догруз.", "example": false }, "koniki": { "type": "boolean", "description": "Признак наличия коников для перевозки длинномерных грузов.", "example": false }, "tir": { "type": "boolean", "description": "Признак наличия допуска TIR.", "example": false }, "ekmt": { "type": "boolean", "description": "Признак наличия разрешения ЕКМТ.", "example": false }, "adr": { "type": "integer", "description": "Устаревшая категория допуска ADR; используйте поле ADRTypes.", "format": "int32", "deprecated": true, "x-deprecatedMessage": "Актуальная информация в поле ADRTypes", "example": 0 }, "adr_types": { "type": "integer", "description": "Битовая маска категорий допуска ADR.", "format": "int32", "example": 0 }, "is_tracking": { "type": "boolean", "description": "Признак подключения мониторинга местоположения машины.", "example": false } } }, "TruckLoadingRequest": { "type": "object", "description": "География загрузки машины.", "additionalProperties": false, "required": [ "city_id" ], "properties": { "city_id": { "type": "integer", "description": "Идентификатор города загрузки", "format": "int32", "example": 3611 }, "radius": { "type": "integer", "description": "Радиус загрузки в км", "format": "int32", "example": 50 }, "region_id": { "type": "integer", "description": "Идентификатор региона загрузки", "format": "int32", "nullable": true, "example": 77 }, "country_id": { "type": "integer", "description": "Идентификатор страны загрузки", "format": "int32", "nullable": true, "example": 1 } } }, "PriorityBoRequest": { "type": "object", "description": "Состояние и лимиты приоритетного показа машины.", "additionalProperties": false, "properties": { "status": { "description": "Статус приоритетного показа", "example": 1, "allOf": [ { "$ref": "#/components/schemas/PriorityStatus" } ] }, "view_rate": { "type": "number", "description": "Ставка за просмотр", "format": "decimal", "example": 10 }, "order_limit": { "type": "number", "description": "Лимит на заявку", "format": "decimal", "example": 500 }, "daily_limit": { "type": "number", "description": "Суточный лимит списания по услуге", "format": "decimal", "example": 1000 }, "is_for_payed_only": { "type": "boolean", "description": "Показывать приоритетный показ только платным пользователям", "example": false }, "money_spent_per_day": { "type": "number", "description": "Деньги потраченные на машину за день", "format": "decimal", "example": 100 }, "money_spent_per_order": { "type": "number", "description": "Деньги потраченные на машину за заявку", "format": "decimal", "example": 20 } } }, "TruckUnloadingRequest": { "type": "object", "description": "География разгрузки машины.", "additionalProperties": false, "required": [ "point_id" ], "properties": { "point_type": { "type": "integer", "description": "Тип гео объекта разгрузки\nЕсли не указан, используется значение 0 — страна", "format": "int32", "example": 1 }, "point_id": { "type": "integer", "description": "Идентификатор гео объекта", "format": "int32", "example": 3611 }, "radius": { "type": "integer", "description": "Радиус разгрузки", "format": "int32", "example": 50 }, "additional_points": { "type": "array", "description": "Доподнительные точки разгрузки", "example": [], "items": { "$ref": "#/components/schemas/AdditionalUnloadingPointRequest" } }, "region_id": { "type": "integer", "description": "Идентификатор региона разгрузки", "format": "int32", "nullable": true, "example": 77 }, "country_id": { "type": "integer", "description": "Идентификатор страны разгрузки", "format": "int32", "nullable": true, "example": 1 } } }, "trucks-api__BodyType": { "type": "integer", "description": "Тип состава транспортного средства: 0 — не указан; 1 — грузовик; 2 — полуприцеп; 4 — прицеп.\n - `0` — Не указан\n - `1` — Грузовик\n - `2` — Полуприцеп\n - `4` — Прицеп", "x-enumNames": [ "None", "Truck", "SemiTruck", "Trailer" ], "enum": [ 0, 1, 2, 4 ] }, "PriorityStatus": { "type": "integer", "description": "Состояние приоритетного показа: 0 — выключен; 1 — включён; 2 — недостаточно средств;\n3 — превышен лимит заявки; 4 — превышен суточный лимит; 5 — платежи недоступны контакту.\n - `0` — Выключен до реализации PriorityStatus (по полю IsSwitchedOn = false, использовавшемся ранее)\n - `1` — Включен\n - `2` — Недостаточно средств для оплаты просмотра\n - `3` — Превышен лимит на просмотр\n - `4` — Превышен дневной лимит на просмотр\n - `5` — Использование кошелька запрещено для пользователя", "x-enumNames": [ "Disabled", "Enabled", "LowBalance", "OrderLimitExceeded", "DayLimitExceeded", "VirtualPaymentsDisabledForContact" ], "enum": [ 0, 1, 2, 3, 4, 5 ] }, "AdditionalUnloadingPoint": { "type": "object", "description": "Дополнительная точка разгрузки машины.", "additionalProperties": false, "properties": { "rate_sum": { "type": "number", "description": "Ставка", "format": "decimal", "example": 1500.5 }, "point_type": { "type": "integer", "description": "Тип гео объекта разгрузки\nЕсли не указан, используется значение 0 — страна", "format": "int32", "example": 1 }, "point_id": { "type": "integer", "description": "Идентификатор точки загрузки", "format": "int32", "example": 3611 }, "radius": { "type": "integer", "description": "Радиус, в котором машина может быть разгружена, в км", "format": "int32", "example": 50 }, "currency_id": { "type": "integer", "description": "Идентификатор вальты", "format": "int32", "example": 1 }, "money_type": { "type": "integer", "description": "Тип ставки", "format": "int32", "example": 1 }, "region_id": { "type": "integer", "description": "Идентификатор региона разгрузки", "format": "int32", "nullable": true, "example": 77 }, "country_id": { "type": "integer", "description": "Идентификатор страны разгрузки", "format": "int32", "example": 1 } } }, "AdditionalUnloadingPointRequest": { "type": "object", "description": "Дополнительная точка разгрузки машины.", "additionalProperties": false, "required": [ "point_id" ], "properties": { "rate_sum": { "type": "number", "description": "Ставка", "format": "decimal", "example": 1500.5 }, "point_type": { "type": "integer", "description": "Тип гео объекта разгрузки\nЕсли не указан, используется значение 0 — страна", "format": "int32", "example": 1 }, "point_id": { "type": "integer", "description": "Идентификатор точки загрузки", "format": "int32", "example": 3611 }, "radius": { "type": "integer", "description": "Радиус, в котором машина может быть разгружена, в км", "format": "int32", "example": 50 }, "currency_id": { "type": "integer", "description": "Идентификатор вальты", "format": "int32", "example": 1 }, "money_type": { "type": "integer", "description": "Тип ставки", "format": "int32", "example": 1 }, "region_id": { "type": "integer", "description": "Идентификатор региона разгрузки", "format": "int32", "nullable": true, "example": 77 }, "country_id": { "type": "integer", "description": "Идентификатор страны разгрузки", "format": "int32", "example": 1 } } }, "TruckIdUuid": { "title": "truck_id", "type": "string", "format": "uuid", "description": "ID машины (truck_id)." }, "TruckIdUuidList": { "type": "array", "description": "Массив UUID.", "items": { "$ref": "#/components/schemas/TruckIdUuid" } }, "UnviewedCounterOffersCountByTruckResponse": { "type": "object", "description": "Ключи свойств — строки UUID машин, значения — целые числа.", "additionalProperties": { "type": "integer", "format": "int32" } }, "CreateTruckCounterOfferRequest": { "type": "object", "description": "Тело запроса для создания или изменения встречного предложения", "required": [ "cash_sum", "sum_with_nds", "sum_without_nds", "weight", "volume", "car_delivery_date" ], "properties": { "offerer_contact_id": { "type": "integer", "format": "int32", "nullable": true, "description": "ID контакта автора предложения (если не передан, подставляется текущий контакт)" }, "cash_sum": { "type": "number", "format": "double", "description": "Сумма наличными" }, "currency_id": { "type": "integer", "format": "int32", "nullable": true, "description": "Валюта для наличной суммы. Значение из [словаря валют АТИ](https://ati.su/developers/api/dictionaries/trucks/)" }, "sum_with_nds": { "type": "number", "format": "double", "description": "Сумма с НДС" }, "nds_currency_id": { "type": "integer", "format": "int32", "nullable": true, "description": "Валюта суммы с НДС. Значение из [словаря валют АТИ](https://ati.su/developers/api/dictionaries/trucks/)" }, "sum_without_nds": { "type": "number", "format": "double", "description": "Сумма без НДС" }, "not_nds_currency_id": { "type": "integer", "format": "int32", "nullable": true, "description": "Валюта суммы без НДС. Значение из [словаря валют АТИ](https://ati.su/developers/api/dictionaries/trucks/)" }, "note": { "type": "string", "nullable": true, "description": "Комментарий к предложению. Максимальное количество символов 512" }, "prepay_percent": { "type": "integer", "format": "int32", "nullable": true, "description": "Процент предоплаты" }, "delay_payment_days": { "type": "integer", "format": "int32", "nullable": true, "description": "Отсрочка оплаты в банковских днях" }, "loading_city_id": { "type": "integer", "format": "int64", "nullable": true, "description": "ID города погрузки. Значение из [словаря городов АТИ](https://ati.su/developers/api/dictionaries/geo/)" }, "unloading_city_id": { "type": "integer", "format": "int64", "nullable": true, "description": "ID города выгрузки. Значение из [словаря городов АТИ](https://ati.su/developers/api/dictionaries/geo/)" }, "weight": { "type": "number", "format": "double", "description": "Максимальная грузоподъемность, т" }, "volume": { "type": "number", "format": "double", "description": "Максимальный объем, м3" }, "car_delivery_date": { "type": "string", "format": "date-time", "description": "Дата подачи машины. При передаче времени учитывается только дата." }, "unload_payment": { "type": "boolean", "nullable": true, "description": "Оплата на выгрузке" }, "coloading": { "type": "boolean", "nullable": true, "description": "Разрешена догрузка" } } }, "CounterOffersByTruckIdsView": { "type": "object", "description": "Словарь отзывов по ID машин", "x-dictionary-key-name": "truck_id", "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/CounterOfferWithSenderView" } } }, "CounterOfferWithSenderView": { "allOf": [ { "$ref": "#/components/schemas/CounterOfferViewBase" }, { "type": "object", "properties": { "sender_firm_info": { "description": "Информация о фирме, оставившей встречное предложение", "$ref": "#/components/schemas/FirmSummary" } } } ] }, "CounterOfferViewBase": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "description": "Id встречного предложения" }, "truck_id": { "type": "string", "format": "uuid", "description": "Id машины" }, "addition_date": { "type": "string", "format": "date-time", "description": "Дата добавления встречного предложения" }, "change_date": { "type": "string", "format": "date-time", "description": "Дата изменения встречного предложения" }, "viewed_at": { "type": "string", "format": "date-time", "nullable": true, "description": "Дата и время просмотра встречного предложения" }, "cash_sum": { "type": "number", "format": "double", "nullable": true, "description": "Ставка наличными" }, "currency_id": { "type": "integer", "format": "int32", "nullable": true, "description": "Валюта ставки наличными. Значение из [словаря валют АТИ](https://ati.su/developers/api/dictionaries/trucks/)" }, "sum_with_nds": { "type": "number", "format": "double", "nullable": true, "description": "Ставка с НДС" }, "nds_currency_id": { "type": "integer", "format": "int32", "nullable": true, "description": "Валюта ставки с НДС. Значение из [словаря валют АТИ](https://ati.su/developers/api/dictionaries/trucks/)" }, "sum_without_nds": { "type": "number", "format": "double", "nullable": true, "description": "Ставка без НДС" }, "not_nds_currency_id": { "type": "integer", "format": "int32", "nullable": true, "description": "Валюта ставки без НДС. Значение из [словаря валют АТИ](https://ati.su/developers/api/dictionaries/trucks/)" }, "note": { "type": "string", "nullable": true, "description": "Комментарий к предложению. Максимальное количество символов 512" }, "prepay_percent": { "type": "integer", "format": "int32", "nullable": true, "description": "Предоплата в процентах" }, "delay_payment_days": { "type": "integer", "format": "int32", "nullable": true, "description": "Оплата через банковских дней" }, "loading_city_id": { "type": "integer", "format": "int64", "nullable": true, "description": "Id города загрузки. Значение из [словаря городов АТИ](https://ati.su/developers/api/dictionaries/geo/)" }, "unloading_city_id": { "type": "integer", "format": "int64", "nullable": true, "description": "Id города разгрузки. Значение из [словаря городов АТИ](https://ati.su/developers/api/dictionaries/geo/)" }, "weight": { "type": "number", "format": "double", "nullable": true, "description": "Максимальная грузоподъемность, т" }, "volume": { "type": "number", "format": "double", "nullable": true, "description": "Максимальный объем, м3" }, "car_delivery_date": { "type": "string", "format": "date-time", "description": "Дата подачи транспорта" }, "is_actual": { "type": "boolean", "description": "Актуальность встречного предложения" }, "unload_payment": { "type": "boolean", "description": "Оплата на выгрузке" }, "coloading": { "type": "boolean", "description": "Догруз" } } }, "FirmSummary": { "type": "object", "properties": { "ati_id": { "type": "string", "description": "ATI ID контакта" }, "contact_id": { "type": "integer", "format": "int32", "description": "Id контакта" }, "firm_id": { "type": "integer", "format": "int32", "description": "Id фирмы" }, "contact": { "description": "Краткая информация о контакте", "$ref": "#/components/schemas/FirmContactSummary" }, "name": { "type": "string", "description": "Название фирмы" }, "score": { "type": "number", "format": "double", "description": "Рейтинг фирмы" }, "status": { "type": "integer", "format": "int32", "description": "Статус фирмы" } } }, "FirmContactSummary": { "type": "object", "properties": { "firm_id": { "type": "integer", "format": "int32", "description": "Id фирмы" }, "ati_id": { "type": "string", "description": "ATI ID контакта" }, "contact_id": { "type": "integer", "format": "int32", "description": "Id контакта" }, "name": { "type": "string", "nullable": true, "description": "Имя контакта" }, "phone": { "type": "string", "nullable": true, "description": "Телефон" }, "mobile_phone": { "type": "string", "nullable": true, "description": "Мобильный телефон" }, "claims_count": { "type": "integer", "format": "int32", "description": "Количество претензий" }, "recommendations_count": { "type": "integer", "format": "int32", "description": "Количество рекомендаций" }, "bad_partner_mentions_count": { "type": "integer", "format": "int32", "description": "Количество упоминаний в НП" }, "city": { "type": "string", "nullable": true, "description": "Город" }, "firm_type": { "type": "string", "nullable": true, "description": "Тип фирмы" }, "firm_name": { "type": "string", "nullable": true, "description": "Название фирмы" }, "ownership": { "type": "string", "nullable": true, "description": "Форма собственности" }, "score": { "type": "number", "format": "double", "description": "Рейтинг контакта" }, "status": { "type": "integer", "format": "int32", "description": "Статус контакта" }, "skype_name": { "type": "string", "nullable": true, "description": "Skype" }, "fax": { "type": "string", "nullable": true, "description": "Факс" }, "email": { "type": "string", "nullable": true, "description": "E-mail" } } }, "CommonErrorDetail": { "type": "object", "properties": { "property": { "type": "string", "description": "Имя поля в теле запроса, к которому относится ошибка." }, "reason": { "type": "string", "description": "Текстовое описание нарушения для этого поля (например, неверный формат или диапазон)." } } }, "CommonError": { "type": "object", "properties": { "error": { "type": "string", "description": "Ключ ошибки (идентификатор сценария отказа или типа сбоя)." }, "reason": { "type": "string", "description": "Пояснение: что не так с запросом и при валидации — какие ограничения нарушены." }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/CommonErrorDetail" }, "description": "Ошибки валидации по полям: каждый элемент соответствует одному полю JSON-тела." } } }, "YourCounterOffersCountView": { "type": "object", "properties": { "active_count": { "type": "integer", "format": "int32", "description": "Количество активных встречных предложений" }, "has_counter_offers": { "type": "boolean", "description": "Есть ли встречные предложения по машине" }, "unviewed_count": { "type": "integer", "format": "int32", "description": "Количество непросмотренных встречных предложений" } } }, "ArchiveCounterOffersCountView": { "type": "object", "properties": { "has_counter_offers": { "type": "boolean", "description": "Есть ли встречные предложения по архивной машине" } } }, "activities__ExceptionResult": { "description": "Возвращаемое значение в случае ошибок", "properties": { "Code": { "description": "Код ошибки", "type": "string" }, "Message": { "description": "Текст ошибки", "type": "string" } }, "type": "object" }, "UserSiteActivityStatisticItem": { "properties": { "stats": { "additionalProperties": { "type": "integer" }, "type": "object" }, "zone": { "enum": [ 1, 2, 4, 8, 16, 32, 63, 64, 128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536, 131072, 262144, 524288, 1048576 ], "format": "int32", "type": "integer" } }, "type": "object" }, "UserSiteActivityStatistics": { "properties": { "atiId": { "type": "string" }, "statisticItems": { "properties": { "addForumMsg": { "$ref": "#/components/schemas/UserSiteActivityStatisticItem" }, "addLoad": { "$ref": "#/components/schemas/UserSiteActivityStatisticItem" }, "addTruck": { "$ref": "#/components/schemas/UserSiteActivityStatisticItem" }, "all": { "$ref": "#/components/schemas/UserSiteActivityStatisticItem" }, "auctionParticipated": { "$ref": "#/components/schemas/UserSiteActivityStatisticItem" }, "auctionWon": { "$ref": "#/components/schemas/UserSiteActivityStatisticItem" }, "dealsDeclined": { "$ref": "#/components/schemas/UserSiteActivityStatisticItem" }, "dealsDeclinedByMe": { "$ref": "#/components/schemas/UserSiteActivityStatisticItem" }, "dealsFinished": { "$ref": "#/components/schemas/UserSiteActivityStatisticItem" }, "exclusiveLoadsCount": { "$ref": "#/components/schemas/UserSiteActivityStatisticItem" }, "firmParticipationsCount": { "$ref": "#/components/schemas/UserSiteActivityStatisticItem" }, "forum": { "$ref": "#/components/schemas/UserSiteActivityStatisticItem" }, "loadSearch": { "$ref": "#/components/schemas/UserSiteActivityStatisticItem" }, "loadsCount": { "$ref": "#/components/schemas/UserSiteActivityStatisticItem" }, "other": { "$ref": "#/components/schemas/UserSiteActivityStatisticItem" }, "ownAuctionFinished": { "$ref": "#/components/schemas/UserSiteActivityStatisticItem" }, "ownDealsDeclined": { "$ref": "#/components/schemas/UserSiteActivityStatisticItem" }, "ownDealsDeclinedByMe": { "$ref": "#/components/schemas/UserSiteActivityStatisticItem" }, "ownDealsFinished": { "$ref": "#/components/schemas/UserSiteActivityStatisticItem" }, "tender": { "$ref": "#/components/schemas/UserSiteActivityStatisticItem" }, "truckSearch": { "$ref": "#/components/schemas/UserSiteActivityStatisticItem" }, "usersCountOnFirmBoards": { "$ref": "#/components/schemas/UserSiteActivityStatisticItem" } }, "type": "object" } }, "type": "object" }, "HookCreate": { "type": "object", "discriminator": { "propertyName": "subscription_type", "mapping": { "complex": "#/components/schemas/ComplexHookCreate", "normal": "#/components/schemas/NormalHookCreate" } }, "description": "Запрос создания вебхука", "x-abstract": true, "additionalProperties": false, "required": [ "topic", "callback" ], "properties": { "subscription_type": { "description": "Тип подписки вебхука.", "nullable": true, "example": "complex", "oneOf": [ { "$ref": "#/components/schemas/HookSubscriptionType" } ] }, "topic": { "type": "string", "description": "Тема подписки. Допустимые значения — идентификаторы тем из документации вебхуков: https://ati.su/developers/api/webhooks/topics/. Подставляйте имя темы (`cargoes.on_boards`, `catalogs.drivers`, …). Для тем с фильтром дополнительно нужен `subscription_type=complex`", "minLength": 1, "example": "cargoes.on_boards" }, "callback": { "type": "string", "description": "URL", "minLength": 1, "example": "https://example.com/webhook?userId=000000" } }, "oneOf": [ { "$ref": "#/components/schemas/NormalHookCreate" }, { "$ref": "#/components/schemas/ComplexHookCreate" } ] }, "AcceptedView": { "type": "object", "description": "Пустой ответ: операция принята к асинхронному выполнению.", "additionalProperties": false }, "ErrorViewBase": { "type": "object", "description": "Описание ошибки", "x-abstract": true, "additionalProperties": false, "properties": { "error_code": { "type": "string", "description": "Код ошибки.", "example": "not_found" }, "reason": { "type": "string", "description": "Причина ошибки.", "example": "Вебхук с Id '644bdc87dbd6fc3747887c7b' не найден" }, "details": { "description": "Дополнительные параметры" }, "error_list": { "type": "array", "description": "Вложенные ошибки.", "example": [], "items": { "$ref": "#/components/schemas/ErrorViewBase" } } } }, "FailedDistributionView": { "description": "Проваленная отправка сообщения.", "allOf": [ { "$ref": "#/components/schemas/DistributionView" }, { "type": "object", "description": "Проваленная отправка сообщения.", "additionalProperties": false, "properties": { "entity": { "description": "Отправляемая сущность", "nullable": true }, "entity_id": { "type": "string", "description": "Идентификатор отправляемой сущности.", "example": "5710d7a6de0c8b0ee83565b9" }, "action_date": { "type": "string", "description": "Дата события (UTC).", "format": "date-time", "example": "2024-01-15T10:30:00Z" }, "status": { "description": "Идентификатор состояния отправки.", "example": "failed", "oneOf": [ { "$ref": "#/components/schemas/DistributionStatusTypeView" } ] } } } ] }, "HookStatusType": { "type": "string", "description": "Идентификатор состояния вебхука\n - `created` — Создан\n - `verification` — Проверяется\n - `active` — Активен\n - `removed` — Удален\n - `deactivated` — Деактивирован\n\n > Хук деактивируется, если на протяжении нескольких дней ни одна отправка в него не удалась", "x-enumNames": [ "Created", "Verification", "Active", "Removed", "Deactivated" ], "enum": [ "created", "verification", "active", "removed", "deactivated" ] }, "HookStatusView": { "type": "object", "discriminator": { "propertyName": "status", "mapping": { "deactivated": "#/components/schemas/DeactivatedHookStatusView", "active": "#/components/schemas/ActiveHookStatusView", "created": "#/components/schemas/CreatedHookStatusView", "verification": "#/components/schemas/VerificationHookStatusView" } }, "description": "Состояние вебхука", "x-abstract": true, "additionalProperties": false, "properties": { "status": { "description": "Идентификатор состояния вебхука.", "example": "active", "oneOf": [ { "$ref": "#/components/schemas/HookStatusType" } ] } }, "oneOf": [ { "$ref": "#/components/schemas/VerificationHookStatusView" }, { "$ref": "#/components/schemas/CreatedHookStatusView" }, { "$ref": "#/components/schemas/ActiveHookStatusView" }, { "$ref": "#/components/schemas/DeactivatedHookStatusView" } ] }, "HookSubscriptionType": { "type": "string", "description": "Тип подписки вебхука\n - `normal` — Обычная\n - `complex` — С возможностью настройки фильтров", "x-enumNames": [ "Normal", "Complex" ], "enum": [ "normal", "complex" ] }, "NormalHookCreate": { "allOf": [ { "$ref": "#/components/schemas/HookCreate" }, { "type": "object", "additionalProperties": false, "required": [ "topic", "callback" ], "properties": { "subscription_type": { "description": "Тип подписки вебхука.", "nullable": true, "example": "complex", "oneOf": [ { "$ref": "#/components/schemas/HookSubscriptionType" } ] }, "topic": { "type": "string", "description": "Тема подписки. Допустимые значения — идентификаторы тем из документации вебхуков: https://ati.su/developers/api/webhooks/topics/. Подставляйте имя темы (`cargoes.on_boards`, `catalogs.drivers`, …). Для тем с фильтром дополнительно нужен `subscription_type=complex`", "minLength": 1, "example": "cargoes.on_boards" }, "callback": { "type": "string", "description": "URL", "minLength": 1, "example": "https://example.com/webhook?userId=000000" } } } ] }, "ComplexHookCreate": { "allOf": [ { "$ref": "#/components/schemas/HookCreate" }, { "type": "object", "additionalProperties": false, "required": [ "subscription", "topic", "callback" ], "properties": { "subscription_type": { "description": "Тип подписки вебхука.", "nullable": true, "example": "complex", "oneOf": [ { "$ref": "#/components/schemas/HookSubscriptionType" } ] }, "subscription": { "description": "Параметры подписки с возможностью настройки фильтров", "example": { "channel": "cargoes.on_boards", "boards": [ "644bdc87dbd6fc3747887c7b" ] } }, "topic": { "type": "string", "description": "Тема подписки. Допустимые значения — идентификаторы тем из документации вебхуков: https://ati.su/developers/api/webhooks/topics/. Подставляйте имя темы (`cargoes.on_boards`, `catalogs.drivers`, …). Для тем с фильтром дополнительно нужен `subscription_type=complex`", "minLength": 1, "example": "cargoes.on_boards" }, "callback": { "type": "string", "description": "URL", "minLength": 1, "example": "https://example.com/webhook?userId=000000" } } } ] }, "DistributionView": { "type": "object", "description": "Отправка сообщения", "x-abstract": true, "additionalProperties": false, "properties": { "entity_id": { "type": "string", "description": "Идентификатор отправляемой сущности.", "example": "5710d7a6de0c8b0ee83565b9" }, "action_date": { "type": "string", "description": "Дата события (UTC).", "format": "date-time", "example": "2024-01-15T10:30:00Z" }, "status": { "description": "Идентификатор состояния отправки.", "example": "failed", "oneOf": [ { "$ref": "#/components/schemas/DistributionStatusTypeView" } ] } } }, "DistributionStatusTypeView": { "type": "string", "description": "Идентификатор состояния отправки\n - `failed` — Провалена", "x-enumNames": [ "Failed" ], "enum": [ "failed" ] }, "VerificationHookStatusView": { "description": "Состояние проверяемого вебхука.", "allOf": [ { "$ref": "#/components/schemas/HookStatusView" }, { "type": "object", "description": "Состояние проверяемого вебхука.", "additionalProperties": false, "properties": { "status": { "description": "Идентификатор состояния вебхука.", "example": "active", "oneOf": [ { "$ref": "#/components/schemas/HookStatusType" } ] }, "verification": { "description": "Проверка вебхука", "oneOf": [ { "$ref": "#/components/schemas/krokar__VerificationView" } ] }, "hook": { "description": "Проверяемый вебхук.", "oneOf": [ { "$ref": "#/components/schemas/VerificationHookView" } ] } } } ] }, "CreatedHookStatusView": { "description": "Состояние созданного вебхука.", "allOf": [ { "$ref": "#/components/schemas/HookStatusView" }, { "type": "object", "description": "Состояние созданного вебхука.", "additionalProperties": false, "properties": { "status": { "description": "Идентификатор состояния вебхука.", "example": "active", "oneOf": [ { "$ref": "#/components/schemas/HookStatusType" } ] }, "hook": { "description": "Созданный вебхук.", "oneOf": [ { "$ref": "#/components/schemas/CreatedHookView" } ] } } } ] }, "ActiveHookStatusView": { "description": "Состояние активного вебхука.", "allOf": [ { "$ref": "#/components/schemas/HookStatusView" }, { "type": "object", "description": "Состояние активного вебхука.", "additionalProperties": false, "properties": { "status": { "description": "Идентификатор состояния вебхука.", "example": "active", "oneOf": [ { "$ref": "#/components/schemas/HookStatusType" } ] }, "hook": { "description": "Активный вебхук.", "oneOf": [ { "$ref": "#/components/schemas/ActiveHookView" } ] } } } ] }, "DeactivatedHookStatusView": { "description": "Состояние деактивированного вебхука.", "allOf": [ { "$ref": "#/components/schemas/HookStatusView" }, { "type": "object", "description": "Состояние деактивированного вебхука.", "additionalProperties": false, "properties": { "status": { "description": "Идентификатор состояния вебхука.", "example": "active", "oneOf": [ { "$ref": "#/components/schemas/HookStatusType" } ] }, "hook": { "description": "Деактивированный вебхук.", "oneOf": [ { "$ref": "#/components/schemas/DeactivatedHookView" } ] } } } ] }, "krokar__VerificationView": { "type": "object", "discriminator": { "propertyName": "status", "mapping": { "failed": "#/components/schemas/FailedVerificationView", "progress": "#/components/schemas/ProgressVerificationView" } }, "description": "Проверка вебхука", "x-abstract": true, "additionalProperties": false, "properties": { "status": { "description": "Идентификатор состояния проверки.", "example": "progress", "oneOf": [ { "$ref": "#/components/schemas/VerificationStatuses" } ] } }, "oneOf": [ { "$ref": "#/components/schemas/ProgressVerificationView" }, { "$ref": "#/components/schemas/FailedVerificationView" } ] }, "VerificationHookView": { "description": "Проверяемый вебхук.", "allOf": [ { "$ref": "#/components/schemas/HookView" }, { "type": "object", "description": "Проверяемый вебхук.", "additionalProperties": false, "required": [ "id", "callback", "topic", "contact_id", "key" ], "properties": { "id": { "type": "string", "description": "Идентификатор вебхука.", "minLength": 1, "example": "644bdc87dbd6fc3747887c7b" }, "callback": { "type": "string", "description": "URL, на который отправляются уведомления.", "minLength": 1, "example": "https://hooks.example.com/webhook" }, "topic": { "type": "string", "description": "Тема подписки.", "minLength": 1, "example": "cargoes.on_boards" }, "application_id": { "type": "string", "description": "Идентификатор приложения.\nnull, если вебхук создан без приложения.", "nullable": true, "example": "cargo-integrator" }, "contact_id": { "type": "integer", "description": "Идентификатор контакта.", "example": 14612 }, "key": { "type": "string", "description": "Ключ, используемый для подписывания запросов.", "minLength": 1, "example": "a3f1c8e92b7d4e6a" } } } ] }, "CreatedHookView": { "description": "Созданный вебхук.", "allOf": [ { "$ref": "#/components/schemas/HookView" }, { "type": "object", "description": "Созданный вебхук.", "additionalProperties": false, "required": [ "id", "callback", "topic", "contact_id", "key" ], "properties": { "id": { "type": "string", "description": "Идентификатор вебхука.", "minLength": 1, "example": "644bdc87dbd6fc3747887c7b" }, "callback": { "type": "string", "description": "URL, на который отправляются уведомления.", "minLength": 1, "example": "https://hooks.example.com/webhook" }, "topic": { "type": "string", "description": "Тема подписки.", "minLength": 1, "example": "cargoes.on_boards" }, "application_id": { "type": "string", "description": "Идентификатор приложения.\nnull, если вебхук создан без приложения.", "nullable": true, "example": "cargo-integrator" }, "contact_id": { "type": "integer", "description": "Идентификатор контакта.", "example": 14612 }, "key": { "type": "string", "description": "Ключ, используемый для подписывания запросов.", "minLength": 1, "example": "a3f1c8e92b7d4e6a" } } } ] }, "ActiveHookView": { "description": "Активный вебхук.", "allOf": [ { "$ref": "#/components/schemas/HookView" }, { "type": "object", "description": "Активный вебхук.", "additionalProperties": false, "required": [ "id", "callback", "topic", "contact_id", "key" ], "properties": { "suspended_until": { "type": "string", "description": "Дата окончания приостановки подписки", "format": "date-time", "nullable": true }, "id": { "type": "string", "description": "Идентификатор вебхука.", "minLength": 1, "example": "644bdc87dbd6fc3747887c7b" }, "callback": { "type": "string", "description": "URL, на который отправляются уведомления.", "minLength": 1, "example": "https://hooks.example.com/webhook" }, "topic": { "type": "string", "description": "Тема подписки.", "minLength": 1, "example": "cargoes.on_boards" }, "application_id": { "type": "string", "description": "Идентификатор приложения.\nnull, если вебхук создан без приложения.", "nullable": true, "example": "cargo-integrator" }, "contact_id": { "type": "integer", "description": "Идентификатор контакта.", "example": 14612 }, "key": { "type": "string", "description": "Ключ, используемый для подписывания запросов.", "minLength": 1, "example": "a3f1c8e92b7d4e6a" } } } ] }, "DeactivatedHookView": { "description": "Деактивированный вебхук.", "allOf": [ { "$ref": "#/components/schemas/HookView" }, { "type": "object", "description": "Деактивированный вебхук.", "additionalProperties": false, "required": [ "id", "callback", "topic", "contact_id", "key" ], "properties": { "first_failure_date": { "type": "string", "description": "Дата первой проваленной отправки", "format": "date-time" }, "id": { "type": "string", "description": "Идентификатор вебхука.", "minLength": 1, "example": "644bdc87dbd6fc3747887c7b" }, "callback": { "type": "string", "description": "URL, на который отправляются уведомления.", "minLength": 1, "example": "https://hooks.example.com/webhook" }, "topic": { "type": "string", "description": "Тема подписки.", "minLength": 1, "example": "cargoes.on_boards" }, "application_id": { "type": "string", "description": "Идентификатор приложения.\nnull, если вебхук создан без приложения.", "nullable": true, "example": "cargo-integrator" }, "contact_id": { "type": "integer", "description": "Идентификатор контакта.", "example": 14612 }, "key": { "type": "string", "description": "Ключ, используемый для подписывания запросов.", "minLength": 1, "example": "a3f1c8e92b7d4e6a" } } } ] }, "VerificationStatuses": { "type": "string", "description": "Идентификатор состояния проверки\n - `progress` — Выполнение\n - `failed` — Провалена", "x-enumNames": [ "Progress", "Failed" ], "enum": [ "progress", "failed" ] }, "ProgressVerificationView": { "description": "Выполняющаяся проверка вебхука.", "allOf": [ { "$ref": "#/components/schemas/krokar__VerificationView" }, { "type": "object", "description": "Выполняющаяся проверка вебхука.", "additionalProperties": false, "properties": { "status": { "description": "Идентификатор состояния проверки.", "example": "progress", "oneOf": [ { "$ref": "#/components/schemas/VerificationStatuses" } ] } } } ] }, "FailedVerificationView": { "description": "Неудачная проверка вебхука.", "allOf": [ { "$ref": "#/components/schemas/krokar__VerificationView" }, { "type": "object", "description": "Неудачная проверка вебхука.", "additionalProperties": false, "required": [ "fail_reason" ], "properties": { "fail_reason": { "description": "Причина провала проверки.", "example": "request_error", "oneOf": [ { "$ref": "#/components/schemas/FailReasonType" } ] }, "status": { "description": "Идентификатор состояния проверки.", "example": "progress", "oneOf": [ { "$ref": "#/components/schemas/VerificationStatuses" } ] } } } ] }, "HookView": { "type": "object", "description": "Вебхук.", "x-abstract": true, "additionalProperties": false, "required": [ "id", "callback", "topic", "contact_id", "key" ], "properties": { "id": { "type": "string", "description": "Идентификатор вебхука.", "minLength": 1, "example": "644bdc87dbd6fc3747887c7b" }, "callback": { "type": "string", "description": "URL, на который отправляются уведомления.", "minLength": 1, "example": "https://hooks.example.com/webhook" }, "topic": { "type": "string", "description": "Тема подписки.", "minLength": 1, "example": "cargoes.on_boards" }, "application_id": { "type": "string", "description": "Идентификатор приложения.\nnull, если вебхук создан без приложения.", "nullable": true, "example": "cargo-integrator" }, "contact_id": { "type": "integer", "description": "Идентификатор контакта.", "example": 14612 }, "key": { "type": "string", "description": "Ключ, используемый для подписывания запросов.", "minLength": 1, "example": "a3f1c8e92b7d4e6a" } } }, "FailReasonType": { "type": "string", "description": "Причины провала проверки вебхука\n - `unknown_error` — Неизвестная ошибка\n\n > Ошибка на стороне АТИ\n - `tls_error` — Ошибка установки защищенного соединения\n\n > Возможно используется недоверенный сертификат, или сервер не поддерживает протокол HTTPS\n - `socket_error` — Ошибка создания TCP соединения\n\n > Возможно указан недоступный IP адрес, DNS-имя, разрешающееся в недоступный IP адрес, или сервер не принимает запросы\n - `request_error` — Ошибка запроса\n\n > Получен HTTP-код, отличный от 200, или превышено время ожидания ответа \n - `challenge_mismatch` — Challenge не совпадает\n - `wrong_response_format` — Неправильный формат ответа \n\n > Формат ответа отличается от JSON-строки", "x-enumNames": [ "UnknownError", "TlsError", "SocketError", "RequestError", "ChallengeMismatch", "WrongResponseFormat" ], "enum": [ "unknown_error", "tls_error", "socket_error", "request_error", "challenge_mismatch", "wrong_response_format" ] }, "SubscriptionParametersView": { "type": "object", "discriminator": { "propertyName": "channel", "mapping": { "cargoes": "#/components/schemas/CargoesSubscriptionParametersView", "auctions": "#/components/schemas/AuctionsSubscriptionParametersView" } }, "description": "Параметры подписки.", "x-abstract": true, "additionalProperties": false, "properties": { "channel": { "description": "Канал подписки.", "example": "cargoes.on_boards", "oneOf": [ { "$ref": "#/components/schemas/SubscriptionChannels" } ] } }, "oneOf": [ { "$ref": "#/components/schemas/AuctionsSubscriptionParametersView" }, { "$ref": "#/components/schemas/CargoesSubscriptionParametersView" } ] }, "SubscriptionParametersDto": { "type": "object", "discriminator": { "propertyName": "channel", "mapping": { "cargoes": "#/components/schemas/CargoesSubscriptionParametersDto", "auctions": "#/components/schemas/AuctionsSubscriptionParametersDto" } }, "description": "Параметры подписки.", "x-abstract": true, "additionalProperties": false, "properties": { "channel": { "description": "Канал подписки.", "example": "cargoes.on_boards", "oneOf": [ { "$ref": "#/components/schemas/SubscriptionChannels" } ] } }, "oneOf": [ { "$ref": "#/components/schemas/AuctionsSubscriptionParametersDto" }, { "$ref": "#/components/schemas/CargoesSubscriptionParametersDto" } ], "x-is-external-request": true }, "SubscriptionChannels": { "type": "string", "description": "Каналы подписки\n - `cargoes` — [Грузы на площадках](/api/webhooks/topics-with-filter/cargoes-on-boards/)\n - `auctions` — [Торги на площадках](/api/webhooks/topics-with-filter/auctions-on-boards/)", "x-enumNames": [ "Cargoes", "Auctions" ], "enum": [ "cargoes", "auctions" ] }, "AuctionsSubscriptionParametersView": { "description": "Параметры подписки на торги на площадках.", "allOf": [ { "$ref": "#/components/schemas/SubscriptionParametersView" }, { "type": "object", "description": "Параметры подписки на торги на площадках.", "additionalProperties": false, "required": [ "boards" ], "properties": { "channel": { "description": "Канал подписки.", "example": "auctions.on_boards", "oneOf": [ { "$ref": "#/components/schemas/SubscriptionChannels" } ] }, "boards": { "type": "array", "description": "Идентификаторы [площадок](/api/boards/#get-v2-boards-public-boards-canView) для подписки.", "example": [ "644bdc87dbd6fc3747887c7b" ], "items": { "type": "string" } } } } ] }, "CargoesSubscriptionParametersView": { "description": "Параметры подписки на грузы на площадках.", "allOf": [ { "$ref": "#/components/schemas/SubscriptionParametersView" }, { "type": "object", "description": "Параметры подписки на грузы на площадках.", "additionalProperties": false, "required": [ "boards" ], "properties": { "channel": { "description": "Канал подписки.", "example": "cargoes.on_boards", "oneOf": [ { "$ref": "#/components/schemas/SubscriptionChannels" } ] }, "boards": { "type": "array", "description": "Идентификаторы [площадок](/api/boards/#get-v2-boards-public-boards-canView) для подписки.", "example": [ "644bdc87dbd6fc3747887c7b" ], "items": { "type": "string" } } } } ] }, "AuctionsSubscriptionParametersDto": { "description": "Подписка на торги на площадках.", "allOf": [ { "$ref": "#/components/schemas/SubscriptionParametersDto" }, { "type": "object", "description": "Подписка на торги на площадках.", "additionalProperties": false, "required": [ "boards" ], "properties": { "channel": { "description": "Канал подписки.", "example": "auctions.on_boards", "oneOf": [ { "$ref": "#/components/schemas/SubscriptionChannels" } ] }, "boards": { "type": "array", "description": "Идентификаторы [площадок](/api/boards/#get-v2-boards-public-boards-canView) для подписки.", "example": [ "644bdc87dbd6fc3747887c7b" ], "items": { "type": "string" } } } } ], "x-is-external-request": true }, "CargoesSubscriptionParametersDto": { "description": "Подписка на грузы на площадках.", "allOf": [ { "$ref": "#/components/schemas/SubscriptionParametersDto" }, { "type": "object", "description": "Подписка на грузы на площадках.", "additionalProperties": false, "required": [ "boards" ], "properties": { "channel": { "description": "Канал подписки.", "example": "cargoes.on_boards", "oneOf": [ { "$ref": "#/components/schemas/SubscriptionChannels" } ] }, "boards": { "type": "array", "description": "Идентификаторы [площадок](/api/boards/#get-v2-boards-public-boards-canView) для подписки.", "example": [ "644bdc87dbd6fc3747887c7b" ], "items": { "type": "string" } } } } ], "x-is-external-request": true }, "OAuthUser": { "type": "object", "properties": { "firm_id": { "type": "integer", "description": "Идентификатор фирмы пользователя в ATI.", "format": "int32", "example": 12345 }, "contact_id": { "type": "integer", "description": "Идентификатор контакта пользователя в ATI.", "format": "int32", "example": 67890 }, "o_auth_user_id": { "type": "string", "description": "Внешний идентификатор пользователя OAuth.", "format": "uuid", "example": "\n 2f7b0a74-2c2f-4f1f-9a63-cac4a7d0b2f4\n " } }, "additionalProperties": false, "description": "Внешний идентификатор пользователя для интеграторов.", "example": { "firm_id": 12345, "contact_id": 67890, "o_auth_user_id": "\n 2f7b0a74-2c2f-4f1f-9a63-cac4a7d0b2f4\n " } }, "AccessTokenRequest": { "required": [ "client_id", "client_secret" ], "type": "object", "properties": { "client_id": { "minLength": 1, "type": "string", "description": "Идентификатор OAuth-клиента.", "example": "\n ati-cargo-app\n " }, "client_secret": { "minLength": 1, "type": "string", "description": "Секрет OAuth-клиента.", "example": "\n secret-abc-123\n " }, "code": { "type": [ "null", "string" ], "description": "Код авторизации для обмена на access-токен.", "example": "\n auth-code-123\n " }, "refresh_token": { "type": [ "null", "string" ], "description": "Refresh-токен для обновления access-токена.", "example": "\n refresh-token-123\n " }, "grant_type": { "enum": [ "0", "1" ], "allOf": [ { "description": "Тип grant для выпуска OAuth-токена.\n- 0 = AuthorizationCode (Обмен кода авторизации на access-токен)\n- 1 = RefreshToken (Обновление access-токена по refresh-токену)", "$ref": "#/components/schemas/GrantType" } ], "description": "Тип grant для выпуска токена.", "example": 0 } }, "additionalProperties": false, "description": "Запрос на выпуск или обновление access-токена.", "example": { "client_id": "\n ati-cargo-app\n ", "client_secret": "\n secret-abc-123\n ", "code": "\n auth-code-123\n ", "refresh_token": "\n refresh-token-123\n ", "grant_type": 0 } }, "AccessTokenModel": { "type": "object", "properties": { "client_id": { "type": [ "null", "string" ], "description": "Идентификатор OAuth-клиента.", "example": "\n ati-cargo-app\n " }, "firm_id": { "type": "integer", "description": "Идентификатор фирмы пользователя в ATI.", "format": "int32", "example": 12345 }, "contact_id": { "type": "integer", "description": "Идентификатор контакта пользователя в ATI.", "format": "int32", "example": 67890 }, "access_token": { "type": [ "null", "string" ], "description": "Access-токен пользователя.", "example": "\n access-token-123\n " }, "scope": { "type": [ "null", "string" ], "description": "Скоупы токена, разделённые пробелом.", "example": "\n profile orders.read\n " }, "refresh_token": { "type": [ "null", "string" ], "description": "Refresh-токен пользователя.", "example": "\n refresh-token-123\n " }, "token_type": { "enum": [ "Bearer" ], "allOf": [ { "description": "Тип OAuth-токена.\n- Bearer (Bearer-токен)", "$ref": "#/components/schemas/TokenType" } ], "description": "Тип access-токена.", "example": "\n Bearer\n " }, "o_auth_user_id": { "type": "string", "description": "Идентификатор пользователя ATI.", "format": "uuid", "example": "\n 2f7b0a74-2c2f-4f1f-9a63-cac4a7d0b2f4\n " }, "expire_time": { "type": "string", "description": "Дата и время истечения токена.", "format": "date-time", "example": "\n 2024-01-15T10:30:00Z\n " }, "expires_in": { "type": "integer", "description": "Количество секунд до истечения токена.", "format": "int32", "readOnly": true, "example": 3600 } }, "additionalProperties": false, "description": "Данные access-токена OAuth-клиента.", "example": { "client_id": "\n ati-cargo-app\n ", "firm_id": 12345, "contact_id": 67890, "access_token": "\n access-token-123\n ", "scope": "\n profile orders.read\n ", "refresh_token": "\n refresh-token-123\n ", "token_type": "\n Bearer\n ", "o_auth_user_id": "\n 2f7b0a74-2c2f-4f1f-9a63-cac4a7d0b2f4\n ", "expire_time": "\n 2024-01-15T10:30:00Z\n ", "expires_in": 3600 } }, "GrantType": { "enum": [ 0, 1 ], "type": "integer", "oneOf": [ { "const": "0", "title": "AuthorizationCode", "description": "Обмен кода авторизации на access-токен" }, { "const": "1", "title": "RefreshToken", "description": "Обновление access-токена по refresh-токену" } ], "description": "Тип grant для выпуска OAuth-токена.\n- 0 = AuthorizationCode (Обмен кода авторизации на access-токен)\n- 1 = RefreshToken (Обновление access-токена по refresh-токену)", "x-ms-enum-flags": { "isFlags": false } }, "TokenType": { "enum": [ "Bearer" ], "type": "string", "description": "Тип OAuth-токена.\n- Bearer (Bearer-токен)", "x-ms-enum-flags": { "isFlags": false } }, "GetDealsParams": { "properties": { "StartDate": { "type": "string", "format": "date", "title": "Сделки от", "description": "Начальная дата погрузки, в формате ISO-8601", "example": "2021-01-01" }, "EndDate": { "type": "string", "format": "date", "title": "Сделки до", "description": "Конечная дата погрузки, в формате ISO-8601", "example": "2021-01-02" }, "From": { "$ref": "#/components/schemas/RequestAtiGeoPoint", "title": "Гео-пункт загрузки", "description": "Гео-пункт загрузки. Обязателен хотя бы один из параметров: `From` или `To`." }, "To": { "$ref": "#/components/schemas/RequestAtiGeoPoint", "title": "Гео-пункт разгрузки", "description": "Гео-пункт разгрузки. Обязателен хотя бы один из параметров: `From` или `To`." }, "Adr": { "anyOf": [ { "type": "integer", "maximum": 9, "minimum": 0 }, { "type": "null" } ], "title": "Опасность", "description": "Параметр, определяющий степень опасности груза.\n Допустимое значение: Null, либо от 0 до 9.", "example": "null" }, "Weight": { "anyOf": [ { "type": "number", "maximum": 999999, "minimum": 0 }, { "type": "null" } ], "title": "Вес", "description": "Вес груза в тоннах", "example": 45.5 }, "Volume": { "anyOf": [ { "type": "number", "maximum": 999999, "minimum": 0 }, { "type": "null" } ], "title": "Объем", "description": "Объем груза в кубических метрах", "example": 25.5 }, "CarType": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Тип кузова", "description": "Тип кузова.\n Значение поля `mask` из `attributes_dictionary`\n [словаря кузовов ATI.SU](https://ati.su/developers/api/dictionaries/cargoes/#get-v1-cartypes).\n Словарь нужно запрашивать с параметром `attributeFieldFormat=2`, иначе `attributes_dictionary` в ответе не вернётся.\n В словаре атрибуты приходят строками, а поле ожидает число: передавайте `\"1\"` как `1`.\n Не передавайте `dictionary_item_id` — это идентификатор элемента словаря, а не маска кузова.", "example": 1 }, "GetAlsoRegions": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Получить сделки без точного города, но с указанием региона", "description": "Получить сделки без точного города, но с указанием региона.\n Не во всех сделках есть точный пункт (город),\n при передачи этого флага, в выдаче будут сделки с указанием только региона.", "default": false, "example": true }, "IsExecutor": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Параметр позволяет получить сделки с точным исполнителем:", "description": "Параметр позволяет получить сделки с точным исполнителем\n* `true` — метод вернёт сделки с исполнителем «экспедитор» и «перевозчик»;\n* `false` — метод вернёт сделки с любым исполнителем.", "default": false, "example": false }, "DealsCount": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Количество запрашиваемых сделок", "description": "Количество запрашиваемых сделок.\n Если параметр не передан или указан null, возвращаются все сделки, удовлетворяющие условиям", "example": 15 } }, "type": "object", "required": [ "StartDate", "EndDate" ], "title": "Запрос: Параметры для получения обезличенных сделок.", "description": "Параметры для получения обезличенных сделок." }, "ReturnData": { "properties": { "LoadId": { "type": "integer", "title": "Уникальный идентификатор груза", "description": "Уникальный идентификатор отдаваемого груза", "example": 123456789 }, "Date": { "type": "string", "format": "date", "title": "Дата погрузки", "description": "Дата погрузки груза в формате ISO-8601", "example": "2021-01-01" }, "ExtraPointsCitiesCount": { "type": "integer", "title": "Количество доп. точек маршрута", "description": "Количество доп. точек маршрута", "example": 2 }, "ExtraPointsCities": { "anyOf": [ { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array" }, { "type": "null" } ], "title": "Доп. точки маршрута", "description": "Доп. точки маршрута — значения поля `id` в структуре `city` из [словаря городов ATI.SU](https://ati.su/developers/api/dictionaries/geo/#post-v1-autocomplete-suggestions)", "example": [ "1", "3611" ] }, "Distance": { "type": "integer", "title": "Расстояние", "description": "Расстояние маршрута в километрах", "example": 750 }, "CargoTypeId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Тип груза", "description": "Идентификатор наименования груза.\n Значение поля `dictionary_item_id` из\n[словаря наименований грузов](https://ati.su/developers/api/dictionaries/cargoes/#get-v1-cargo_typ).\nСловарь нужно запрашивать с параметром `attributeFieldFormat=2`, иначе `attributes_dictionary` в ответе не вернётся.", "example": 18 }, "ADR": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Опасность", "description": "Параметр, определяющий степень опасности груза. Допустимое значение от 0 до 9", "example": 2 }, "Weight": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Вес", "description": "Вес груза в тоннах", "example": 45.5 }, "Volume": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "title": "Объем", "description": "Объем груза в кубических метрах", "example": 23.4 }, "PalletCount": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Количество упаковок", "description": "Количество упаковок для груза", "example": 3 }, "CarType": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Тип кузова", "description": "Тип кузова.\n Значение поля `mask` из `attributes_dictionary`\n[словаря кузовов ATI.SU](https://ati.su/developers/api/dictionaries/cargoes/#get-v1-cartypes).\nСловарь нужно запрашивать с параметром `attributeFieldFormat=2`, иначе `attributes_dictionary` в ответе не вернётся.", "example": 1 }, "DogruzType": { "type": "integer", "title": "Догруз", "description": "Вариант перевозки:\n* `1` - отдельной машиной\n* `2` - только догрузом\n ", "example": 1 }, "Rate": { "type": "number", "title": "Ставка", "description": "Ставка, по которой совершена сделка", "example": 27500 }, "CurrencyId": { "type": "integer", "title": "Валюта", "description": "Валюта ставки в сделке.\n Значение поля `dictionary_item_id` из\n[словаря валют ATI.SU](https://ati.su/developers/api/dictionaries/cargoes/#get-v1-currency).\nСловарь нужно запрашивать с параметром `attributeFieldFormat=2`, иначе `attributes_dictionary` в ответе не вернётся.", "example": 1 }, "PaymentType": { "type": "integer", "title": "Тип ставки", "description": "Параметр, определяющий тип ставки.\n* `1` - нал\n* `2` - с НДС\n* `3` - без НДС\n ", "example": 2 }, "Executor": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Исполнитель", "description": "Параметр, определяющий исполнителя перевозки:\n* `null` - неизвестно\n* `0` - другое\n* `1` - перевозчик\n* `2` - экспедитор\n ", "example": 1 }, "From": { "$ref": "#/components/schemas/GeoPoint", "title": "Гео-пункт загрузки", "description": "Гео-пункт загрузки" }, "To": { "$ref": "#/components/schemas/GeoPoint", "title": "Гео-пункт разгрузки", "description": "Гео-пункт разгрузки" } }, "type": "object", "required": [ "LoadId", "Date", "ExtraPointsCitiesCount", "ExtraPointsCities", "Distance", "CargoTypeId", "ADR", "Weight", "Volume", "PalletCount", "CarType", "DogruzType", "Rate", "CurrencyId", "PaymentType", "Executor", "From", "To" ], "title": "Подпараметр: Сделка, отвечающая переданным параметрам", "description": "Обезличенная сделка, отвечающая переданным параметрам." }, "faceless_api__ErrorFormatResponse": { "properties": { "error": { "anyOf": [ { "$ref": "#/components/schemas/FacelessErrorCode" }, { "type": "string", "enum": [ "validation_errors" ], "const": "validation_errors" } ], "title": "Error", "description": "Машинный код ошибки.\nДля ответов с несколькими ошибками (непустой `error_list`)\nпринимает фиксированное значение `validation_errors`.", "example": "FACELESS_39_DEALS_NOT_FOUND" }, "reason": { "type": "string", "title": "Reason", "description": "Человекочитаемое описание ошибки.", "example": "Нет сделок по заданным параметрам. Измените параметры поиска." }, "details": { "anyOf": [ { "$ref": "#/components/schemas/ErrorDetails" }, { "type": "null" } ], "description": "Детали ошибки (null, если их нет).\nДля ответов с несколькими ошибками всегда `null`: детали каждой ошибки\nлежат в соответствующем элементе `error_list`." }, "error_list": { "items": { "$ref": "#/components/schemas/ErrorListItem" }, "type": "array", "title": "Error List", "description": "Список ошибок. Пуст, если произошла одна ошибка — тогда она описана в полях выше.", "example": [] } }, "type": "object", "required": [ "error", "reason", "error_list" ], "title": "Ответ: Формат возвращаемых ошибок", "description": "Формат возвращаемых ошибок.\n\nСервис возвращает ошибки в двух видах, различать их нужно по `error_list`:\n* `error_list` пуст — произошла одна ошибка, она описана в полях\n `error`, `reason` и `details`;\n* `error_list` не пуст — ошибок несколько, разбирать нужно каждый его\n элемент, а верхнеуровневый `error` в этом случае всегда равен\n `validation_errors`.\n\nКак разбирать ошибку:\n1. Ветвите логику по `error` — это стабильный машинный код.\n2. `reason` предназначен для показа пользователю. Текст может меняться,\n разбирать его не нужно.\n3. `details.location` указывает на поле, вызвавшее ошибку.\n4. `details.index` и `details.LoadId` указывают на конкретную сделку\n в массиве `Data` и заполняются только для `/v1/give_deals`." }, "DealsParams": { "properties": { "StartDate": { "type": "string", "format": "date", "title": "Сделки от", "description": "Начальная дата погрузки, в формате ISO-8601", "example": "2021-01-01" }, "EndDate": { "type": "string", "format": "date", "title": "Сделки до", "description": "Конечная дата погрузки, в формате ISO-8601", "example": "2021-01-02" }, "From": { "$ref": "#/components/schemas/RequestAtiGeoPoint", "title": "Гео-пункт загрузки", "description": "Гео-пункт загрузки. Обязателен хотя бы один из параметров: `From` или `To`." }, "To": { "$ref": "#/components/schemas/RequestAtiGeoPoint", "title": "Гео-пункт разгрузки", "description": "Гео-пункт разгрузки. Обязателен хотя бы один из параметров: `From` или `To`." }, "Adr": { "anyOf": [ { "type": "integer", "maximum": 9, "minimum": 0 }, { "type": "null" } ], "title": "Опасность", "description": "Параметр, определяющий степень опасности груза.\n Допустимое значение: Null, либо от 0 до 9.", "example": "null" }, "Weight": { "anyOf": [ { "type": "number", "maximum": 999999, "minimum": 0 }, { "type": "null" } ], "title": "Вес", "description": "Вес груза в тоннах", "example": 45.5 }, "Volume": { "anyOf": [ { "type": "number", "maximum": 999999, "minimum": 0 }, { "type": "null" } ], "title": "Объем", "description": "Объем груза в кубических метрах", "example": 25.5 }, "CarType": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Тип кузова", "description": "Тип кузова.\n Значение поля `mask` из `attributes_dictionary`\n [словаря кузовов ATI.SU](https://ati.su/developers/api/dictionaries/cargoes/#get-v1-cartypes).\n Словарь нужно запрашивать с параметром `attributeFieldFormat=2`, иначе `attributes_dictionary` в ответе не вернётся.\n В словаре атрибуты приходят строками, а поле ожидает число: передавайте `\"1\"` как `1`.\n Не передавайте `dictionary_item_id` — это идентификатор элемента словаря, а не маска кузова.", "example": 1 }, "GetAlsoRegions": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Получить сделки без точного города, но с указанием региона", "description": "Получить сделки без точного города, но с указанием региона.\n Не во всех сделках есть точный пункт (город),\n при передачи этого флага, в выдаче будут сделки с указанием только региона.", "default": false, "example": true }, "IsExecutor": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Параметр позволяет получить сделки с точным исполнителем:", "description": "Параметр позволяет получить сделки с точным исполнителем\n* `true` — метод вернёт сделки с исполнителем «экспедитор» и «перевозчик»;\n* `false` — метод вернёт сделки с любым исполнителем.", "default": false, "example": false } }, "type": "object", "required": [ "StartDate", "EndDate" ], "title": "Запрос: Параметры для получения количества обезличенных сделок.", "description": "Параметры для получения количества обезличенных сделок." }, "DataCount": { "properties": { "DealsCount": { "type": "integer", "title": "Dealscount", "description": "Общее количество обезличенных сделок, отвечающих переданным параметрам", "example": 1500 } }, "type": "object", "required": [ "DealsCount" ], "title": "Ответ: Количество обезличенных сделок, отвечающих переданным параметрам", "description": "Количество обезличенных сделок, отвечающих переданным параметрам." }, "GetStatistic": { "properties": { "StartDate": { "type": "string", "format": "date", "title": "Startdate", "description": "Начальная дата запрашиваемого периода, в формате ISO-8601.", "example": "2021-06-06" }, "EndDate": { "type": "string", "format": "date", "title": "Enddate", "description": "Конечная дата запрашиваемого периода, в формате ISO-8601.", "example": "2021-07-07" } }, "type": "object", "required": [ "StartDate", "EndDate" ], "title": "Запрос: Статистика", "description": "Параметры периода для получения статистики по сделкам." }, "Statistic": { "properties": { "GivenDealsCityToCity": { "$ref": "#/components/schemas/TimePeriods", "description": "Статистика переданных сделок город-город" }, "TakenDealsCityToCity": { "$ref": "#/components/schemas/TimePeriods", "description": "Статистика взятых сделок город-город" }, "GivenDealsRegionToRegion": { "$ref": "#/components/schemas/TimePeriods", "description": "Статистика переданных сделок регион-регион" }, "TakenDealsRegionToRegion": { "$ref": "#/components/schemas/TimePeriods", "description": "Статистика взятых сделок регион-регион" }, "AllGivenCount": { "type": "integer", "title": "Allgivencount", "description": "Общее количество переданных сделок", "example": 340 }, "AllGivenPrice": { "type": "number", "title": "Allgivenprice", "description": "Общая сумма переданных сделок", "example": 9350000 }, "AllTakenCount": { "type": "integer", "title": "Alltakencount", "description": "Общее количество взятых сделок", "example": 210 }, "AllTakenPrice": { "type": "number", "title": "Alltakenprice", "description": "Общая сумма взятых сделок", "example": 5775000 }, "GivenInLast30Days": { "type": "integer", "title": "Giveninlast30Days", "description": "Передано сделок за последние 30 дней", "example": 28 }, "CurrentTakeLimit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Currenttakelimit", "description": "Текущий лимит на взятие сделок. `null`, если лимит не задан", "example": 100 }, "CurrentTakenCount": { "type": "integer", "title": "Currenttakencount", "description": "Текущее количество взятых сделок", "example": 15 } }, "type": "object", "required": [ "GivenDealsCityToCity", "TakenDealsCityToCity", "GivenDealsRegionToRegion", "TakenDealsRegionToRegion", "AllGivenCount", "AllGivenPrice", "AllTakenCount", "AllTakenPrice", "GivenInLast30Days", "CurrentTakeLimit", "CurrentTakenCount" ], "title": "Ответ: Общая статистика за выбранный период", "description": "Общая статистика по принятым/отданным сделкам за выбранный период." }, "ThirdPartyDealsParams": { "properties": { "Data": { "items": { "$ref": "#/components/schemas/ThirdPartyDeal" }, "type": "array", "title": "Data", "description": "Сделки, которые вы хотите передать", "example": [ { "CarType": 1, "CurrencyId": 1, "Date": "2021-01-01", "Distance": 750, "DogruzType": 1, "Executor": 1, "From": { "AtiId": { "Id": 3611, "Type": 2 } }, "LoadId": "E45CCE73-Q040-6641-A19A-FFFFFFFFFFFF", "PaymentType": 2, "Rate": "27500.00", "To": { "AtiId": { "Id": 1, "Type": 2 } }, "Weight": 45.5 } ] } }, "type": "object", "required": [ "Data" ], "title": "Запрос: Сделки, которые вы хотите передать", "description": "Тело запроса на предоставление обезличенных сделок." }, "RequestAtiGeoPoint": { "properties": { "AtiId": { "$ref": "#/components/schemas/RequestGeoPoint", "title": "Гео-точка ATI.SU", "description": "Гео-точка ATI.SU" } }, "type": "object", "required": [ "AtiId" ], "title": "Подпараметр запроса: Гео-точка", "description": "Гео-точка в запросе на получение сделок." }, "GeoPoint": { "properties": { "AtiId": { "$ref": "#/components/schemas/AtiGeoPoint", "title": "Гео-точка ATI.SU", "description": "Гео-точка ATI.SU" } }, "type": "object", "required": [ "AtiId" ], "title": "Подпараметр: Гео-точка", "description": "Гео-точка сделки в ответе." }, "FacelessErrorCode": { "type": "string", "enum": [ "FACELESS_1_UNKNOWN", "FACELESS_2_UNRECOGNIZED_ADDRESS", "FACELESS_3_UNCALCULATED_DISTANCE", "FACELESS_4_DISTANCE_NEEDED_FOR_REGION", "FACELESS_5_SPECIFY_EXTRA_POINT", "FACELESS_6_PRICE_ABOVE_MARKET", "FACELESS_7_WRONG_CARTYPE", "FACELESS_8_WRONG_DOGRUZ_TYPE", "FACELESS_9_WRONG_PAYMENT_TYPE", "FACELESS_10_WRONG_EXECUTOR", "FACELESS_11_ZERO_RATE", "FACELESS_12_RATE_IS_NOT_A_NUMBER", "FACELESS_13_FUTURE_DATE", "FACELESS_14_WRONG_DATE_FORMAT", "FACELESS_15_WEIGHT_OR_VOLUME_NEEDED", "FACELESS_16_NOT_EQUAL_GEO_POINTS", "FACELESS_17_INVALID_FIAS_ID", "FACELESS_18_FIAS_ID_NOT_FOUND", "FACELESS_19_NOT_ENOUGH_GEO_POINTS", "FACELESS_20_NEED_EXTRAPOINTS_DISTANCE", "FACELESS_21_UNSUPPORTED_GEO_POINT_TYPE", "FACELESS_22_NEEDED_GEO_POINT", "FACELESS_23_MANY_GEO_TYPES", "FACELESS_25_WRONG_ATI_GEO_POINT_TYPE", "FACELESS_26_ATI_COUNTRY_NOT_FOUND", "FACELESS_27_ATI_REGION_NOT_FOUND", "FACELESS_28_ATI_CITY_NOT_FOUND", "FACELESS_29_EQUAL_LOAD_ID", "FACELESS_30_WRONG_ADR", "FACELESS_31_FROM_OR_TO_NEEDED", "FACELESS_32_START_DATE_GT_END_DATE", "FACELESS_33_BAD_COUNTRY", "FACELESS_34_NO_LOAD_ID", "FACELESS_35_PRICE_BELOW_MARKET", "FACELESS_36_DEAL_IS_TOO_OLD", "FACELESS_37_FIELD_REQUIRED", "FACELESS_38_JSON_DECODE", "FACELESS_39_DEALS_NOT_FOUND", "FACELESS_40_LARGE_DEALS_NUMBER_TIMEOUT", "FACELESS_41_LARGE_DEALS_NUMBER_SIZE", "FACELESS_42_FORBIDDEN", "FACELESS_43_UNPROCESSABLE_INPUT", "FACELESS_44_SQL_ERROR", "FACELESS_45_DATE_OUT_OF_RANGE", "FACELESS_46_MIN_DEALS_BLOCK", "FACELESS_47_MAX_DEALS_BLOCK", "FACELESS_48_DATE_BLOCK", "FACELESS_49_GET_DEALS_BILLING_ERROR", "FACELESS_50_PAYMENT_FORBIDDEN", "FACELESS_51_NOT_ENOUGH_MONEY", "FACELESS_52_GIVE_DEALS_BILLING_ERROR", "FACELESS_53_VALIDATION_ERROR", "FACELESS_54_CONDITION_ERROR", "FACELESS_55_WRONG_CAR_TYPE_ID", "FACELESS_56_WRONG_CURRENCY_ID", "FACELESS_57_WRONG_CARGO_TYPE_ID", "FACELESS_58_WRONG_CARTYPE" ], "title": "FacelessErrorCode", "description": "Машинный код ошибки сервиса." }, "ErrorDetails": { "properties": { "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Location", "description": "Путь до поля, к которому относится ошибка.\nСегменты пути разделены ` -> `.\n* Для `/v1/give_deals` путь начинается с `Data -> <индекс сделки>`.\n* Для остальных методов путь состоит из имени поля, например `StartDate`.\n* Пустая строка, если ошибка относится к телу запроса целиком.", "example": "Data -> 0 -> Rate" }, "index": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Index", "description": "Индекс сделки в массиве `Data`. Только для `/v1/give_deals`.", "example": 0 }, "LoadId": { "anyOf": [ { "type": "string" }, { "type": "integer" }, { "type": "null" } ], "title": "Loadid", "description": "`LoadId` сделки, к которой относится ошибка.\nТолько для `/v1/give_deals`. Может быть `null`, если поле не передали.", "example": "test001" }, "msg": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Msg", "description": "Исходный текст ошибки Pydantic. Только для `FACELESS_53_VALIDATION_ERROR`.", "example": "Input should be a valid integer" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Type", "description": "Исходный тип ошибки Pydantic. Только для `FACELESS_53_VALIDATION_ERROR`.", "example": "int_parsing" }, "acceptedIndex": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Acceptedindex", "description": "Индекс сделки, которая была записана из группы дубликатов.\nТолько для `FACELESS_29_EQUAL_LOAD_ID`.", "example": 3 }, "dublicateIndexes": { "anyOf": [ { "items": { "type": "integer" }, "type": "array" }, { "type": "null" } ], "title": "Dublicateindexes", "description": "Индексы всех сделок-дубликатов в группе.\nТолько для `FACELESS_29_EQUAL_LOAD_ID`." }, "indexesByLoadId": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Indexesbyloadid", "description": "Индексы сделок, сгруппированные по повторяющемуся `LoadId`.\nТолько для `FACELESS_29_EQUAL_LOAD_ID`, обнаруженной до разбора пакета по сделкам." }, "about": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "About", "description": "Пояснение по получению доступа. Только для `FACELESS_42_FORBIDDEN`." } }, "type": "object", "title": "Подпараметр ответа: детали ошибки", "description": "Детали ошибки.\n\nНабор заполненных полей зависит от вида ошибки: незаполненные поля\nв ответе отсутствуют. Само наличие поля — признак того, что ошибка\nотносится к соответствующей сущности." }, "ErrorListItem": { "properties": { "error": { "$ref": "#/components/schemas/FacelessErrorCode", "description": "Машинный код ошибки.", "example": "FACELESS_39_DEALS_NOT_FOUND" }, "reason": { "type": "string", "title": "Reason", "description": "Человекочитаемое описание ошибки.", "example": "Нет сделок по заданным параметрам. Измените параметры поиска." }, "details": { "anyOf": [ { "$ref": "#/components/schemas/ErrorDetails" }, { "type": "null" } ], "description": "Детали ошибки (null, если их нет)." } }, "type": "object", "required": [ "error", "reason" ], "title": "Подпараметр ответа: одна ошибка из списка ошибок", "description": "Отдельная ошибка внутри списка ошибок." }, "TimePeriods": { "properties": { "FromNowTo6MonthsAgo": { "$ref": "#/components/schemas/PeriodStatistics", "description": "Сделки, завершенные за последние 6 месяцев" }, "From6MonthsTo12MonthsAgo": { "$ref": "#/components/schemas/PeriodStatistics", "description": "Сделки, завершенные за период с 6 месяцев до 1 года" }, "From1YearTo2YearsAgo": { "$ref": "#/components/schemas/PeriodStatistics", "description": "Сделки, завершенные за период с 1 года до 2х лет" }, "From2YearsTo4YearsAgo": { "$ref": "#/components/schemas/PeriodStatistics", "description": "Сделки, завершенные за период с 2х лет до 4х лет" }, "From4YearsAgo": { "$ref": "#/components/schemas/PeriodStatistics", "description": "Сделки, завершенные за период старше 4х лет" } }, "type": "object", "required": [ "FromNowTo6MonthsAgo", "From6MonthsTo12MonthsAgo", "From1YearTo2YearsAgo", "From2YearsTo4YearsAgo", "From4YearsAgo" ], "title": "Подпараметр ответа: статистика сделок по временным периодам", "description": "Статистика сделок, сгруппированная по временным периодам." }, "ThirdPartyDeal": { "properties": { "LoadId": { "type": "string", "minLength": 1, "title": "Идентификатор груза", "description": "Идентификатор груза в вашей системе (либо хэш идентификаторов, если несколько).\n Минимальное количество символов: 1.\n Не передавайте в одном пакете одинаковый `LoadId`.", "example": "E45CCE73-Q040-6641-A19A-FFFFFFFFFFFF" }, "Date": { "type": "string", "title": "Сделки от", "description": "Дата погрузки, в формате ISO-8601, без времени: `YYYY-MM-DD`", "example": "2021-01-01" }, "From": { "$ref": "#/components/schemas/GiveDealsGeoPoint", "title": "Гео-пункт загрузки", "description": "Гео-пункт загрузки" }, "To": { "$ref": "#/components/schemas/GiveDealsGeoPoint", "title": "Гео-пункт разгрузки", "description": "Гео-пункт разгрузки" }, "ExtraPointsCityCount": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Количество доп. точек маршрута", "description": "Количество дополнительных точек на маршруте", "default": 0, "example": 2 }, "ExtraPointsCities": { "anyOf": [ { "items": { "anyOf": [ { "type": "integer" }, { "type": "string" } ] }, "type": "array" }, { "type": "null" } ], "title": "Доп. точки маршрута", "description": "Доп. точки маршрута в том же формате, что и `From`/`To`:\n значение поля `id` в структуре `city` из [словаря городов ATI.SU](https://ati.su/developers/api/dictionaries/geo/#post-v1-autocomplete-suggestions)\n или `fias_id` из [словаря Fias](https://ati.su/developers/api/dictionaries/geo/#post-v1-cities-by-fias-ids) или текст", "example": [ "1", "3611" ] }, "Distance": { "type": "integer", "minimum": 0, "title": "Расстояние", "description": "Расстояние маршрута в километрах.\n Если не передать, расстояние рассчитывается автоматически — но только когда и `From`, и `To` заданы городами.\n Если хотя бы один из пунктов — регион или страна, параметр обязателен.", "example": 750 }, "CargoTypeId": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Тип груза", "description": "Идентификатор наименования груза.\n Значение поля `dictionary_item_id` из\n [словаря наименований грузов](https://ati.su/developers/api/dictionaries/cargoes/#get-v1-cargo_typ).\n Словарь нужно запрашивать с параметром `attributeFieldFormat=2`, иначе `attributes_dictionary` в ответе не вернётся.\n ", "example": 18 }, "ADR": { "anyOf": [ { "type": "integer", "maximum": 9, "minimum": 0 }, { "type": "null" } ], "title": "Опасность", "description": "Параметр, определяющий степень опасности груза. Допустимое значение от 0 до 9" }, "Weight": { "anyOf": [ { "type": "number", "maximum": 100, "minimum": 0 }, { "type": "null" } ], "title": "Вес", "description": "Вес груза в тоннах. Обязательный параметр, если не задан параметр Volume.", "example": 45.5 }, "Volume": { "anyOf": [ { "type": "number", "maximum": 200, "minimum": 0 }, { "type": "null" } ], "title": "Объем", "description": "Объем груза в кубических метрах. Обязательный параметр, если не задан параметр Weight.", "example": 23.4 }, "PalletCount": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "Количество упаковок", "description": "Количество упаковок для груза", "example": 3 }, "CarType": { "type": "integer", "exclusiveMinimum": 0, "title": "Тип кузова", "description": "Тип кузова.\n Значение поля `mask` из `attributes_dictionary`\n [словаря кузовов ATI.SU](https://ati.su/developers/api/dictionaries/cargoes/#get-v1-cartypes).\n Словарь нужно запрашивать с параметром `attributeFieldFormat=2`, иначе `attributes_dictionary` в ответе не вернётся.\n В словаре атрибуты приходят строками, а поле ожидает число: передавайте `\"1\"` как `1`.\n Не передавайте `dictionary_item_id` — это идентификатор элемента словаря, а не маска кузова.\n ", "example": 1 }, "DogruzType": { "type": "integer", "title": "Догруз", "description": "Вариант перевозки:\n* `1` - отдельной машиной\n* `2` - только догрузом\n ", "example": 1 }, "Rate": { "type": "number", "exclusiveMaximum": 10000000000, "minimum": 1, "title": "Ставка", "description": "Ставка, по которой совершена сделка", "example": "27500.00" }, "CurrencyId": { "type": "integer", "minimum": 0, "title": "Валюта", "description": "Валюта ставки в сделке.\n Значение поля `dictionary_item_id` из\n [словаря валют ATI.SU](https://ati.su/developers/api/dictionaries/cargoes/#get-v1-currency).\n Словарь нужно запрашивать с параметром `attributeFieldFormat=2`, иначе `attributes_dictionary` в ответе не вернётся.", "example": 1 }, "PaymentType": { "type": "integer", "title": "Тип ставки", "description": "Параметр, определяющий тип ставки.\n* `1` - нал\n* `2` - с НДС\n* `3` - без НДС\n ", "example": 2 }, "Executor": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Исполнитель", "description": "Параметр, определяющий исполнителя перевозки:\n* `1` - перевозчик — если сделка между вами и перевозчиком\n* `2` - экспедитор — если сделка между вами и грузовладельцем\n* `null` - неизвестно\n ", "example": 1 } }, "type": "object", "required": [ "LoadId", "Date", "From", "To", "CarType", "DogruzType", "Rate", "CurrencyId", "PaymentType" ], "title": "Запрос: Параметры для предоставления обезличенных сделок.", "description": "Обезличенная сделка, передаваемая сторонней системой." }, "RequestGeoPoint": { "properties": { "Id": { "type": "integer", "maximum": 2147483647, "minimum": 1, "title": "ID гео-пункта", "description": "ID гео-пункта. Используется для города, региона или страны. Город — значение поля `id` в структуре `city`, регион — значение поля `id` в структуре `region`, страна — значение поля `id` в структуре `country` из [словаря ATI.SU](https://ati.su/developers/api/dictionaries/geo/#post-v1-autocomplete-suggestions)\n ", "example": 3611 }, "Type": { "type": "integer", "title": "Тип гео-пункта", "description": "Тип гео-пункта\n* `0` - страна\n* `1` - регион\n* `2` - город\n ", "example": 2 } }, "type": "object", "required": [ "Id", "Type" ], "title": "Подпараметр запроса: Гео-точка", "description": "Гео-точка ATI.SU в запросе с проверкой существования в справочниках." }, "AtiGeoPoint": { "properties": { "Id": { "type": "integer", "maximum": 2147483647, "minimum": 1, "title": "ID гео-пункта", "description": "ID гео-пункта. Используется для города, региона или страны. Город — значение поля `id` в структуре `city`, регион — значение поля `id` в структуре `region`, страна — значение поля `id` в структуре `country` из [словаря ATI.SU](https://ati.su/developers/api/dictionaries/geo/#post-v1-autocomplete-suggestions)\n ", "example": 3611 }, "Type": { "type": "integer", "title": "Тип гео-пункта", "description": "Тип гео-пункта\n* `0` - страна\n* `1` - регион\n* `2` - город\n ", "example": 2 } }, "type": "object", "required": [ "Id", "Type" ], "title": "Подпараметр: Гео-точка ATI.SU", "description": "Гео-точка ATI.SU (город, регион или страна)." }, "PeriodStatistics": { "properties": { "Count": { "type": "integer", "title": "Count", "description": "Количество сделок", "example": 12 }, "OneDealsPrice": { "type": "number", "title": "Onedealsprice", "description": "Цена одной сделки", "example": 27500 }, "TotalSum": { "type": "number", "title": "Totalsum", "description": "Общая сумма сделок", "example": 330000 } }, "type": "object", "required": [ "Count", "OneDealsPrice", "TotalSum" ], "title": "Подпараметр ответа: статистика временного периода", "description": "Статистика сделок за отдельный временной период." }, "GiveDealsGeoPoint": { "properties": { "AtiId": { "$ref": "#/components/schemas/AtiGeoPoint", "title": "Гео-точка ATI.SU", "description": "Гео-точка ATI.SU." }, "FiasId": { "type": "string", "title": "Идентификатор ФИАС", "description": "FiasId гео-пункта.\n Значение `fias_id` из\n [словаря Fias](https://ati.su/developers/api/dictionaries/geo/#post-v1-cities-by-fias-ids).\n* Пример: `C2DEB16A-0330-4F05-821F-1D09C93331E6` - Санкт-Петербург", "example": "null" }, "Text": { "type": "string", "title": "Текстовое указание адреса", "description": "Текстовое поле для описания гео-пункта.\n* Пример: `город Санкт-Петербург, улица Народного Ополчения 10`", "example": "null" } }, "type": "object", "title": "Подпараметр запроса: Передаваемая гео-точка", "description": "Передаваемая гео-точка сделки: гео-точка ATI.SU, ФИАС-идентификатор или текстовый адрес." }, "AllDirectionsResponseV1": { "properties": { "all_directions": { "items": { "$ref": "#/components/schemas/recommended_price__Direction" }, "type": "array", "title": "All Directions", "description": "Все направления для перевозчика." } }, "type": "object", "required": [ "all_directions" ], "title": "Ответ: список направлений для перевозчика" }, "recommended_price__CarType": { "type": "string", "enum": [ "close", "open", "ref", "tent" ], "title": "CarType", "description": "Тип кузова\n* `ref` - рефрижераторы\n* `close` - закрытые. Значение по умолчанию\n* `open` - открытые\n* `tent` - тентованный\n " }, "DealPoint": { "properties": { "x": { "type": "string", "title": "Дата." }, "y": { "items": { "type": "number" }, "type": "array", "title": "Стоимости сделок", "default": [] } }, "type": "object", "required": [ "x" ], "title": "Точки графика." }, "recommended_price__Direction": { "properties": { "from_city_id": { "type": "integer", "title": "ID пункта загрузки", "description": "ID пункта загрузки" }, "from_city": { "type": "string", "title": "Название пункта загрузки", "description": "Название пункта загрузки" }, "to_city_id": { "type": "integer", "title": "ID пункта разгрузки", "description": "ID пункта разгрузки" }, "to_city": { "type": "string", "title": "Название пункта разгрузки", "description": "Название пункта разгрузки" }, "car_types": { "items": { "$ref": "#/components/schemas/recommended_price__CarType" }, "type": "array", "title": "Доступные типы кузовов для направления", "description": "Доступные типы кузовов для направления" } }, "type": "object", "required": [ "from_city_id", "from_city", "to_city_id", "to_city", "car_types" ], "title": "Подпараметр ответа: одно направление для перевозчика" }, "DisplayedPeriod": { "type": "string", "enum": [ "3m", "6m", "ytd", "1y", "3y", "alltime" ], "title": "DisplayedPeriod", "description": "Временной интервал \n* `3m` - за 3 месяца\n* `6m` - за 6 месяцев\n* `ytd` - с начала текущего года\n* `1y` - за год\n* `3y` - за 3 года\n* `alltime` - за все время" }, "recommended_price__ErrorFormatResponse": { "properties": { "error": { "type": "string", "title": "Error", "description": "Основное тело ошибки с описанием" }, "reason": { "type": "string", "title": "Reason", "description": "Тип ошибки если имеется" }, "details": { "additionalProperties": true, "type": "object", "title": "Details", "description": "Какие-либо дополнительные детали ошибки" } }, "type": "object", "required": [ "error", "reason", "details" ], "title": "Ответ: Формат ответа при ошибке" }, "recommended_price__Graph": { "properties": { "x": { "type": "string", "title": "Дата." }, "y": { "type": "number", "title": "Рекомендуемая цена" } }, "type": "object", "required": [ "x", "y" ], "title": "Точка графика." }, "GraphHist": { "properties": { "x": { "type": "string", "title": "Дата." }, "y": { "type": "number", "title": "Рекомендуемая цена" }, "h": { "type": "integer", "title": "Надежность прогноза." } }, "type": "object", "required": [ "x", "y", "h" ], "title": "Точка графика со столбцом гистограммы." }, "recommended_price__HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/recommended_price__ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "InputParams": { "properties": { "time_interval": { "allOf": [ { "$ref": "#/components/schemas/DisplayedPeriod" } ], "description": "Временной интервал.\n Один из ['`DisplayedPeriod.three_months`', '`DisplayedPeriod.six_months`', '`DisplayedPeriod.ytd`', '`DisplayedPeriod.year`', '`DisplayedPeriod.three_years`', '`DisplayedPeriod.alltime`']", "default": "3m" }, "from_city": { "type": "integer", "title": "From City", "description": "ID пункта загрузки. Значение поля `id` в структуре `city` из [словаря ATI.SU](https://ati.su/developers/api/dictionaries/geo/#post-v1-autocomplete-suggestions)" }, "to_city": { "type": "integer", "title": "To City", "description": "ID пункта разгрузки. Значение поля `id` в структуре `city` из [словаря ATI.SU](https://ati.su/developers/api/dictionaries/geo/#post-v1-autocomplete-suggestions)" }, "car_type": { "allOf": [ { "$ref": "#/components/schemas/recommended_price__CarType" } ], "description": "Тип кузова\n* `ref` - рефрижераторы\n* `close` - закрытые. Значение по умолчанию\n* `open` - открытые\n* `tent` - тентованный\n ", "default": "close" }, "users_margin": { "type": "number", "maximum": 1000, "minimum": 0, "title": "Users Margin", "description": "Маржа.", "default": 0 }, "nds": { "type": "boolean", "title": "Nds", "description": "Учитывать ли НДС в цене", "default": false }, "rate_per_km": { "type": "boolean", "title": "Rate Per Km", "description": "Размерность ставки.\n * `true` - в руб/км.\n * `false` - в руб.\n ", "default": true }, "priority": { "allOf": [ { "$ref": "#/components/schemas/Priority" } ], "description": "Приоритет данных при рассчетах.\n * `mixed` - баланс;\n * `partner` - ваши данные;\n * `ati` - данные ATI.SU.\n ", "default": "mixed" } }, "type": "object", "required": [ "from_city", "to_city" ], "title": "Запрос: Входные параметры для получения рекомендации", "example": { "car_type": "close", "from_city": 1, "nds": false, "priority": "mixed", "rate_per_km": true, "time_interval": "3m", "to_city": 3611, "users_margin": 0 } }, "Priority": { "type": "string", "enum": [ "ati", "partner", "mixed" ], "title": "Priority", "example": "mixed", "description": "Приоритет данных при рассчетах\n* `mixed` - баланс\n* `partner` - ваши данные\n* `ati` - данные ATI.SU\n" }, "SiteChartResponse": { "properties": { "average_line": { "anyOf": [ { "items": { "$ref": "#/components/schemas/recommended_price__Graph" }, "type": "array" }, { "type": "null" } ], "title": "Средние цены в грузах на ATI.SU " }, "recomended_line": { "items": { "$ref": "#/components/schemas/GraphHist" }, "type": "array", "title": "Рекомендуемая цена с учетом маржи" }, "your_executor_deals": { "items": { "$ref": "#/components/schemas/DealPoint" }, "type": "array", "title": "Ваши сделки с исполнителем" }, "your_customer_deals": { "items": { "$ref": "#/components/schemas/DealPoint" }, "type": "array", "title": "Ваши сделки с заказчиком" }, "other_executor_deals": { "items": { "$ref": "#/components/schemas/DealPoint" }, "type": "array", "title": "Сделки других партнеров с исполнителем" }, "current_price": { "type": "number", "title": "Текущая цена в руб/км" }, "current_cost": { "type": "number", "title": "Текущая стоимость за заданное расстояние в рублях" }, "current_date": { "type": "string", "title": "Дата последнего дня, на который есть прогноз." }, "confidence_level": { "type": "integer", "title": "Надежность прогноза на текущий день." }, "mean_margin": { "type": "number", "title": "Средняя маржа по направлению за год." }, "max_margin": { "type": "number", "title": "Максимальная маржа по направлению за год." }, "min_margin": { "type": "number", "title": "Минимальная маржа по направлению за год." }, "distance": { "type": "integer", "title": "Расстояние между выбранными городами" } }, "type": "object", "required": [ "current_price", "current_cost", "current_date", "confidence_level", "mean_margin", "max_margin", "min_margin", "distance" ], "title": "Ответ: Рекомендованные цены, СС и сделки по заданным параметрам" }, "recommended_price__ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" }, "ActiveFirmsResultViewV2": { "properties": { "actual_trucks_count": { "description": "Сколько в данный момент у пользователя есть машин по этому направлению", "format": "int32", "type": "integer" }, "id": { "description": "ID фирмы", "type": "string" }, "inn": { "description": "ИНН фирмы, если указан", "type": "string" }, "search_count": { "description": "Сколько за период представители этой фирмы искали грузы по выбранному направлению", "format": "int32", "type": "integer" }, "sum_count": { "description": "Сумма search_count и trucks_count", "format": "int32", "type": "integer" }, "trucks_count": { "description": "Сколько за период представители этой фирмы размещали машин по выбранному направлению на вкладке \"Транспорт\"", "format": "int32", "type": "integer" } }, "required": [ "search_count", "trucks_count", "sum_count", "actual_trucks_count" ], "type": "object" }, "ActiveFirmsViewOfActiveFirmsResultViewV2": { "properties": { "is_demo": { "description": "Это демо-данные?", "type": "boolean" }, "ok": { "description": "Успешно?", "type": "boolean" }, "result": { "description": "Список активных фирм", "items": { "$ref": "#/components/schemas/ActiveFirmsResultViewV2" }, "type": "array" } }, "required": [ "ok", "is_demo", "result" ], "type": "object" }, "ActiveTruckersGeoDto": { "properties": { "begin_date": { "description": "Дата, от которой ведется поиск активных фирм в формате ISO-8601", "format": "date-time", "type": "string" }, "from": { "allOf": [ { "$ref": "#/components/schemas/vandamus_v2__Geo" } ], "description": "Локация: откуда" }, "to": { "allOf": [ { "$ref": "#/components/schemas/vandamus_v2__Geo" } ], "description": "Локация: куда" }, "truck_type": { "description": "Маска типа кузова\\\nЗначение из [словаря кузовов ATI.SU](https://ati.su/developers/api/dictionaries/cargoes/#get-v1.0-dictionaries-carTypes)", "format": "int64", "type": "integer" }, "truck_volume": { "allOf": [ { "$ref": "#/components/schemas/ValueRange" } ], "description": "Диапазон объёма кузова в метрах кубических" }, "truck_weight": { "allOf": [ { "$ref": "#/components/schemas/ValueRange" } ], "description": "Диапазон грузоподъёмности в тоннах" }, "volume": { "description": "Объём в метрах кубических", "format": "int32", "type": "integer" }, "weight": { "description": "Вес в тоннах", "format": "int32", "type": "integer" } }, "required": [ "begin_date", "from", "to" ], "type": "object" }, "ActiveTruckersWithActualGeoDto": { "allOf": [ { "$ref": "#/components/schemas/ActiveTruckersGeoDto" }, { "properties": { "trucks_date_from": { "description": "Дата, от которой ведется поиск актуальных машин в формате ISO-8601.\nЕсли отсутствует в запросе, то используется значение `begin_date`", "format": "date-time", "type": "string" }, "trucks_date_to": { "description": "Дата, до которой ведется поиск актуальных машин в формате ISO-8601.\nДолжна быть больше даты начала поиска машин.\nЕсли отсутствует в запросе, то результат поиска не ограничивается сверху", "format": "date-time", "type": "string" } }, "type": "object" } ] }, "vandamus_v2__FinalExceptionView": { "properties": { "details": { "description": "Детали ошибки" }, "error_code": { "description": "Код ошибки", "type": "string" }, "error_list": { "description": "Список вложенных ошибок", "items": { "$ref": "#/components/schemas/vandamus_v2__FinalExceptionView" }, "type": "array" }, "reason": { "description": "Причина ошибки", "type": "string" } }, "required": [ "error_code", "reason", "details", "error_list" ], "type": "object" }, "vandamus_v2__Geo": { "properties": { "id": { "description": "Id локации\\\nЗначение из [словаря](https://ati.su/developers/api/dictionaries/geo/)", "format": "int32", "type": "integer" }, "type": { "allOf": [ { "$ref": "#/components/schemas/GeoType" } ], "description": "Тип локации\n \n* `0` - страна\n* `1` - регион\n* `2` - город" } }, "required": [ "id", "type" ], "type": "object" }, "GeoType": { "description": "Тип локации\n \n* `0` - страна\n* `1` - регион\n* `2` - город", "enum": [ 0, 1, 2 ], "type": "integer", "x-enumNames": [ "Country", "Region", "City" ] }, "ValueRange": { "properties": { "from": { "description": "Значение от", "format": "int32", "type": "integer" }, "to": { "description": "Значение до", "format": "int32", "type": "integer" } }, "type": "object" }, "AllDirectionsResponseLicenseV1": { "properties": { "AllDirections": { "items": { "$ref": "#/components/schemas/DirectionLicenseV1" }, "type": "array", "title": "Alldirections", "description": "Список направлений, по которым доступен запрос средних ставок", "example": [ { "FromCityId": 1, "FromCity": "Санкт-Петербург, РФ", "ToCityId": 3611, "ToCity": "Москва, РФ", "FromRegionId": null, "FromRegion": null, "ToRegionId": null, "ToRegion": null, "CarTypes": [ "close", "tent", "open" ], "RoundTrips": [ "close", "tent" ] }, { "FromCityId": null, "FromCity": null, "FromRegionId": 1, "FromRegion": "Московская обл., РФ", "ToCityId": 1, "ToCity": "Санкт-Петербург, РФ", "ToRegionId": null, "ToRegion": null, "CarTypes": [ "close", "tent" ], "RoundTrips": null }, { "FromCityId": 1, "FromCity": "Санкт-Петербург, РФ", "FromRegionId": null, "FromRegion": null, "ToCityId": null, "ToCity": null, "ToRegionId": 1, "ToRegion": "Московская обл., РФ", "CarTypes": [ "close", "open" ], "RoundTrips": [ "close" ] } ] } }, "type": "object", "required": [ "AllDirections" ], "title": "Ответ: список направлений", "description": "Справочник направлений: города/регионы, типы кузова и кругорейсы", "example": { "AllDirections": [ { "FromCityId": 1, "FromCity": "Санкт-Петербург, РФ", "ToCityId": 3611, "ToCity": "Москва, РФ", "FromRegionId": null, "FromRegion": null, "ToRegionId": null, "ToRegion": null, "CarTypes": [ "close", "tent", "open" ], "RoundTrips": [ "close", "tent" ] }, { "FromCityId": null, "FromCity": null, "FromRegionId": 1, "FromRegion": "Московская обл., РФ", "ToCityId": 1, "ToCity": "Санкт-Петербург, РФ", "ToRegionId": null, "ToRegion": null, "CarTypes": [ "close", "tent" ], "RoundTrips": null }, { "FromCityId": 1, "FromCity": "Санкт-Петербург, РФ", "FromRegionId": null, "FromRegion": null, "ToCityId": null, "ToCity": null, "ToRegionId": 1, "ToRegion": "Московская обл., РФ", "CarTypes": [ "close", "open" ], "RoundTrips": [ "close" ] } ] } }, "priceline_api__ErrorFormatResponse": { "properties": { "error": { "type": "string", "title": "Error", "description": "Код или текст ошибки (machine-readable)", "example": "PRICELINE_5_DIRECTION_NOT_FOUND" }, "reason": { "type": "string", "title": "Reason", "description": "Человекочитаемое описание причины ошибки", "example": "По запрошенным параметрам данные не найдены" }, "details": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Details", "description": "Дополнительные сведения об ошибке (контекст, идентификаторы и т.п.)", "example": { "From": { "RegionId": 153153 }, "To": { "RegionId": 153 } } } }, "type": "object", "required": [ "error", "reason" ], "title": "Ответ: Формат ответа при ошибке", "description": "Стандартный формат ошибки ATI API: error, reason и details. Возвращается при ошибках валидации, доступа и лимитов", "example": { "details": { "From": { "RegionId": 153153 }, "To": { "RegionId": 153 } }, "error": "PRICELINE_5_DIRECTION_NOT_FOUND", "reason": "По запрошенным параметрам данные не найдены" } }, "RequestParams": { "properties": { "From": { "allOf": [ { "$ref": "#/components/schemas/priceline_api__GeoPoint" } ], "description": "Город или регион откуда. Указывается либо CityId, либо RegionId." }, "To": { "allOf": [ { "$ref": "#/components/schemas/priceline_api__GeoPoint" } ], "description": "Город или регион куда. Указывается либо CityId, либо RegionId.", "example": { "CityId": 3611 } }, "CarType": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Cartype", "description": "Тип кузова.\n* `ref` - рефрижераторы.\n* `close` - закрытые. Значение по умолчанию.\n* `open` - открытые.\n* `tent` - тентованный.\n* `tral` - трал.\n* `docker` - контейнер.\n ", "default": "close", "example": "close" }, "DateFrom": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Datefrom", "description": "Начало периода. Формат ISO-8601.\n Если интересует только одна дата, то передавать ее здесь.\n По умолчанию - последний день, за который есть данные.\n ", "example": "2022-03-01" }, "DateTo": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Dateto", "description": "Конец периода. Формат ISO-8601.\n Если интересует только одна дата, то данное поле не заполнять.\n ", "example": "2022-03-02" }, "Frequency": { "type": "string", "title": "Frequency", "description": "Дискретность выдачи данных.\n* `day` - для каждого дня будут выданы данные. Значение по умолчанию.\n Опция `day` доступна только в том случае,\n если общий временной период составляет меньше 6 месяцев.\n* `week` - будут выданы усредненные данные по неделе.\n* `month`- будут выданы усредненные данные по месяцу.\n ", "default": "day", "example": "day" }, "WithNds": { "type": "boolean", "title": "Withnds", "description": "Учитывать ли НДС в цене.\n* `false` - не учитывать. Значение по умолчанию.\n* `true` - учитывать.\n ", "default": false, "example": false }, "RoundTrip": { "type": "boolean", "title": "Roundtrip", "description": "Параметр позволяет получить цену кругорейса,\n то есть ставку для маршрута «туда и обратно».\n* `false` - для прямого рейса. Значение по умолчанию.\n* `true` - для кругового рейса (если доступен).\n ", "default": false, "example": false }, "Tonnage": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Tonnage", "description": "Тоннаж. Одно из:\n* `1.5`\n* `3`\n* `5`\n* `10`\n* `20` - значение по умолчанию.", "example": 3 } }, "type": "object", "required": [ "From", "To" ], "title": "Запрос: входные параметры для средних цен", "description": "Параметры запроса средних ставок по направлению, типу кузова, тоннажу и периоду", "example": { "From": { "CityId": 1 }, "To": { "CityId": 3611 }, "CarType": "close", "DateFrom": "2024-03-01", "DateTo": "2024-03-10", "Frequency": "day", "WithNds": false, "RoundTrip": true, "Tonnage": 10 } }, "ResponseParams": { "properties": { "Data": { "items": { "$ref": "#/components/schemas/PriceData" }, "type": "array", "title": "Data", "description": "Данные по запрошенному интервалу", "example": [ { "DateFrom": "2024-03-01", "DateTo": "2024-03-01", "LoadsCount": 42, "Prices": { "AveragePrice": 73.2, "BottomPrice": 62, "UpperPrice": 85.5 }, "PricesInRub": { "AveragePrice": 51600, "BottomPrice": 43700, "UpperPrice": 60300 } } ] }, "Distance": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Distance", "description": "Расстояние маршрута в километрах", "example": 705 }, "WithNDS": { "type": "boolean", "title": "Withnds", "description": "Признак того, что ставки в ответе рассчитаны с учётом НДС", "example": false } }, "type": "object", "required": [ "Data", "Distance", "WithNDS" ], "title": "Ответ: данные по средним ценам за выбранный временной период", "description": "Средние ставки ATI.SU по направлению, типу кузова и тоннажу за запрошенный период", "example": { "Data": [ { "DateFrom": "2024-03-01", "DateTo": "2024-03-01", "LoadsCount": 42, "Prices": { "AveragePrice": 73.2, "BottomPrice": 62, "UpperPrice": 85.5 }, "PricesInRub": { "AveragePrice": 51600, "BottomPrice": 43700, "UpperPrice": 60300 } } ], "Distance": 705, "WithNDS": false } }, "UsageStatisticsResponseSchema": { "properties": { "monthly_limit": { "type": "integer", "title": "Monthly Limit", "description": "Месячный лимит на количество запросов", "example": 10000 }, "current_period_usage": { "type": "integer", "title": "Current Period Usage", "description": "Количество запросов, выполненных за текущий период", "example": 4567 }, "remaining_requests": { "type": "integer", "title": "Remaining Requests", "description": "Оставшееся количество запросов", "example": 5433 }, "counter_reset_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Counter Reset Date", "description": "Дата и время следующего сброса счётчика запросов в формате ISO-8601 (UTC).\n\nПосле сброса начнётся новый период, а запросы снова станут доступны.\n\nДата сброса не привязана к дате окончания лицензии и может с ней не совпадать. Например, если лицензия действует 2 месяца, счётчик может сбрасываться каждый месяц.\n\nЕсли вы ещё не начали использовать API, дата сброса не возвращается.", "example": "2026-06-22T14:32:21.123Z" } }, "type": "object", "required": [ "monthly_limit", "current_period_usage", "remaining_requests", "counter_reset_date" ], "title": "Ответ: Статистика использования API", "description": "Текущая статистика использования API интегратором: лимит, расход за период, остаток и дата сброса счётчика.", "example": { "counter_reset_date": "2026-06-22T14:32:21.123Z", "current_period_usage": 4567, "monthly_limit": 10000, "remaining_requests": 5433 } }, "AllDirectionsResponseLicenseV2": { "properties": { "AllDirections": { "items": { "$ref": "#/components/schemas/DirectionLicenseV2" }, "type": "array", "title": "Alldirections", "description": "Все направления для средних ставок", "example": [ { "FromCityId": 3611, "FromCity": "Москва", "ToCityId": 1, "ToCity": "Санкт-Петербург, РФ", "FromRegionId": null, "FromRegion": null, "ToRegionId": null, "ToRegion": null, "DirectionInfo": { "CartypeTonnage": { "close": [ 5, 10, 20 ], "tent": [ 5, 10 ] }, "TonnageCartype": { "5": [ "close", "tent" ], "10": [ "close" ] } }, "RoundTripsInfo": null }, { "FromCityId": null, "FromCity": null, "ToCityId": 1, "ToCity": "Санкт-Петербург, РФ", "FromRegionId": 1, "FromRegion": "Московская обл., РФ", "ToRegionId": null, "ToRegion": null, "DirectionInfo": { "CartypeTonnage": { "close": [ 5, 10, 20 ], "tent": [ 5, 10 ] }, "TonnageCartype": { "5": [ "close", "tent" ], "10": [ "close" ] } }, "RoundTripsInfo": null }, { "FromCityId": 1, "FromCity": "Санкт-Петербург, РФ", "ToCityId": null, "ToCity": null, "FromRegionId": null, "FromRegion": null, "ToRegionId": 1, "ToRegion": "Московская обл., РФ", "DirectionInfo": { "CartypeTonnage": { "close": [ 5, 10, 20 ], "tent": [ 5, 10 ] }, "TonnageCartype": { "5": [ "close", "tent" ], "10": [ "close" ] } }, "RoundTripsInfo": { "CartypeTonnage": { "close": [ 5, 10, 20 ], "tent": [ 5, 10 ] }, "TonnageCartype": { "5": [ "close", "tent" ], "10": [ "close" ] } } } ] } }, "type": "object", "required": [ "AllDirections" ], "title": "Ответ: список направлений", "description": "Справочник направлений: города/регионы и матрица доступных типов кузова и тоннажа", "example": { "AllDirections": [ { "FromCityId": 3611, "FromCity": "Москва", "ToCityId": 1, "ToCity": "Санкт-Петербург, РФ", "FromRegionId": null, "FromRegion": null, "ToRegionId": null, "ToRegion": null, "DirectionInfo": { "CartypeTonnage": { "close": [ 5, 10, 20 ], "tent": [ 5, 10 ] }, "TonnageCartype": { "5": [ "close", "tent" ], "10": [ "close" ] } }, "RoundTripsInfo": null }, { "FromCityId": null, "FromCity": null, "ToCityId": 1, "ToCity": "Санкт-Петербург, РФ", "FromRegionId": 1, "FromRegion": "Московская обл., РФ", "ToRegionId": null, "ToRegion": null, "DirectionInfo": { "CartypeTonnage": { "close": [ 5, 10, 20 ], "tent": [ 5, 10 ] }, "TonnageCartype": { "5": [ "close", "tent" ], "10": [ "close" ] } }, "RoundTripsInfo": null }, { "FromCityId": 1, "FromCity": "Санкт-Петербург, РФ", "ToCityId": null, "ToCity": null, "FromRegionId": null, "FromRegion": null, "ToRegionId": 1, "ToRegion": "Московская обл., РФ", "DirectionInfo": { "CartypeTonnage": { "close": [ 5, 10, 20 ], "tent": [ 5, 10 ] }, "TonnageCartype": { "5": [ "close", "tent" ], "10": [ "close" ] } }, "RoundTripsInfo": { "CartypeTonnage": { "close": [ 5, 10, 20 ], "tent": [ 5, 10 ] }, "TonnageCartype": { "5": [ "close", "tent" ], "10": [ "close" ] } } } ] } }, "DirectionLicenseV1": { "properties": { "FromCityId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fromcityid", "description": "ID города загрузки из [геословаря ATI.SU](https://ati.su/developers/api/dictionaries/geo/#post-v1-autocomplete-suggestions)", "example": 1 }, "FromCity": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fromcity", "description": "Название города загрузки", "example": "Санкт-Петербург, РФ" }, "ToCityId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Tocityid", "description": "ID города разгрузки из [геословаря ATI.SU](https://ati.su/developers/api/dictionaries/geo/#post-v1-autocomplete-suggestions)", "example": 3611 }, "ToCity": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tocity", "description": "Название города разгрузки", "example": "Москва, РФ" }, "FromRegionId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fromregionid", "description": "ID региона загрузки из [геословаря ATI.SU](https://ati.su/developers/api/dictionaries/geo/#post-v1-autocomplete-suggestions)", "example": 1 }, "FromRegion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fromregion", "description": "Название региона загрузки", "example": "Московская обл., РФ" }, "ToRegionId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Toregionid", "description": "ID региона разгрузки из [геословаря ATI.SU](https://ati.su/developers/api/dictionaries/geo/#post-v1-autocomplete-suggestions)", "example": 1 }, "ToRegion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Toregion", "description": "Название региона разгрузки", "example": "Московская обл., РФ" }, "CarTypes": { "items": { "type": "string" }, "type": "array", "title": "Cartypes", "description": "Список типов кузова, доступных для этого направления", "example": [ "close", "tent", "open" ] }, "RoundTrips": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Roundtrips", "description": "Список типов кузова, для которых доступен кругорейс (обратное направление)", "example": [ "close", "tent" ] } }, "type": "object", "required": [ "FromCityId", "FromCity", "ToCityId", "ToCity", "FromRegionId", "FromRegion", "ToRegionId", "ToRegion", "CarTypes", "RoundTrips" ], "title": "Подпараметр ответа: одно направление, версия АПИ 1", "description": "Направление: типы кузова и доступность кругорейса", "example": { "FromCityId": 1, "FromCity": "Санкт-Петербург, РФ", "ToCityId": 3611, "ToCity": "Москва, РФ", "FromRegionId": null, "FromRegion": null, "ToRegionId": null, "ToRegion": null, "CarTypes": [ "close", "tent", "open" ], "RoundTrips": [ "close", "tent" ] } }, "priceline_api__GeoPoint": { "properties": { "CityId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Cityid", "description": "ID города из [геословаря ATI.SU](https://ati.su/developers/api/dictionaries/geo/#post-v1-autocomplete-suggestions) (поле `id` в объекте `city`)", "example": 1 }, "RegionId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Regionid", "description": "ID региона из [геословаря ATI.SU](https://ati.su/developers/api/dictionaries/geo/#post-v1-autocomplete-suggestions) (поле `id` в объекте `region`)", "example": 1 } }, "type": "object", "title": "Подпараметр запроса: геоточка", "description": "Город или регион маршрута; ровно одно из полей CityId, RegionId", "example": { "CityId": 1 } }, "PriceData": { "properties": { "DateFrom": { "type": "string", "format": "date", "title": "Datefrom", "description": "Начало периода. Формат ISO-8601.\n ", "example": "2022-03-01" }, "DateTo": { "anyOf": [ { "type": "string", "format": "date" }, { "type": "null" } ], "title": "Dateto", "description": "Конец периода. Формат ISO-8601.\n ", "example": "2022-03-02" }, "Prices": { "allOf": [ { "$ref": "#/components/schemas/Price" } ], "description": "Данные по ставкам в руб/км", "example": { "AveragePrice": 73.2, "BottomPrice": 62, "UpperPrice": 85.5 } }, "PricesInRub": { "anyOf": [ { "$ref": "#/components/schemas/Price" }, { "type": "null" } ], "description": "Данные по ставкам в руб за весь маршрут", "example": { "AveragePrice": 51600, "BottomPrice": 43700, "UpperPrice": 60300 } }, "LoadsCount": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Loadscount", "description": "Количество грузов", "example": 121 } }, "type": "object", "required": [ "DateFrom", "DateTo", "Prices", "PricesInRub", "LoadsCount" ], "title": "Подпараметр ответа: одна точка средних цен во времени", "description": "Средние ставки и количество грузов за один интервал (день, неделя или месяц в зависимости от Frequency)", "example": { "DateFrom": "2024-03-01", "DateTo": "2024-03-01", "LoadsCount": 42, "Prices": { "AveragePrice": 73.2, "BottomPrice": 62, "UpperPrice": 85.5 }, "PricesInRub": { "AveragePrice": 51600, "BottomPrice": 43700, "UpperPrice": 60300 } } }, "DirectionLicenseV2": { "properties": { "FromCityId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fromcityid", "description": "ID города загрузки из [геословаря ATI.SU](https://ati.su/developers/api/dictionaries/geo/#post-v1-autocomplete-suggestions)", "example": 1 }, "FromCity": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fromcity", "description": "Название города загрузки", "example": "Санкт-Петербург, РФ" }, "ToCityId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Tocityid", "description": "ID города разгрузки из [геословаря ATI.SU](https://ati.su/developers/api/dictionaries/geo/#post-v1-autocomplete-suggestions)", "example": 3611 }, "ToCity": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Tocity", "description": "Название города разгрузки", "example": "Москва, РФ" }, "FromRegionId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Fromregionid", "description": "ID региона загрузки из [геословаря ATI.SU](https://ati.su/developers/api/dictionaries/geo/#post-v1-autocomplete-suggestions)", "example": 1 }, "FromRegion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Fromregion", "description": "Название региона загрузки", "example": "Московская обл., РФ" }, "ToRegionId": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Toregionid", "description": "ID региона разгрузки из [геословаря ATI.SU](https://ati.su/developers/api/dictionaries/geo/#post-v1-autocomplete-suggestions)", "example": 1 }, "ToRegion": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Toregion", "description": "Название региона разгрузки", "example": "Московская обл., РФ" }, "DirectionInfo": { "allOf": [ { "$ref": "#/components/schemas/DirectionInfo" } ], "description": "Доступные сочетания типа кузова и тоннажа для прямого направления", "example": { "CartypeTonnage": { "close": [ 5, 10, 20 ], "tent": [ 5, 10 ] }, "TonnageCartype": { "5": [ "close", "tent" ], "10": [ "close" ] } } }, "RoundTripsInfo": { "anyOf": [ { "$ref": "#/components/schemas/DirectionInfo" }, { "type": "null" } ], "description": "Доступные сочетания типа кузова и тоннажа для кругорейса; отсутствует, если кругорейс недоступен", "example": { "CartypeTonnage": { "close": [ 5, 10, 20 ], "tent": [ 5, 10 ] }, "TonnageCartype": { "5": [ "close", "tent" ], "10": [ "close" ] } } } }, "type": "object", "required": [ "FromCityId", "FromCity", "ToCityId", "ToCity", "FromRegionId", "FromRegion", "ToRegionId", "ToRegion", "DirectionInfo", "RoundTripsInfo" ], "title": "Подпараметр ответа: одно направление, версия АПИ 2", "description": "Направление: матрица доступных типов кузова и тоннажа", "example": { "FromCityId": 3611, "FromCity": "Москва", "ToCityId": 1, "ToCity": "Санкт-Петербург, РФ", "FromRegionId": null, "FromRegion": null, "ToRegionId": null, "ToRegion": null, "DirectionInfo": { "CartypeTonnage": { "close": [ 5, 10, 20 ], "tent": [ 5, 10 ] }, "TonnageCartype": { "5": [ "close", "tent" ], "10": [ "close" ] } }, "RoundTripsInfo": null } }, "Price": { "properties": { "UpperPrice": { "type": "number", "title": "Upperprice", "description": "Верхняя граница ставок", "example": 30 }, "BottomPrice": { "type": "number", "title": "Bottomprice", "description": "Нижняя граница ставок", "example": 10 }, "AveragePrice": { "type": "number", "title": "Averageprice", "description": "Средняя ставка", "example": 20 } }, "type": "object", "required": [ "UpperPrice", "BottomPrice", "AveragePrice" ], "title": "Подпараметр ответа: данные по ставкам", "description": "Верхняя, нижняя и средняя ставка за период", "example": { "AveragePrice": 73.2, "BottomPrice": 62, "UpperPrice": 85.5 } }, "DirectionInfo": { "properties": { "CartypeTonnage": { "additionalProperties": { "items": { "anyOf": [ { "type": "integer" }, { "type": "number" } ] }, "type": "array" }, "type": "object", "title": "Cartypetonnage", "description": "Словарь доступных сочетаний тип кузова - тоннаж", "example": { "close": [ 5, 10, 20 ], "tent": [ 5, 10 ] } }, "TonnageCartype": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "type": "object", "title": "Tonnagecartype", "description": "Словарь доступных сочетаний тоннаж - тип кузова", "example": { "5": [ "close", "tent" ], "10": [ "close" ] } } }, "type": "object", "required": [ "CartypeTonnage", "TonnageCartype" ], "title": "DirectionInfo", "description": "Доступные сочетания типа кузова и тоннажа для направления", "example": { "CartypeTonnage": { "close": [ 5, 10, 20 ], "tent": [ 5, 10 ] }, "TonnageCartype": { "5": [ "close", "tent" ], "10": [ "close" ] } } }, "index-by-directions__GeoPoint": { "title": "GeoPoint", "required": [ "Id" ], "type": "object", "properties": { "Id": { "title": "Id", "type": "integer", "description": "Id точки." } } }, "GeoPointFull": { "title": "GeoPointFull", "required": [ "Id", "Name" ], "type": "object", "properties": { "Id": { "title": "Id", "type": "integer", "description": "Id точки." }, "Name": { "title": "Name", "type": "string", "description": "Название точки." } } }, "index-by-directions__HTTPValidationError": { "title": "HTTPValidationError", "type": "object", "properties": { "detail": { "title": "Detail", "type": "array", "items": { "$ref": "#/components/schemas/index-by-directions__ValidationError" } } } }, "LicenseDirection": { "title": "Подпараметр ответа: направление", "required": [ "From", "To" ], "type": "object", "properties": { "From": { "title": "From", "allOf": [ { "$ref": "#/components/schemas/GeoPointFull" } ], "description": "Точка откуда.", "example": { "Id": 1, "Name": "Санкт-Петербург" } }, "To": { "title": "To", "allOf": [ { "$ref": "#/components/schemas/GeoPointFull" } ], "description": "Точка куда.", "example": { "Id": 3611, "Name": "Москва" } } } }, "LicenseDirectionsResponse": { "title": "Ответ: список направлений", "required": [ "Directions" ], "type": "object", "properties": { "Directions": { "title": "Directions", "type": "array", "items": { "$ref": "#/components/schemas/LicenseDirection" }, "description": "Все направления для индекса" } } }, "LicenseIndexByDirectionRequest": { "title": "Запрос: Параметры для получения индекса по направлению.", "required": [ "DateFrom", "DateTo", "From", "To" ], "type": "object", "properties": { "DateFrom": { "title": "Datefrom", "type": "string", "description": "Начало периода. Формат ISO-8601.", "format": "date", "example": "2022-02-01" }, "DateTo": { "title": "Dateto", "type": "string", "description": "Конец периода. Формат ISO-8601.", "format": "date", "example": "2022-03-02" }, "From": { "title": "From", "allOf": [ { "$ref": "#/components/schemas/index-by-directions__GeoPoint" } ], "description": "Точка откуда.", "example": { "Id": 1 } }, "To": { "title": "To", "allOf": [ { "$ref": "#/components/schemas/index-by-directions__GeoPoint" } ], "description": "Точка куда.", "example": { "Id": 3611 } }, "CarType": { "title": "Cartype", "type": "string", "description": "Тип кузова.\n* `ref` – Рефрижераторы\n\n* `close` – Закрытые\n\n* `open` – Открытые\n\n* `all` – Все типы", "default": "all", "example": "ref" } } }, "LicenseIndexByDirectionResponse": { "title": "Ответ: Текущее состояние общего индекса", "required": [ "Data" ], "type": "object", "properties": { "Data": { "title": "Data", "type": "array", "items": { "$ref": "#/components/schemas/index-by-directions__LicenseTimePoint" }, "description": "Набор данных индекса" } } }, "index-by-directions__LicenseTimePoint": { "title": "Подпараметр ответа: Значение индекса в конкретную дату", "required": [ "Date", "Index" ], "type": "object", "properties": { "Date": { "title": "Date", "type": "string", "description": "Дата. Формат ISO-8601", "format": "date" }, "Index": { "title": "Index", "type": "integer", "description": "Значение индекса" } } }, "index-by-directions__ValidationError": { "title": "ValidationError", "required": [ "loc", "msg", "type" ], "type": "object", "properties": { "loc": { "title": "Location", "type": "array", "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] } }, "msg": { "title": "Message", "type": "string" }, "type": { "title": "Error Type", "type": "string" } } }, "LoadParamsApi": { "properties": { "from_city": { "type": "integer", "minimum": 1, "title": "ID города загрузки", "description": "Значение поля `id` в структуре `city`\nиз [словаря ATI.SU](https://ati.su/developers/api/dictionaries/geo/#post-v1-autocomplete-suggestions)", "example": 1 }, "to_city": { "type": "integer", "minimum": 1, "title": "ID города разгрузки", "description": "Значение поля `id` в структуре `city`\nиз [словаря ATI.SU](https://ati.su/developers/api/dictionaries/geo/#post-v1-autocomplete-suggestions)", "example": 3611 }, "cargo_type": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ], "title": "ID типа груза", "description": "Идентификатор наименования груза. Значение поля `dictionary_item_id`\nиз [словаря грузов ATI.SU](https://ati.su/developers/api/dictionaries/cargoes/#get-v1-cargo_typ)", "example": 46 }, "car_type": { "type": "integer", "minimum": 1, "title": "ID типа кузова", "description": "Тип кузова. Значение поля `mask` в структуре `attributes_dictionary`\nиз [словаря кузовов ATI.SU](https://ati.su/developers/api/dictionaries/cargoes/#get-v1-cartypes)", "example": 1 }, "volume": { "type": "number", "minimum": 0, "title": "Объем груза", "description": "Объем груза в кубических метрах.\nОбязателен, если не передан `weight`", "default": 0, "example": 23.4 }, "weight": { "type": "number", "minimum": 0, "title": "Вес груза", "description": "Вес груза в тоннах.\nОбязателен, если не передан `volume`", "default": 0, "example": 15 }, "distance": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Расстояние", "description": "Расстояние маршрута в километрах", "example": 700 }, "adr": { "anyOf": [ { "type": "integer", "maximum": 9, "minimum": 0 }, { "type": "null" } ], "title": "Опасность", "description": "Параметр, определяющий степень опасности груза.\nДопустимое значение: Null, либо от 0 до 9.", "default": 0, "example": 0 }, "dogruz": { "type": "string", "enum": [ "ftl", "dont-care" ], "title": "Загрузка", "description": "Загрузка:\n`ftl` — отдельной машиной,\n`dont-care` — отдельной машиной или догрузом", "example": "ftl" }, "path_type": { "type": "string", "enum": [ "one_way", "roundtrip" ], "title": "Тип маршрута", "description": "Тип маршрута: односторонний или кругорейс", "default": "one_way", "example": "one_way" }, "pallet_count": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Количество упаковок", "description": "Количество упаковок", "default": 0, "example": 3 }, "pack_type_id": { "anyOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "null" } ], "title": "Тип упаковки, по дефолту зануляем", "description": "ID типа упаковки. Значение поля `dictionary_item_id`\nиз [словаря типов упаковок ATI.SU](https://ati.su/developers/api/dictionaries/cargoes/#get-v1-pack_types)", "default": 0, "example": 1 } }, "type": "object", "required": [ "from_city", "to_city", "car_type", "dogruz" ], "title": "Запрос: входные параметры для API предсказания цены ", "description": "Запрос: входные параметры для API предсказания цены.", "example": { "car_type": 1, "distance": 700, "dogruz": "ftl", "from_city": 1, "to_city": 3611, "volume": 0, "weight": 15 } }, "PricePredictionResponseFormatRoot": { "properties": { "price_with_tax": { "anyOf": [ { "$ref": "#/components/schemas/ConcretePricePredictionResponseFormat" }, { "type": "null" } ], "description": "Цена с НДС 22%, руб" }, "price_without_tax": { "anyOf": [ { "$ref": "#/components/schemas/ConcretePricePredictionResponseFormat" }, { "type": "null" } ], "description": "Цена без НДС, руб" }, "price_with_cash": { "anyOf": [ { "$ref": "#/components/schemas/ConcretePricePredictionResponseFormat" }, { "type": "null" } ], "description": "Цена наличными, руб" }, "is_approximated": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Is Approximated", "description": "В случае, если параметр `true`, то у нас недостаточно данных\nпо направлению. Учтены дополнительные данные с похожих направлений.", "default": false } }, "type": "object", "title": "Ответ: предсказанные цены", "description": "Предсказанные цены перевозки для разных вариантов оплаты." }, "bazaar_api__ErrorFormatResponse": { "properties": { "error": { "type": "string", "title": "Error", "description": "Текстовый код ошибки", "example": "validation_errors" }, "reason": { "type": "string", "title": "Reason", "description": "Человекочитаемое описание ошибки", "example": "Произошли ошибки валидации" }, "details": { "anyOf": [ { "type": "object" }, { "type": "null" } ], "title": "Details", "description": "Дополнительные детали ошибки", "example": { "requested_id": 3611 } }, "error_list": { "anyOf": [ { "items": { "$ref": "#/components/schemas/ErrorItemResponse" }, "type": "array" }, { "type": "null" } ], "title": "Error List", "description": "Список ошибок, если их несколько (например, ошибки валидации)" } }, "type": "object", "required": [ "error", "reason" ], "title": "ErrorFormatResponse", "description": "Ответ с описанием ошибки." }, "ConcretePricePredictionResponseFormat": { "properties": { "price": { "type": "integer", "title": "Price", "description": "Цена перевозки в рублях.", "example": 41694 } }, "type": "object", "required": [ "price" ], "title": "ConcretePricePredictionResponseFormat", "description": "Предсказанная цена перевозки для одного варианта оплаты." }, "ErrorItemResponse": { "properties": { "error": { "type": "string", "title": "Error", "description": "Текстовый код ошибки", "example": "Тип поданного параметра отличается от ожидаемого - Значение должно быть >= 1!" }, "reason": { "type": "string", "title": "Reason", "description": "Человекочитаемое описание ошибки", "example": "location: ('body', 'from_city'); type: greater_than_equal" } }, "type": "object", "required": [ "error", "reason" ], "title": "ErrorItemResponse", "description": "Отдельная ошибка в списке ошибок." }, "CitiesInRadiusRequest": { "required": [ "cities_key", "city_id", "radius" ], "type": "object", "properties": { "city_id": { "type": "integer", "description": "Идентификатор населённого пункта", "format": "int32", "example": 1 }, "cities_key": { "type": "string", "description": "Ключ списка населённых пунктов для дополнительной фильтрации", "example": "active-cities" }, "within_country": { "type": "boolean", "description": "Искать населённые пункты только внутри страны\r\n\r\nЗначение по умолчанию: `true`", "example": true }, "limit": { "maximum": 10000, "minimum": 0, "type": "integer", "description": "Максимальное количество результатов\r\n\r\nМинимальное значение: `0`\r\nМаксимальное значение: `10000`\r\nЗначение по умолчанию: `0` без лимита", "format": "int32", "example": 10 }, "radius": { "maximum": 300000, "minimum": 1000, "type": "integer", "description": "Максимальное расстояние в метрах\r\n\r\nМинимальное значение: `1 000`\r\nМаксимальное значение: `300 000`", "format": "int32", "example": 300000 } }, "additionalProperties": false }, "CityIdWithDistance": { "type": "object", "properties": { "c": { "type": "integer", "description": "Идентификатор населённого пункта", "format": "int32" }, "d": { "type": "integer", "description": "Расстояние до населённого пункта в метрах", "format": "int32" } }, "additionalProperties": false, "description": "Информация о населённом пункте" }, "CityInfo": { "type": "object", "properties": { "city_id": { "type": "integer", "description": "Идентификатор города", "format": "int32" }, "name": { "type": "string", "description": "Название города" }, "city_size": { "enum": [ 1, 2, 3, 4, 5, 6 ], "type": "integer", "description": "Размер города

    Members:

    ", "format": "int32" } }, "additionalProperties": false, "description": "Информация о населённом пункте" }, "CityWithDistanceResponse": { "type": "object", "properties": { "city_id": { "type": "integer", "description": "Идентификатор населённого пункта", "format": "int32" }, "distance": { "type": "integer", "description": "Расстояние до населённого пункта по дорогам в метрах", "format": "int32" }, "time": { "type": "integer", "description": "Время в пути до населённого пункта в секундах", "format": "int32" } }, "additionalProperties": false, "description": "Информация о ближайшем населённом пункте" }, "CountryInfoResponse": { "type": "object", "properties": { "country_id": { "type": "integer", "description": "Идентификатор страны", "format": "int32" }, "name": { "type": "string", "description": "Название страны" } }, "additionalProperties": false, "description": "Информация о стране" }, "DistanceResponse": { "type": "object", "properties": { "status": { "type": "string", "description": "success - нашли маршрут по всем параметрам фильтра. without_restrictions - не нашли маршрут по всем параметрам фильтра, но нашли маршрут без ограничений" }, "platon_rate": { "type": "number", "description": "Стоимость проезда по Платону в рублях РФ", "format": "double", "readOnly": true }, "platon_distance": { "type": "integer", "description": "Общее расстояние, преодоленное по Платону в метрах", "format": "int32" }, "toll_distance": { "type": "integer", "description": "Общее расстояние платных дорог в метрах", "format": "int32" }, "total_distance": { "type": "integer", "description": "Расстояние в метрах", "format": "int32", "readOnly": true }, "travel_time": { "type": "integer", "description": "Время в пути в секундах с учетом параметров и задержек", "format": "int32" } }, "additionalProperties": false, "description": "Расстояние в метрах" }, "gis-rm__GeoPoint": { "type": "object", "properties": { "lat": { "type": "number", "description": "Широта", "format": "double" }, "lon": { "type": "number", "description": "Долгота", "format": "double" } }, "additionalProperties": false, "description": "Координаты точки" }, "GeoPointRequestModel": { "type": "object", "properties": { "lat": { "type": "number", "description": "Широта", "format": "double", "example": 59.8913 }, "lon": { "type": "number", "description": "Долгота", "format": "double", "example": 30.3727 } }, "additionalProperties": false, "description": "Координаты точки" }, "GeoPointResponseModel": { "type": "object", "properties": { "lat": { "type": "number", "description": "Широта", "format": "double" }, "lon": { "type": "number", "description": "Долгота", "format": "double" } }, "additionalProperties": false }, "GetDistanceRequest": { "required": [ "nodes" ], "type": "object", "properties": { "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/Node" }, "description": "Точки маршрута в порядке следования", "example": [ { "geo_point": { "lat": 59.974007, "lon": 30.333006 }, "node_id": 1, "type": 1 }, { "geo_point": { "lat": 55.80513, "lon": 37.506607 }, "node_id": 3611, "type": 2 } ] }, "options": { "$ref": "#/components/schemas/RouteOptionsRequest" } }, "additionalProperties": false, "description": "Фильтр маршрута" }, "GetNearestCitiesRequest": { "required": [ "start_point" ], "type": "object", "properties": { "start_point": { "$ref": "#/components/schemas/Node" }, "radius": { "maximum": 300000, "minimum": 1000, "type": "integer", "description": "Радиус поиска в метрах\r\n\nЗначение по умолчанию: `200000`\nМаксимальное значение: `300000`", "format": "int32", "example": 200000 }, "cities_count": { "maximum": 20, "minimum": 1, "type": "integer", "description": "Количество населённых пунктов в выдаче\r\n\nЗначение по умолчанию: `5`\nМаксимальное значение: `20`", "format": "int32", "example": 5 }, "large_cities_count": { "maximum": 20, "minimum": 0, "type": "integer", "description": "Количество крупных населённых пунктов в выдаче (население от 100 000 человек)\r\n\nЗначение по умолчанию: `3`\nМаксимальное значение: `20`", "format": "int32", "example": 3 } }, "additionalProperties": false }, "GetRouteInfoIntegratorRequest": { "required": [ "nodes" ], "type": "object", "properties": { "options": { "$ref": "#/components/schemas/RouteOptionsRequest" }, "map_bounds": { "$ref": "#/components/schemas/MapBounds" }, "nodes": { "type": "array", "items": { "$ref": "#/components/schemas/RouteInfoNode" }, "description": "Точки маршрута в порядке следования", "example": [ { "geo_point": { "lat": 59.974007, "lon": 30.333006 }, "node_id": 1, "type": 1 }, { "geo_point": { "lat": 55.80513, "lon": 37.506607 }, "node_id": 3611, "type": 2 } ] }, "exclude_regions": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Не заезжать в указанные регионы", "nullable": true, "example": [ 15 ] }, "exclude_countries": { "uniqueItems": true, "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Не заезжать в указанные страны", "nullable": true, "example": [ 2 ] } }, "additionalProperties": false, "description": "Фильтр маршрута" }, "MapBounds": { "type": "object", "properties": { "north_east": { "$ref": "#/components/schemas/MapBoundsNorthEastGeoPointRequestModel" }, "south_west": { "$ref": "#/components/schemas/MapBoundsSouthWestGeoPointRequestModel" } }, "additionalProperties": false, "description": "Границы видимой части карты" }, "MapBoundsNorthEastGeoPointRequestModel": { "type": "object", "properties": { "lat": { "type": "number", "description": "Широта", "format": "double", "example": 60.86631 }, "lon": { "type": "number", "description": "Долгота", "format": "double", "example": 44.121094 } }, "additionalProperties": false, "description": "Координаты точки" }, "MapBoundsSouthWestGeoPointRequestModel": { "type": "object", "properties": { "lat": { "type": "number", "description": "Широта", "format": "double", "example": 54.591164 }, "lon": { "type": "number", "description": "Долгота", "format": "double", "example": 23.192139 } }, "additionalProperties": false, "description": "Координаты точки" }, "Node": { "type": "object", "properties": { "node_id": { "type": "integer", "description": "Идентификатор населённого пункта", "format": "int32", "nullable": true, "example": 1 }, "geo_point": { "$ref": "#/components/schemas/GeoPointRequestModel" } }, "additionalProperties": false, "description": "Точка" }, "RegionInfoResponse": { "type": "object", "properties": { "region_id": { "type": "integer", "description": "Идентификатор региона", "format": "int32" }, "name": { "type": "string", "description": "Название региона" } }, "additionalProperties": false, "description": "Информация о регионе" }, "RouteDetailsResponse": { "type": "object", "properties": { "track_names": { "uniqueItems": true, "type": "array", "items": { "type": "string" }, "description": "Названия трасс, которые есть в сегменте", "readOnly": true }, "ferry_distance": { "type": "integer", "description": "Расстояние по парому в метрах", "format": "int32", "readOnly": true }, "other_type_distance": { "type": "integer", "description": "Расстояние, преодоленное по дорогам второго класса и ниже в метрах", "format": "int32", "readOnly": true }, "winter_road_distance": { "type": "integer", "description": "Расстояние по зимнику в метрах", "format": "int32", "readOnly": true }, "common_distance": { "type": "integer", "description": "Расстояние по дорогам общего пользования в метрах", "format": "int32", "readOnly": true }, "trunk_distance": { "type": "integer", "description": "Расстояние по трассам в метрах", "format": "int32", "readOnly": true }, "motorway_distance": { "type": "integer", "description": "Расстояние по автомагистралям в метрах", "format": "int32", "readOnly": true }, "platon_distance": { "type": "integer", "description": "Расстояние, преодоленное по Платону в метрах", "format": "int32", "readOnly": true }, "toll_distance": { "type": "integer", "description": "Расстояние, преодоленное по платным дорогам в метрах", "format": "int32", "readOnly": true }, "mkad_distance": { "type": "integer", "description": "Расстояние, преодоленное по МКАДу в метрах", "format": "int32", "readOnly": true }, "total_distance": { "type": "integer", "description": "Общее расстояние сегмента в метрах", "format": "int32", "readOnly": true }, "total_time": { "type": "integer", "description": "Общее время проезда по сегменту в секундах", "format": "int32" } }, "additionalProperties": false, "description": "Информация об отрезке" }, "RouteInfoNode": { "type": "object", "properties": { "node_id": { "type": "integer", "description": "Идентификатор населённого пункта", "format": "int32", "nullable": true, "example": 1 }, "geo_point": { "$ref": "#/components/schemas/GeoPointRequestModel" }, "type": { "enum": [ 0, 1, 2, 4, 8, 16, 32, 64 ], "type": "integer", "description": "Тип точки маршрута. Может быть маской.

    Members:

    ", "format": "int32" } }, "additionalProperties": false }, "RouteInfoResponse": { "type": "object", "properties": { "segments": { "type": "array", "items": { "$ref": "#/components/schemas/RouteInfoSegmentResponse" }, "description": "Сегменты маршрута", "readOnly": true } }, "additionalProperties": false, "description": "Информация о попутных городах маршрута и названиях дорог" }, "RouteInfoSegmentResponse": { "type": "object", "properties": { "route_point": { "$ref": "#/components/schemas/RoutePointResponse" }, "route_details": { "$ref": "#/components/schemas/RouteDetailsResponse" } }, "additionalProperties": false, "description": "Сегмент маршрута" }, "RouteOptionsRequest": { "type": "object", "properties": { "within_country": { "type": "boolean", "description": "Строить маршрут внутри одной страны\r\n\nЗначение по умолчанию: `true`" }, "exclude_mkad": { "type": "boolean", "description": "Не заезжать на МКАД\r\n\nЗначение по умолчанию: `false`" }, "exclude_ukraine": { "type": "boolean", "description": "Не заезжать в Украину\r\n\nЗначение по умолчанию: `true`" }, "allow_ferry": { "type": "boolean", "description": "Разрешить проезд по паромам\nПри передаче значения по умолчанию будет учитываться расписание (пока расписания нет, поэтому всегда разрешены)\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "allow_winter_road": { "type": "boolean", "description": "Разрешить проезд по зимникам\nПри передаче значения по умолчанию будет учитываться расписание (декабрь, январь, февраль - зимники разрешены, остальные месяцы - запрещены)\r\n\nЗначение по умолчанию: `null`", "nullable": true }, "allow_toll_road": { "type": "boolean", "description": "Разрешить проезд по платным трассам\r\n\nЗначение по умолчанию: `true`" }, "strategy": { "enum": [ 1, 2 ], "type": "integer", "description": "Тип маршрута для поиска\r\n\nЗначение по умолчанию: `2`

    Members:

    Members:

    ", "format": "int32", "example": 1 }, "customs_delay": { "maximum": 10080, "minimum": 0, "type": "integer", "description": "Задержка при пересечении границы в минутах\r\n\nЗначение по умолчанию: `120`", "format": "int32", "example": 120 }, "ferry_delay": { "maximum": 10080, "minimum": 0, "type": "integer", "description": "Задержка при использовании паромов в минутах\r\n\nЗначение по умолчанию: `120`", "format": "int32", "example": 120 }, "max_speed": { "maximum": 150, "minimum": 30, "type": "integer", "description": "Максимальная скорость транспортного средства в км/ч\r\n\nЗначение по умолчанию: `110`", "format": "int32", "example": 110 }, "weight": { "maximum": 120000, "minimum": 1, "type": "integer", "description": "Полная масса транспортного средства в килограммах\r\n\nЗначение по умолчанию: `10 000`", "format": "int32", "example": 10000 } }, "additionalProperties": false, "description": "Ограничения маршрута" }, "RoutePointResponse": { "type": "object", "properties": { "node_types": { "enum": [ 0, 1, 2, 4, 8, 16, 32, 64 ], "type": "integer", "description": "Тип точки маршрута. Может быть маской.

    Members:

    ", "format": "int32", "readOnly": true }, "city_info": { "$ref": "#/components/schemas/CityInfo" }, "geo_point": { "$ref": "#/components/schemas/GeoPointResponseModel" }, "region_info": { "$ref": "#/components/schemas/RegionInfoResponse" }, "country_info": { "$ref": "#/components/schemas/CountryInfoResponse" } }, "additionalProperties": false }, "gis-rm__RouteResponse": { "required": [ "platon_distance", "platon_rate", "status", "toll_distance", "total_distance", "travel_time" ], "type": "object", "properties": { "route_info": { "$ref": "#/components/schemas/RouteInfoResponse" }, "visual_route": { "$ref": "#/components/schemas/VisualRouteResponse" }, "status": { "type": "string", "description": "success - нашли маршрут по всем параметрам фильтра. without_restrictions - не нашли маршрут по всем параметрам фильтра, но нашли маршрут без ограничений" }, "platon_rate": { "type": "number", "description": "Стоимость проезда по Платону в рублях РФ", "format": "double" }, "platon_distance": { "type": "integer", "description": "Общее расстояние, преодоленное по Платону в метрах", "format": "int32" }, "toll_distance": { "type": "integer", "description": "Общее расстояние платных дорог в метрах", "format": "int32" }, "total_distance": { "type": "integer", "description": "Общее расстояние в метрах", "format": "int32" }, "travel_time": { "type": "integer", "description": "Время в пути в секундах с учетом параметров и задержек", "format": "int32" } }, "additionalProperties": false }, "SingleErrorResponse": { "type": "object", "properties": { "error": { "type": "string", "description": "Текстовый код ошибки" }, "reason": { "type": "string", "description": "Человекочитаемое описание ошибки" }, "details": { "type": "object", "additionalProperties": {}, "description": "Дополнительная информация об ошибке", "nullable": true } }, "additionalProperties": false, "description": "" }, "ValidationErrorResponse": { "type": "object", "properties": { "error": { "type": "string", "readOnly": true }, "reason": { "type": "string", "readOnly": true }, "error_list": { "type": "array", "items": { "$ref": "#/components/schemas/SingleErrorResponse" } }, "details": { "type": "object", "additionalProperties": {}, "nullable": true } }, "additionalProperties": false }, "VisualRouteResponse": { "type": "object", "properties": { "segments": { "type": "array", "items": { "$ref": "#/components/schemas/VisualRouteSegmentResponse" }, "description": "Координаты отрезка маршрута" } }, "additionalProperties": false, "description": "Координаты точек маршрута" }, "VisualRouteSegmentResponse": { "type": "object", "properties": { "fare_visualization_type": { "enum": [ 1, 2, 4, 8 ], "type": "integer", "description": "Тип платности дороги для визуализации (раскраска дорог)

    Members:

    Members:

    ", "format": "int32" }, "geo_points": { "type": "array", "items": { "type": "array", "items": { "$ref": "#/components/schemas/gis-rm__GeoPoint" } }, "description": "Координаты точек отрезка маршрута" }, "distance": { "type": "integer", "description": "Расстояние в метрах", "format": "int32" } }, "additionalProperties": false, "description": "Отрезок маршрута" } }, "parameters": { "FileId": { "name": "file_id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Идентификатор файла" } }, "responses": { "AvatarUploadInfo": { "description": "Информация о загруженной аватарке/логотипе", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean", "description": "Идентификатор успешности запроса" }, "url": { "type": "string", "description": "Ссылка на сохраненный аватар" }, "name": { "type": "string", "description": "Имя сохраненной аватарки" } } } } } }, "CommonError": { "description": "Ошибка запроса", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommonError" } } } } }, "requestBodies": { "Body": { "content": { "application/*+json": { "schema": { "description": "Идентификаторы элементов", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "application/json": { "schema": { "description": "Идентификаторы элементов", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "application/json-patch+json": { "schema": { "description": "Идентификаторы элементов", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "text/json": { "schema": { "description": "Идентификаторы элементов", "items": { "format": "uuid", "type": "string" }, "type": "array" } } }, "description": "Идентификаторы элементов" }, "FirmListElementPublicFirmListPublic": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/FirmListElementPublicFirmListPublicBody" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FirmListElementPublicFirmListPublicBody" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/FirmListElementPublicFirmListPublicBody" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FirmListElementPublicFirmListPublicBody" } } }, "description": "Список фирм" }, "GeoListElementPublicGeoListPublic": { "content": { "application/*+json": { "schema": { "$ref": "#/components/schemas/GeoListElementPublicGeoListPublic" } }, "application/json": { "schema": { "$ref": "#/components/schemas/GeoListElementPublicGeoListPublic" } }, "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/GeoListElementPublicGeoListPublic" } }, "text/json": { "schema": { "$ref": "#/components/schemas/GeoListElementPublicGeoListPublic" } } } } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Authorization: Bearer {authorizationToken}" }, "JWT": { "description": "Bearer {access_token}", "in": "header", "name": "Authorization", "type": "apiKey" }, "catalogs__JWT": { "type": "apiKey", "description": "Bearer {access_token}", "name": "Authorization", "in": "header" }, "ApiSecret": { "type": "apiKey", "name": "X-Api-Secret", "in": "header" }, "Bearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" }, "AuthenticatedUserId": { "type": "apiKey", "name": "X-Authenticated-Userid", "in": "header" } } } }