{ "openapi": "3.0.3", "info": { "title": "Better Sales Pro API", "version": "1.0.0", "description": "Versioned staff API. Authenticate with POST /login, then send Authorization: Bearer . Rate limits are not enforced (rest_enable_limits is off). OAuth 2.1 is proposed and not implemented." }, "servers": [ { "url": "https://bettersalespro.com/api/v1" } ], "paths": { "/allocateLocalNumber": { "post": { "operationId": "allocateLocalNumber_post", "summary": "allocateLocalNumber", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/createPhoneComplianceBrand": { "post": { "operationId": "createPhoneComplianceBrand_post", "summary": "createPhoneComplianceBrand", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/createPhoneComplianceCampaign": { "post": { "operationId": "createPhoneComplianceCampaign_post", "summary": "createPhoneComplianceCampaign", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/credit_note": { "get": { "operationId": "credit_note_get", "summary": "credit_note", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "operationId": "credit_note_post", "summary": "credit_note", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/credit_note_delete": { "post": { "operationId": "credit_note_delete_post", "summary": "credit_note_delete", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/credit_note_form_data": { "get": { "operationId": "credit_note_form_data_get", "summary": "credit_note_form_data", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] } }, "/credit_note_search": { "post": { "operationId": "credit_note_search_post", "summary": "credit_note_search", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/credit_note_update": { "post": { "operationId": "credit_note_update_post", "summary": "credit_note_update", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/credit_note_void": { "post": { "operationId": "credit_note_void_post", "summary": "credit_note_void", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/credit_notes_list": { "get": { "operationId": "credit_notes_list_get", "summary": "credit_notes_list", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] } }, "/getPhoneCompliance": { "get": { "operationId": "getPhoneCompliance_get", "summary": "getPhoneCompliance", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] } }, "/getSmsTextSettings": { "get": { "operationId": "getSmsTextSettings_get", "summary": "getSmsTextSettings", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] } }, "/getStaffProfile": { "get": { "operationId": "getStaffProfile_get", "summary": "getStaffProfile", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] } }, "/get_group_video_context": { "get": { "operationId": "get_group_video_context_get", "summary": "get_group_video_context", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "operationId": "get_group_video_context_post", "summary": "get_group_video_context", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/get_livekit_token": { "post": { "operationId": "get_livekit_token_post", "summary": "get_livekit_token", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/group_chat_unread": { "get": { "operationId": "group_chat_unread_get", "summary": "group_chat_unread", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] } }, "/inventory_catalog_lookup": { "get": { "operationId": "inventory_catalog_lookup_get", "summary": "inventory_catalog_lookup", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] } }, "/inventory_item": { "get": { "operationId": "inventory_item_get", "summary": "inventory_item", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "operationId": "inventory_item_post", "summary": "inventory_item", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/inventory_item_adjust_stock": { "post": { "operationId": "inventory_item_adjust_stock_post", "summary": "inventory_item_adjust_stock", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/inventory_item_cycle_count": { "post": { "operationId": "inventory_item_cycle_count_post", "summary": "inventory_item_cycle_count", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/inventory_item_delete": { "post": { "operationId": "inventory_item_delete_post", "summary": "inventory_item_delete", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/inventory_item_duplicate": { "post": { "operationId": "inventory_item_duplicate_post", "summary": "inventory_item_duplicate", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/inventory_item_lookup": { "get": { "operationId": "inventory_item_lookup_get", "summary": "inventory_item_lookup", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] } }, "/inventory_item_receive_direct": { "post": { "operationId": "inventory_item_receive_direct_post", "summary": "inventory_item_receive_direct", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/inventory_item_transfer": { "post": { "operationId": "inventory_item_transfer_post", "summary": "inventory_item_transfer", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/inventory_list": { "get": { "operationId": "inventory_list_get", "summary": "inventory_list", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] } }, "/invoices": { "get": { "operationId": "invoices_get", "summary": "invoices", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] } }, "/listLocalNumbers": { "get": { "operationId": "listLocalNumbers_get", "summary": "listLocalNumbers", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] } }, "/login": { "post": { "operationId": "login_post", "summary": "login", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/project_qr_code": { "get": { "operationId": "project_qr_code_get", "summary": "project_qr_code", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "operationId": "project_qr_code_post", "summary": "project_qr_code", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/project_qr_code_delete": { "post": { "operationId": "project_qr_code_delete_post", "summary": "project_qr_code_delete", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/project_qr_codes": { "get": { "operationId": "project_qr_codes_get", "summary": "project_qr_codes", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] } }, "/project_qr_lookup": { "get": { "operationId": "project_qr_lookup_get", "summary": "project_qr_lookup", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] } }, "/purchase_order": { "get": { "operationId": "purchase_order_get", "summary": "purchase_order", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "operationId": "purchase_order_post", "summary": "purchase_order", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/purchase_order_approve": { "post": { "operationId": "purchase_order_approve_post", "summary": "purchase_order_approve", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/purchase_order_comm_log": { "post": { "operationId": "purchase_order_comm_log_post", "summary": "purchase_order_comm_log", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/purchase_order_delete": { "post": { "operationId": "purchase_order_delete_post", "summary": "purchase_order_delete", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/purchase_order_form_data": { "get": { "operationId": "purchase_order_form_data_get", "summary": "purchase_order_form_data", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] } }, "/purchase_order_receive": { "post": { "operationId": "purchase_order_receive_post", "summary": "purchase_order_receive", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/purchase_order_reject": { "post": { "operationId": "purchase_order_reject_post", "summary": "purchase_order_reject", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/purchase_order_search": { "post": { "operationId": "purchase_order_search_post", "summary": "purchase_order_search", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/purchase_order_settings": { "get": { "operationId": "purchase_order_settings_get", "summary": "purchase_order_settings", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "operationId": "purchase_order_settings_post", "summary": "purchase_order_settings", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/purchase_order_submit": { "post": { "operationId": "purchase_order_submit_post", "summary": "purchase_order_submit", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/purchase_order_update": { "post": { "operationId": "purchase_order_update_post", "summary": "purchase_order_update", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/purchase_orders_list": { "get": { "operationId": "purchase_orders_list_get", "summary": "purchase_orders_list", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] } }, "/recent_contacts": { "get": { "operationId": "recent_contacts_get", "summary": "recent_contacts", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] } }, "/recent_property": { "get": { "operationId": "recent_property_get", "summary": "recent_property", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] } }, "/saveSmsTextSetting": { "post": { "operationId": "saveSmsTextSetting_post", "summary": "saveSmsTextSetting", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/staff_login_with_faceid": { "post": { "operationId": "staff_login_with_faceid_post", "summary": "staff_login_with_faceid", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/verify_2fa": { "post": { "operationId": "verify_2fa_post", "summary": "verify_2fa", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/video_conference_settings": { "get": { "operationId": "video_conference_settings_get", "summary": "video_conference_settings", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "operationId": "video_conference_settings_post", "summary": "video_conference_settings", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/video_meeting_add_participant": { "post": { "operationId": "video_meeting_add_participant_post", "summary": "video_meeting_add_participant", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/video_meeting_cancel_ring": { "post": { "operationId": "video_meeting_cancel_ring_post", "summary": "video_meeting_cancel_ring", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/video_meeting_create": { "post": { "operationId": "video_meeting_create_post", "summary": "video_meeting_create", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/video_meeting_decline": { "post": { "operationId": "video_meeting_decline_post", "summary": "video_meeting_decline", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/video_meeting_end": { "post": { "operationId": "video_meeting_end_post", "summary": "video_meeting_end", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/video_meeting_find_active": { "get": { "operationId": "video_meeting_find_active_get", "summary": "video_meeting_find_active", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] } }, "/video_meeting_get": { "get": { "operationId": "video_meeting_get_get", "summary": "video_meeting_get", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "operationId": "video_meeting_get_post", "summary": "video_meeting_get", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/video_meeting_invite": { "post": { "operationId": "video_meeting_invite_post", "summary": "video_meeting_invite", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/video_meeting_join": { "post": { "operationId": "video_meeting_join_post", "summary": "video_meeting_join", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/video_meeting_leave": { "post": { "operationId": "video_meeting_leave_post", "summary": "video_meeting_leave", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/video_meeting_log": { "post": { "operationId": "video_meeting_log_post", "summary": "video_meeting_log", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/video_meeting_remove": { "post": { "operationId": "video_meeting_remove_post", "summary": "video_meeting_remove", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/video_meeting_ring": { "post": { "operationId": "video_meeting_ring_post", "summary": "video_meeting_ring", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/video_meeting_ring_all": { "post": { "operationId": "video_meeting_ring_all_post", "summary": "video_meeting_ring_all", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/video_meeting_search_staff": { "get": { "operationId": "video_meeting_search_staff_get", "summary": "video_meeting_search_staff", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "operationId": "video_meeting_search_staff_post", "summary": "video_meeting_search_staff", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/video_meeting_send_chat": { "post": { "operationId": "video_meeting_send_chat_post", "summary": "video_meeting_send_chat", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/video_meeting_staff_activity": { "post": { "operationId": "video_meeting_staff_activity_post", "summary": "video_meeting_staff_activity", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/video_meeting_transfer_host": { "post": { "operationId": "video_meeting_transfer_host_post", "summary": "video_meeting_transfer_host", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/video_notifications": { "get": { "operationId": "video_notifications_get", "summary": "video_notifications", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "operationId": "video_notifications_post", "summary": "video_notifications", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/video_signaling": { "get": { "operationId": "video_signaling_get", "summary": "video_signaling", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "operationId": "video_signaling_post", "summary": "video_signaling", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } }, "/video_staff_avatar": { "get": { "operationId": "video_staff_avatar_get", "summary": "video_staff_avatar", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] } }, "/work_order_settings": { "get": { "operationId": "work_order_settings_get", "summary": "work_order_settings", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ] }, "post": { "operationId": "work_order_settings_post", "summary": "work_order_settings", "responses": { "200": { "description": "JSON envelope", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Envelope" } } } }, "401": { "description": "Missing or invalid token" }, "404": { "description": "Unknown route" }, "405": { "description": "Wrong HTTP verb for a real route" } }, "security": [ { "bearerAuth": [] } ], "requestBody": { "required": false, "content": { "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } } } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "Staff token from POST /api/v1/login or Settings \u2192 API / Developers." } }, "schemas": { "Envelope": { "type": "object", "properties": { "status": { "type": "boolean" }, "message": { "type": "string" }, "error": { "type": "string" }, "data": { "nullable": true } } } } } }