{ "openapi": "3.1.1", "info": { "title": "API de integração Mucanda", "description": "Acesso, por chave de API, aos dados e às operações da própria empresa. Autenticação no cabeçalho X-Api-Key; erros em application/problem+json com um código estável.", "version": "1" }, "servers": [ { "url": "https://", "description": "O endereço da sua instalação do Mucanda" } ], "paths": { "/api/rh/remuneracoes/trabalhadores": { "get": { "tags": [ "RH - Rubricas" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/assiduidade/trabalhadores": { "get": { "tags": [ "RH - Assiduidade" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/assiduidade/calendario": { "get": { "tags": [ "RH - Assiduidade" ], "parameters": [ { "name": "ano", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "mes", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/componentes/{id}/encerrar": { "post": { "tags": [ "RH - Rubricas" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EncerrarComponenteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/auditoria/acessos": { "get": { "tags": [ "RH - Auditoria" ], "parameters": [ { "name": "categoria", "in": "query", "schema": { "$ref": "#/components/schemas/CategoriaAcessoSensivel" } }, { "name": "utilizadorId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "desde", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "ate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 200 } }, { "name": "chaveApiId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/parametros-legais": { "get": { "tags": [ "RH - Parâmetros legais" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/saft": { "get": { "tags": [ "SAF-T" ], "parameters": [ { "name": "dataInicio", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "dataFim", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/conformidade/integridade": { "get": { "tags": [ "AnySoftSaaSWeb.Api" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/conformidade/integridade/verificar": { "post": { "tags": [ "AnySoftSaaSWeb.Api" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/conformidade/dever-de-reporte": { "get": { "tags": [ "AnySoftSaaSWeb.Api" ], "parameters": [ { "name": "ano", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/conformidade/dever-de-reporte/{documentoId}/reportada": { "post": { "tags": [ "AnySoftSaaSWeb.Api" ], "parameters": [ { "name": "documentoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MarcarReporteRequest" } ] } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/saft/cadeia-assinaturas": { "get": { "tags": [ "SAF-T" ], "parameters": [ { "name": "tipoDocumentoId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "ano", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerificacaoCadeiaDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/saft/compras/resumo": { "get": { "tags": [ "SAF-T" ], "parameters": [ { "name": "periodo", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResumoSaftComprasDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/saft/compras": { "get": { "tags": [ "SAF-T" ], "parameters": [ { "name": "periodo", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/saft/inventario/resumo": { "get": { "tags": [ "SAF-T" ], "parameters": [ { "name": "anoFiscal", "in": "query", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResumoSaftInventarioDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/saft/inventario": { "get": { "tags": [ "SAF-T" ], "parameters": [ { "name": "anoFiscal", "in": "query", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "formato", "in": "query", "schema": { "default": "Xml", "$ref": "#/components/schemas/FormatoSaftInventario" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/produtos": { "post": { "tags": [ "Produtos" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProdutoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "get": { "tags": [ "Produtos" ], "parameters": [ { "name": "filtro", "in": "query", "schema": { "type": "string" } }, { "name": "apenasActivos", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "paraVenda", "in": "query", "schema": { "type": "boolean" } }, { "name": "alteradoDesde", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "estocavel", "in": "query", "schema": { "type": "boolean" } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginaResultadoOfProdutoResumoDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/produtos/{id}": { "get": { "tags": [ "Produtos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProdutoDetalheDto" } } } }, "404": { "description": "Not Found" } }, "security": [ { "ChaveApi": [] } ] }, "put": { "tags": [ "Produtos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateProdutoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/produtos/pesquisa-venda": { "get": { "tags": [ "Produtos" ], "parameters": [ { "name": "filtro", "in": "query", "schema": { "type": "string" } }, { "name": "armazemId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 20 } }, { "name": "produtoIds", "in": "query", "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProdutoVendaDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/produtos/mais-vendidos-pdv": { "get": { "tags": [ "Produtos" ], "parameters": [ { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "dias", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 30 } }, { "name": "quantos", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 24 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/produtos/sincronizacao-venda": { "get": { "tags": [ "Produtos" ], "parameters": [ { "name": "armazemId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 200 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginaResultadoOfProdutoVendaDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/produtos/{id}/historico-custos": { "get": { "tags": [ "Produtos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HistoricoCustoProdutoDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/produtos/{id}/composicao": { "put": { "tags": [ "Produtos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LinhaComposicaoInput" } } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/produtos/grupos-variacao": { "get": { "tags": [ "Produtos" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GrupoVariacaoDto" } } } } } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Produtos" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NomeDoGrupoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/produtos/grupos-variacao/{id}": { "put": { "tags": [ "Produtos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NomeDoGrupoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "delete": { "tags": [ "Produtos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/produtos/{id}/variacao": { "put": { "tags": [ "Produtos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefinirVariacaoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/produtos/{id}/variacoes": { "post": { "tags": [ "Produtos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarVariacaoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/produtos/{id}/variacoes/em-serie": { "post": { "tags": [ "Produtos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarVariacoesEmSerieRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/produtos/{id}/unidades-venda": { "put": { "tags": [ "Produtos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LinhaUnidadeVendaInput" } } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/produtos/{id}/activar": { "post": { "tags": [ "Produtos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/produtos/{id}/desactivar": { "post": { "tags": [ "Produtos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/produtos/catalogos/{tipo}": { "post": { "tags": [ "Produtos" ], "parameters": [ { "name": "tipo", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/TipoCatalogoProduto" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarCatalogoItemRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "get": { "tags": [ "Produtos" ], "parameters": [ { "name": "tipo", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/TipoCatalogoProduto" } }, { "name": "apenasActivos", "in": "query", "schema": { "type": "boolean", "default": true } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginaResultadoOfCatalogoItemDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/produtos/catalogos/{tipo}/{id}": { "put": { "tags": [ "Produtos" ], "parameters": [ { "name": "tipo", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/TipoCatalogoProduto" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarCatalogoItemRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/produtos/catalogos/{tipo}/{id}/activar": { "post": { "tags": [ "Produtos" ], "parameters": [ { "name": "tipo", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/TipoCatalogoProduto" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/produtos/catalogos/{tipo}/{id}/desactivar": { "post": { "tags": [ "Produtos" ], "parameters": [ { "name": "tipo", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/TipoCatalogoProduto" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/promocoes": { "get": { "tags": [ "Promoções" ], "parameters": [ { "name": "situacao", "in": "query", "schema": { "$ref": "#/components/schemas/SituacaoPromocao" } }, { "name": "pesquisa", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Promoções" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DadosPromocao" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/promocoes/relatorio": { "get": { "tags": [ "Promoções" ], "parameters": [ { "name": "dataInicio", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "dataFim", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/promocoes/pdv": { "get": { "tags": [ "Promoções" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/promocoes/{id}": { "get": { "tags": [ "Promoções" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "put": { "tags": [ "Promoções" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DadosPromocao" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/promocoes/{id}/aprovar": { "post": { "tags": [ "Promoções" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/promocoes/{id}/pausar": { "post": { "tags": [ "Promoções" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MotivoRequest" } ] } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/promocoes/{id}/retomar": { "post": { "tags": [ "Promoções" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/promocoes/{id}/reabrir": { "post": { "tags": [ "Promoções" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/promocoes/{id}/terminar": { "post": { "tags": [ "Promoções" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/MotivoRequest" } ] } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/promocoes/{id}/duplicar": { "post": { "tags": [ "Promoções" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/promocoes/simular": { "post": { "tags": [ "Promoções" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SimularPromocoesQuery" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/clientes": { "post": { "tags": [ "Clientes" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateClienteCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "get": { "tags": [ "Clientes" ], "parameters": [ { "name": "filtro", "in": "query", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "alteradoDesde", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginaResultadoOfClienteResumoDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/clientes/{id}": { "get": { "tags": [ "Clientes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClienteDetalheDto" } } } }, "404": { "description": "Not Found" } }, "security": [ { "ChaveApi": [] } ] }, "put": { "tags": [ "Clientes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateClienteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "delete": { "tags": [ "Clientes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/clientes/{id}/resumo": { "get": { "tags": [ "Clientes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClienteResumoComprasDto" } } } }, "404": { "description": "Not Found" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/clientes/{id}/extracto": { "get": { "tags": [ "Clientes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginaResultadoOfMovimentoClienteDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/clientes/{id}/extracto/pdf": { "get": { "tags": [ "Clientes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "de", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "ate", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/clientes/{id}/extracto/enviar": { "post": { "tags": [ "Clientes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnviarExtractoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/clientes/{id}/movimentos": { "post": { "tags": [ "Clientes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistarMovimentoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/fornecedores": { "post": { "tags": [ "Fornecedores" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFornecedorCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "get": { "tags": [ "Fornecedores" ], "parameters": [ { "name": "filtro", "in": "query", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "alteradoDesde", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginaResultadoOfFornecedorResumoDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/fornecedores/{id}": { "get": { "tags": [ "Fornecedores" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FornecedorDetalheDto" } } } }, "404": { "description": "Not Found" } }, "security": [ { "ChaveApi": [] } ] }, "put": { "tags": [ "Fornecedores" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFornecedorRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "delete": { "tags": [ "Fornecedores" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/departamentos": { "get": { "tags": [ "RH - Estrutura" ], "parameters": [ { "name": "incluirInactivos", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "RH - Estrutura" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarDepartamentoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/departamentos/{id}": { "put": { "tags": [ "RH - Estrutura" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DepartamentoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/departamentos/{id}/activo": { "put": { "tags": [ "RH - Estrutura" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/cargos": { "get": { "tags": [ "RH - Estrutura" ], "parameters": [ { "name": "incluirInactivos", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "RH - Estrutura" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarCargoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/cargos/{id}": { "put": { "tags": [ "RH - Estrutura" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CargoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/cargos/{id}/activo": { "put": { "tags": [ "RH - Estrutura" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/funcionarios": { "get": { "tags": [ "RH - Trabalhadores" ], "parameters": [ { "name": "filtro", "in": "query", "schema": { "type": "string" } }, { "name": "estado", "in": "query", "schema": { "$ref": "#/components/schemas/EstadoFuncionario" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "RH - Trabalhadores" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarFuncionarioCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/funcionarios/resumo": { "get": { "tags": [ "RH - Trabalhadores" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/funcionarios/alertas-documentos": { "get": { "tags": [ "RH - Trabalhadores" ], "parameters": [ { "name": "dias", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 60 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/funcionarios/{id}": { "get": { "tags": [ "RH - Trabalhadores" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "put": { "tags": [ "RH - Trabalhadores" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DadosFuncionario" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/funcionarios/{id}/contratos": { "post": { "tags": [ "RH - Trabalhadores" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlterarContratoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/funcionarios/{id}/contas-bancarias": { "put": { "tags": [ "RH - Trabalhadores" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DadosContaBancariaFuncionario" } } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/funcionarios/{id}/dependentes": { "put": { "tags": [ "RH - Trabalhadores" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DadosDependente" } } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/funcionarios/{id}/estado": { "put": { "tags": [ "RH - Trabalhadores" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstadoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/funcionarios/{id}/situacoes": { "get": { "tags": [ "RH - Trabalhadores" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/funcionarios/{id}/cessar": { "post": { "tags": [ "RH - Trabalhadores" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CessarRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/funcionarios/{id}/componentes": { "get": { "tags": [ "RH - Trabalhadores" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "RH - Trabalhadores" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefinirComponenteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/funcionarios/{id}/habilitacoes": { "get": { "tags": [ "RH - Trabalhadores" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "put": { "tags": [ "RH - Trabalhadores" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefinirHabilitacoesRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/funcionarios/{id}/situacao-fiscal": { "get": { "tags": [ "RH - Trabalhadores" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "RH - Trabalhadores" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefinirSituacaoFiscalRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/funcionarios/{id}/recibos": { "get": { "tags": [ "RH - Trabalhadores" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/configuracao": { "get": { "tags": [ "RH - Configuração" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/configuracao/historico": { "get": { "tags": [ "RH - Configuração" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/configuracao/aceitar-padroes": { "post": { "tags": [ "RH - Configuração" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AceitarPadroesRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/configuracao/{pergunta}": { "put": { "tags": [ "RH - Configuração" ], "parameters": [ { "name": "pergunta", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/PerguntaRh" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RespostaRhRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/calendario": { "get": { "tags": [ "RH - Calendário" ], "parameters": [ { "name": "ano", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/calendario/feriados": { "post": { "tags": [ "RH - Calendário" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeriadoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/calendario/feriados-nacionais": { "get": { "tags": [ "RH - Calendário" ], "parameters": [ { "name": "ano", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "pontes", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "RH - Calendário" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarregarFeriadosNacionaisRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/calendario/feriados/{id}": { "put": { "tags": [ "RH - Calendário" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FeriadoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "delete": { "tags": [ "RH - Calendário" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/ausencias": { "get": { "tags": [ "RH - Assiduidade" ], "parameters": [ { "name": "funcionarioId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "tipo", "in": "query", "schema": { "$ref": "#/components/schemas/TipoAusencia" } }, { "name": "estado", "in": "query", "schema": { "$ref": "#/components/schemas/EstadoPedidoRh" } }, { "name": "de", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "ate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "RH - Assiduidade" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistarAusenciaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/ausencias/{id}/aprovar": { "post": { "tags": [ "RH - Assiduidade" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AprovarAusenciaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/ausencias/{id}/rejeitar": { "post": { "tags": [ "RH - Assiduidade" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/ausencias/{id}/anular": { "post": { "tags": [ "RH - Assiduidade" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/ferias/saldos": { "get": { "tags": [ "RH - Férias" ], "parameters": [ { "name": "ano", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/ferias/funcionarios/{funcionarioId}": { "get": { "tags": [ "RH - Férias" ], "parameters": [ { "name": "funcionarioId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ano", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/ferias/direitos": { "post": { "tags": [ "RH - Férias" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistarDireitoFeriasCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/ferias/marcacoes": { "get": { "tags": [ "RH - Férias" ], "parameters": [ { "name": "funcionarioId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "ano", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "estado", "in": "query", "schema": { "$ref": "#/components/schemas/EstadoPedidoRh" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "RH - Férias" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarcarFeriasCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/ferias/marcacoes/{id}/aprovar": { "post": { "tags": [ "RH - Férias" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/ferias/marcacoes/{id}/rejeitar": { "post": { "tags": [ "RH - Férias" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/ferias/marcacoes/{id}/anular": { "post": { "tags": [ "RH - Férias" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/trabalho-suplementar": { "get": { "tags": [ "RH - Trabalho suplementar" ], "parameters": [ { "name": "funcionarioId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "estado", "in": "query", "schema": { "$ref": "#/components/schemas/EstadoPedidoRh" } }, { "name": "de", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "ate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "RH - Trabalho suplementar" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistarTrabalhoSuplementarCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/trabalho-suplementar/resumo": { "get": { "tags": [ "RH - Trabalho suplementar" ], "parameters": [ { "name": "funcionarioId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ano", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/trabalho-suplementar/{id}/aprovar": { "post": { "tags": [ "RH - Trabalho suplementar" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/trabalho-suplementar/{id}/rejeitar": { "post": { "tags": [ "RH - Trabalho suplementar" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/trabalho-suplementar/{id}/anular": { "post": { "tags": [ "RH - Trabalho suplementar" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/rubricas": { "get": { "tags": [ "RH - Rubricas" ], "parameters": [ { "name": "incluirInactivas", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "RH - Rubricas" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DadosRubrica" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/rubricas/para-lancamento": { "get": { "tags": [ "RH - Rubricas" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/rubricas/{id}": { "put": { "tags": [ "RH - Rubricas" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DadosRubrica" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/rubricas/{id}/activa": { "put": { "tags": [ "RH - Rubricas" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivaRubricaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/ponto/equipamentos": { "get": { "tags": [ "RH - Ponto" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "RH - Ponto" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EquipamentoPontoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/ponto/equipamentos/{id}": { "put": { "tags": [ "RH - Ponto" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EquipamentoPontoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/ponto/codigos": { "get": { "tags": [ "RH - Ponto" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/ponto/codigos/{funcionarioId}": { "put": { "tags": [ "RH - Ponto" ], "parameters": [ { "name": "funcionarioId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CodigoPontoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/ponto/importacoes/pre-visualizar": { "post": { "tags": [ "RH - Ponto" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/ponto/importacoes": { "post": { "tags": [ "RH - Ponto" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/ponto/marcacoes": { "get": { "tags": [ "RH - Ponto" ], "parameters": [ { "name": "de", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "ate", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "funcionarioId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "apenasSemTrabalhador", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "RH - Ponto" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarcacaoManualRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/ponto/folha/{funcionarioId}": { "get": { "tags": [ "RH - Ponto" ], "parameters": [ { "name": "funcionarioId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ano", "in": "query", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "mes", "in": "query", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/subsidios-extraordinarios": { "get": { "tags": [ "RH - Subsídios de férias e de Natal" ], "parameters": [ { "name": "tipo", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/TipoSubsidioExtraordinario" } }, { "name": "modo", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/ModoSubsidioExtraordinario" } }, { "name": "competencia", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/subsidios-extraordinarios/gerar": { "post": { "tags": [ "RH - Subsídios de férias e de Natal" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GerarSubsidiosExtraordinariosRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/lancamentos": { "get": { "tags": [ "RH - Lançamentos variáveis" ], "parameters": [ { "name": "funcionarioId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "rubricaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "competencia", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "estado", "in": "query", "schema": { "$ref": "#/components/schemas/EstadoPedidoRh" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "RH - Lançamentos variáveis" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistarLancamentoVariavelCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/lancamentos/{id}/aprovar": { "post": { "tags": [ "RH - Lançamentos variáveis" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/lancamentos/{id}/rejeitar": { "post": { "tags": [ "RH - Lançamentos variáveis" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/lancamentos/{id}/anular": { "post": { "tags": [ "RH - Lançamentos variáveis" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/descontos": { "get": { "tags": [ "RH - Descontos" ], "parameters": [ { "name": "funcionarioId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "tipo", "in": "query", "schema": { "$ref": "#/components/schemas/TipoDescontoProgramado" } }, { "name": "estado", "in": "query", "schema": { "$ref": "#/components/schemas/EstadoPedidoRh" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "RH - Descontos" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistarDescontoProgramadoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/descontos/{id}": { "get": { "tags": [ "RH - Descontos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/descontos/{id}/aprovar": { "post": { "tags": [ "RH - Descontos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/descontos/{id}/rejeitar": { "post": { "tags": [ "RH - Descontos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/descontos/{id}/anular": { "post": { "tags": [ "RH - Descontos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/descontos/{id}/movimentos": { "post": { "tags": [ "RH - Descontos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MovimentoDescontoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/descontos/{id}/eventos": { "post": { "tags": [ "RH - Descontos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventoDescontoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/folhas": { "get": { "tags": [ "RH - Folha de salários" ], "parameters": [ { "name": "ano", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "RH - Folha de salários" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProcessarFolhaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/folhas/{id}": { "get": { "tags": [ "RH - Folha de salários" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "delete": { "tags": [ "RH - Folha de salários" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/folhas/{id}/recibos/{reciboId}": { "get": { "tags": [ "RH - Folha de salários" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reciboId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/folhas/{id}/pdf": { "get": { "tags": [ "RH - Folha de salários" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/folhas/{id}/recibos/{reciboId}/pdf": { "get": { "tags": [ "RH - Folha de salários" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "reciboId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/folhas/{id}/mapa-pagamento": { "get": { "tags": [ "RH - Folha de salários" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/folhas/{id}/mapa-pagamento/csv": { "get": { "tags": [ "RH - Folha de salários" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/folhas/{id}/mapa-retencoes": { "get": { "tags": [ "RH - Folha de salários" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/folhas/{id}/mapa-retencoes/csv": { "get": { "tags": [ "RH - Folha de salários" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/folhas/{id}/mapa-remuneracoes-agt": { "get": { "tags": [ "RH - Folha de salários" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "formato", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/FormatoMapaRemuneracoesAgt" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/folhas/{id}/mapa-remuneracoes-agt/xlsx": { "get": { "tags": [ "RH - Folha de salários" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "formato", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/FormatoMapaRemuneracoesAgt" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/folhas/trabalhadores": { "get": { "tags": [ "RH - Folha de salários" ], "parameters": [ { "name": "competencia", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/folhas/{id}/aprovar": { "post": { "tags": [ "RH - Folha de salários" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AprovarFolhaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/folhas/{id}/anular": { "post": { "tags": [ "RH - Folha de salários" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/cessacoes/trabalhadores": { "get": { "tags": [ "RH - Cessações" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/cessacoes": { "get": { "tags": [ "RH - Cessações" ], "parameters": [ { "name": "estado", "in": "query", "schema": { "$ref": "#/components/schemas/EstadoCessacao" } }, { "name": "funcionarioId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "RH - Cessações" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistarCessacaoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/cessacoes/{id}": { "get": { "tags": [ "RH - Cessações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "delete": { "tags": [ "RH - Cessações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/cessacoes/{id}/linhas": { "put": { "tags": [ "RH - Cessações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualizarLinhasCessacaoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/cessacoes/{id}/aprovar": { "post": { "tags": [ "RH - Cessações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AprovarFolhaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/disciplinar/trabalhadores": { "get": { "tags": [ "RH - Disciplinar" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/disciplinar": { "get": { "tags": [ "RH - Disciplinar" ], "parameters": [ { "name": "estado", "in": "query", "schema": { "$ref": "#/components/schemas/EstadoProcessoDisciplinar" } }, { "name": "funcionarioId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "RH - Disciplinar" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbrirProcessoDisciplinarCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/disciplinar/alertas": { "get": { "tags": [ "RH - Disciplinar" ], "parameters": [ { "name": "dias", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 15 } }, { "name": "referencia", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/disciplinar/{id}": { "get": { "tags": [ "RH - Disciplinar" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/disciplinar/{id}/fases": { "post": { "tags": [ "RH - Disciplinar" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FaseDisciplinarRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/disciplinar/{id}/sancao": { "post": { "tags": [ "RH - Disciplinar" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SancaoDisciplinarRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/disciplinar/{id}/arquivar": { "post": { "tags": [ "RH - Disciplinar" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArquivarDisciplinarRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/contencioso/trabalhadores": { "get": { "tags": [ "RH - Contencioso" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/contencioso": { "get": { "tags": [ "RH - Contencioso" ], "parameters": [ { "name": "estado", "in": "query", "schema": { "$ref": "#/components/schemas/EstadoLitigio" } }, { "name": "risco", "in": "query", "schema": { "$ref": "#/components/schemas/RiscoLitigio" } }, { "name": "funcionarioId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "RH - Contencioso" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbrirLitigioCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/contencioso/resumo": { "get": { "tags": [ "RH - Contencioso" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/contencioso/{id}": { "get": { "tags": [ "RH - Contencioso" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/contencioso/{id}/eventos": { "post": { "tags": [ "RH - Contencioso" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventoLitigioRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/contencioso/{id}/risco": { "post": { "tags": [ "RH - Contencioso" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiscoLitigioRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/contencioso/{id}/numero-processo": { "put": { "tags": [ "RH - Contencioso" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NumeroProcessoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/contencioso/{id}/encerrar": { "post": { "tags": [ "RH - Contencioso" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EncerrarLitigioRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/contencioso/{id}/conta": { "post": { "tags": [ "RH - Contencioso" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AprovarFolhaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/contencioso/{id}/provisoes": { "post": { "tags": [ "RH - Contencioso" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProvisaoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/contencioso/provisoes/{provisaoId}/confirmar": { "post": { "tags": [ "RH - Contencioso" ], "parameters": [ { "name": "provisaoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/contencioso/provisoes/{provisaoId}/rejeitar": { "post": { "tags": [ "RH - Contencioso" ], "parameters": [ { "name": "provisaoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/hst/trabalhadores": { "get": { "tags": [ "RH - HST" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/hst/alertas": { "get": { "tags": [ "RH - HST" ], "parameters": [ { "name": "dias", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 30 } }, { "name": "referencia", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/hst/exames": { "get": { "tags": [ "RH - HST" ], "parameters": [ { "name": "funcionarioId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "incluirAnulados", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "RH - HST" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistarExameMedicoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/hst/exames/{id}/anular": { "post": { "tags": [ "RH - HST" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/hst/acidentes": { "get": { "tags": [ "RH - HST" ], "parameters": [ { "name": "funcionarioId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "semComunicacao", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "RH - HST" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistarAcidenteTrabalhoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/hst/acidentes/{id}": { "get": { "tags": [ "RH - HST" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/hst/acidentes/{id}/actualizacoes": { "post": { "tags": [ "RH - HST" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualizacaoAcidenteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/activos/trabalhadores": { "get": { "tags": [ "RH - Activos" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/activos/alertas": { "get": { "tags": [ "RH - Activos" ], "parameters": [ { "name": "dias", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 30 } }, { "name": "referencia", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/activos": { "get": { "tags": [ "RH - Activos" ], "parameters": [ { "name": "funcionarioId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "estado", "in": "query", "schema": { "$ref": "#/components/schemas/EstadoActivo" } }, { "name": "categoria", "in": "query", "schema": { "$ref": "#/components/schemas/CategoriaActivo" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "RH - Activos" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntregarActivoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/activos/{id}/devolver": { "post": { "tags": [ "RH - Activos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DevolucaoActivoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/activos/{id}/anular": { "post": { "tags": [ "RH - Activos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/avaliacoes/trabalhadores": { "get": { "tags": [ "RH - Avaliações" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/avaliacoes/resumo": { "get": { "tags": [ "RH - Avaliações" ], "parameters": [ { "name": "ano", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/avaliacoes/pendentes": { "get": { "tags": [ "RH - Avaliações" ], "parameters": [ { "name": "ano", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/avaliacoes": { "get": { "tags": [ "RH - Avaliações" ], "parameters": [ { "name": "ano", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "funcionarioId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "estado", "in": "query", "schema": { "$ref": "#/components/schemas/EstadoAvaliacao" } }, { "name": "incluirAnuladas", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "RH - Avaliações" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarAvaliacaoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/avaliacoes/{id}": { "get": { "tags": [ "RH - Avaliações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "put": { "tags": [ "RH - Avaliações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualizarAvaliacaoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/avaliacoes/{id}/concluir": { "post": { "tags": [ "RH - Avaliações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/avaliacoes/{id}/anular": { "post": { "tags": [ "RH - Avaliações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/acordos/trabalhadores": { "get": { "tags": [ "RH - Acordos colectivos" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/acordos": { "get": { "tags": [ "RH - Acordos colectivos" ], "parameters": [ { "name": "referencia", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "RH - Acordos colectivos" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarAcordoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/acordos/{id}": { "get": { "tags": [ "RH - Acordos colectivos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "referencia", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "put": { "tags": [ "RH - Acordos colectivos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualizarAcordoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/acordos/{id}/terminar": { "post": { "tags": [ "RH - Acordos colectivos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TerminarAcordoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/acordos/{id}/parametros": { "post": { "tags": [ "RH - Acordos colectivos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParametroAcordoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/acordos/{id}/parametros/{parametroId}/anular": { "post": { "tags": [ "RH - Acordos colectivos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "parametroId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/acordos/{id}/parametros/{parametroId}/confirmar": { "post": { "tags": [ "RH - Acordos colectivos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "parametroId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/acordos/{id}/categorias": { "post": { "tags": [ "RH - Acordos colectivos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CategoriaAcordoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/acordos/{id}/categorias/{categoriaId}/anular": { "post": { "tags": [ "RH - Acordos colectivos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "categoriaId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/acordos/{id}/adesoes": { "post": { "tags": [ "RH - Acordos colectivos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdesaoAcordoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/acordos/adesoes/{adesaoId}/encerrar": { "post": { "tags": [ "RH - Acordos colectivos" ], "parameters": [ { "name": "adesaoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EncerrarAdesaoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/diuturnidades/rubricas": { "get": { "tags": [ "RH - Diuturnidades" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/diuturnidades/regras": { "get": { "tags": [ "RH - Diuturnidades" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "RH - Diuturnidades" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarRegraDiuturnidadeCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/diuturnidades": { "get": { "tags": [ "RH - Diuturnidades" ], "parameters": [ { "name": "referencia", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/diuturnidades/regras/{id}/anular": { "post": { "tags": [ "RH - Diuturnidades" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/diuturnidades/aplicar": { "post": { "tags": [ "RH - Diuturnidades" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AplicarDiuturnidadeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/denuncias/resumo": { "get": { "tags": [ "RH - Denúncias" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/denuncias": { "get": { "tags": [ "RH - Denúncias" ], "parameters": [ { "name": "estado", "in": "query", "schema": { "$ref": "#/components/schemas/EstadoDenuncia" } }, { "name": "categoria", "in": "query", "schema": { "$ref": "#/components/schemas/CategoriaDenuncia" } }, { "name": "incluirTerminadas", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/denuncias/{id}": { "get": { "tags": [ "RH - Denúncias" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/denuncias/{id}/responder": { "post": { "tags": [ "RH - Denúncias" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/denuncias/{id}/notas": { "post": { "tags": [ "RH - Denúncias" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TextoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/denuncias/{id}/concluir": { "post": { "tags": [ "RH - Denúncias" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConcluirDenunciaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/rh/denuncias/{id}/arquivar": { "post": { "tags": [ "RH - Denúncias" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArquivarDenunciaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/armazens": { "post": { "tags": [ "Estoque - Armazéns" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateArmazemCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "get": { "tags": [ "Estoque - Armazéns" ], "parameters": [ { "name": "filtro", "in": "query", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "todasAsLojas", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginaResultadoOfArmazemDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/armazens/{id}": { "get": { "tags": [ "Estoque - Armazéns" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ArmazemDto" } } } }, "404": { "description": "Not Found" } }, "security": [ { "ChaveApi": [] } ] }, "put": { "tags": [ "Estoque - Armazéns" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateArmazemRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "delete": { "tags": [ "Estoque - Armazéns" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/armazens/{id}/predefinir": { "post": { "tags": [ "Estoque - Armazéns" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/lotes": { "post": { "tags": [ "Estoque - Lotes" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLoteCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "get": { "tags": [ "Estoque - Lotes" ], "parameters": [ { "name": "filtro", "in": "query", "schema": { "type": "string" } }, { "name": "produtoId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginaResultadoOfLoteDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/lotes/{id}": { "get": { "tags": [ "Estoque - Lotes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoteDto" } } } }, "404": { "description": "Not Found" } }, "security": [ { "ChaveApi": [] } ] }, "put": { "tags": [ "Estoque - Lotes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLoteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "delete": { "tags": [ "Estoque - Lotes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/saldos": { "get": { "tags": [ "Estoque - Saldos" ], "parameters": [ { "name": "armazemId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "produtoId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "diasParaVencer", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginaResultadoOfSaldoEstoqueDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/saldos/retirar": { "post": { "tags": [ "Estoque - Saldos" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetirarEstoqueFifoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/saldos/historico/{produtoId}": { "get": { "tags": [ "Estoque - Saldos" ], "parameters": [ { "name": "produtoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HistoricoMovimentoProdutoDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/saldos/baixo-estoque": { "get": { "tags": [ "Estoque - Saldos" ], "parameters": [ { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginaResultadoOfProdutoBaixoEstoqueDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/saldos/por-produtos": { "get": { "tags": [ "Estoque - Saldos" ], "parameters": [ { "name": "armazemId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "produtoIds", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SaldoPorProdutoDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/entradas": { "post": { "tags": [ "Estoque - Entradas" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEntradaEstoqueCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "get": { "tags": [ "Estoque - Entradas" ], "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginaResultadoOfEntradaEstoqueResumoDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/entradas/{id}": { "get": { "tags": [ "Estoque - Entradas" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntradaEstoqueDetalheDto" } } } }, "404": { "description": "Not Found" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/entradas/{id}/anexo": { "post": { "tags": [ "Estoque - Entradas" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "ficheiro" ], "type": "object", "properties": { "ficheiro": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "get": { "tags": [ "Estoque - Entradas" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "delete": { "tags": [ "Estoque - Entradas" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/saidas-manuais": { "post": { "tags": [ "Estoque - Saídas Manuais" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistarSaidaManualEstoqueCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "get": { "tags": [ "Estoque - Saídas Manuais" ], "parameters": [ { "name": "dataInicio", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "dataFim", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "nomeProduto", "in": "query", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginaResultadoOfSaidaManualEstoqueDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/saidas-manuais/{id}": { "get": { "tags": [ "Estoque - Saídas Manuais" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaidaManualEstoqueDto" } } } }, "404": { "description": "Not Found" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/entradas-manuais": { "post": { "tags": [ "Estoque - Entradas Manuais" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistarEntradaManualEstoqueCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/transferencias": { "post": { "tags": [ "Estoque - Transferências" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTransferenciaEstoqueCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "get": { "tags": [ "Estoque - Transferências" ], "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginaResultadoOfTransferenciaEstoqueResumoDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/transferencias/recentes": { "get": { "tags": [ "Estoque - Transferências" ], "parameters": [ { "name": "limite", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 8 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransferenciaEstoqueResumoDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/transferencias/produtos": { "get": { "tags": [ "Estoque - Transferências" ], "parameters": [ { "name": "armazemOrigemId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "filtro", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 30 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProdutoTransferenciaDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/transferencias/disponibilidade": { "get": { "tags": [ "Estoque - Transferências" ], "parameters": [ { "name": "armazemOrigemId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "produtoIds", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DisponibilidadeTransferenciaDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/transferencias/estoque-no-destino": { "get": { "tags": [ "Estoque - Transferências" ], "parameters": [ { "name": "armazemDestinoId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "produtoIds", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SaldoPorProdutoDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/transferencias/pendentes": { "get": { "tags": [ "Estoque - Transferências" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TransferenciaEstoqueResumoDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/transferencias/{id}/confirmar": { "post": { "tags": [ "Estoque - Transferências" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/transferencias/{id}/rejeitar": { "post": { "tags": [ "Estoque - Transferências" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RejeitarTransferenciaEstoqueRequest" } ] } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/transferencias/{id}": { "get": { "tags": [ "Estoque - Transferências" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferenciaEstoqueDetalheDto" } } } }, "404": { "description": "Not Found" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/reservas/disponibilidade": { "get": { "tags": [ "Estoque - Reservas Inter-Lojas" ], "parameters": [ { "name": "produtoId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DisponibilidadeLojaDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/reservas": { "get": { "tags": [ "Estoque - Reservas Inter-Lojas" ], "parameters": [ { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "estado", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ReservaEstoqueDto" } } } } } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Estoque - Reservas Inter-Lojas" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SolicitarReservaEstoqueCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/reservas/{id}/confirmar": { "post": { "tags": [ "Estoque - Reservas Inter-Lojas" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/reservas/{id}/recusar": { "post": { "tags": [ "Estoque - Reservas Inter-Lojas" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RecusarReservaEstoqueRequest" } ] } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/guias-transferencia": { "get": { "tags": [ "Estoque - Reservas Inter-Lojas" ], "parameters": [ { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GuiaTransferenciaInternaDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/guias-transferencia/{id}/confirmar-recepcao": { "post": { "tags": [ "Estoque - Reservas Inter-Lojas" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/reservas-stock": { "post": { "tags": [ "Estoque - Reservas a Clientes" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarPedidoReservaStockCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/reservas-stock/activos": { "get": { "tags": [ "Estoque - Reservas a Clientes" ], "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginaResultadoOfPedidoReservaStockActivoDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/reservas-stock/activos/resumo": { "get": { "tags": [ "Estoque - Reservas a Clientes" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResumoReservasActivasDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/reservas-stock/cliente/{clienteId}": { "get": { "tags": [ "Estoque - Reservas a Clientes" ], "parameters": [ { "name": "clienteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginaResultadoOfPedidoReservaStockActivoDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/reservas-stock/historico": { "get": { "tags": [ "Estoque - Reservas a Clientes" ], "parameters": [ { "name": "limite", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 12 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/HistoricoReservaStockDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/reservas-stock/produtos": { "get": { "tags": [ "Estoque - Reservas a Clientes" ], "parameters": [ { "name": "armazemId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "filtro", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 30 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProdutoTransferenciaDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/reservas-stock/disponibilidade": { "get": { "tags": [ "Estoque - Reservas a Clientes" ], "parameters": [ { "name": "armazemId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "produtoIds", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DisponibilidadeTransferenciaDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/reservas-stock/{id}/linhas/{linhaId}/confirmar": { "post": { "tags": [ "Estoque - Reservas a Clientes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "linhaId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/reservas-stock/{id}/prorrogar": { "post": { "tags": [ "Estoque - Reservas a Clientes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProrrogarReservaStockRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/reservas-stock/{id}/cancelar": { "post": { "tags": [ "Estoque - Reservas a Clientes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CancelarReservaStockRequest" } ] } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/metodos-pagamento": { "get": { "tags": [ "Diversos - Métodos de Pagamento" ], "parameters": [ { "name": "apenasActivos", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MetodoPagamentoDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/moedas": { "get": { "tags": [ "Diversos - Moedas" ], "parameters": [ { "name": "apenasActivas", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MoedaDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/impostos": { "get": { "tags": [ "Diversos - Tributos" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ImpostoDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/taxas-retencao": { "get": { "tags": [ "Diversos - Tributos" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaxaRetencaoDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/motivos-isencao-iva": { "get": { "tags": [ "Diversos - Tributos" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MotivoIsencaoIvaDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/provincias": { "get": { "tags": [ "Diversos - Geografia" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProvinciaDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/municipios": { "get": { "tags": [ "Diversos - Geografia" ], "parameters": [ { "name": "provinciaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MunicipioDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/catalogos": { "get": { "tags": [ "Catálogos" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CatalogosDto" } } } }, "304": { "description": "Not Modified" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/documentos/tipos": { "get": { "tags": [ "Documentos - Tipos" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TipoDocumentoDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/documentos/series": { "get": { "tags": [ "Documentos - Séries" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SerieDocumentoDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/documentos": { "post": { "tags": [ "Documentos" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDocumentoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "get": { "tags": [ "Documentos" ], "parameters": [ { "name": "tipoDocumentoId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "clienteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "dataInicio", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "dataFim", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginaResultadoOfDocumentoDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/documentos/pre-calculo": { "post": { "tags": [ "Documentos" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDocumentoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/documentos/{id}/pdf": { "get": { "tags": [ "Documentos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "vias", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/documentos/rascunhos": { "post": { "tags": [ "Documentos" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarRascunhoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "get": { "tags": [ "Documentos" ], "parameters": [ { "name": "tipoDocumentoId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/RascunhoResumoDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/documentos/rascunhos/{id}": { "put": { "tags": [ "Documentos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalvarRascunhoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "get": { "tags": [ "Documentos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RascunhoDto" } } } }, "404": { "description": "Not Found" } }, "security": [ { "ChaveApi": [] } ] }, "delete": { "tags": [ "Documentos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/documentos/rascunhos/{id}/emitir": { "post": { "tags": [ "Documentos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/documentos/notas-credito": { "post": { "tags": [ "Documentos" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateNotaCreditoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/documentos/recibos": { "post": { "tags": [ "Documentos" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateReciboCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/documentos/recibos/{id}/anular": { "post": { "tags": [ "Documentos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnularReciboRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/documentos/{id}/envios": { "get": { "tags": [ "Documentos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EnvioDocumentoDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/documentos/{id}/enviar-email": { "post": { "tags": [ "Documentos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EnviarEmailRequest" } ] } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/documentos/{id}/enviar-lembrete-pagamento": { "post": { "tags": [ "Documentos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EnviarEmailRequest" } ] } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/documentos/{id}/impressao": { "get": { "tags": [ "Documentos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoImpressaoDto" } } } }, "404": { "description": "Not Found" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/documentos/{id}/impressoes": { "post": { "tags": [ "Documentos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImpressaoRegistadaDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/documentos/pendentes": { "get": { "tags": [ "Documentos" ], "parameters": [ { "name": "clienteId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentoPendenteDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/documentos/{id}": { "get": { "tags": [ "Documentos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoDto" } } } }, "404": { "description": "Not Found" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/condicoes-pagamento": { "get": { "tags": [ "Documentos - Condições de pagamento" ], "parameters": [ { "name": "apenasActivas", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CondicaoDePagamentoDto" } } } } } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Documentos - Condições de pagamento" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarCondicaoDePagamentoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/condicoes-pagamento/{id}": { "put": { "tags": [ "Documentos - Condições de pagamento" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditarCondicaoDePagamentoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/relatorios/documentos": { "get": { "tags": [ "Relatórios" ], "parameters": [ { "name": "dataInicio", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "dataFim", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "tipoDocumentoId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "clienteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "usuarioId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "estado", "in": "query", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginaResultadoOfDocumentoEmitidoDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/relatorios/mapas/{codigo}": { "get": { "tags": [ "Relatórios" ], "parameters": [ { "name": "codigo", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "inicio", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "fim", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapaDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/relatorios/pendentes": { "get": { "tags": [ "Relatórios" ], "parameters": [ { "name": "clienteId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PendenteRelatorioDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/relatorios/produtos-vendidos": { "get": { "tags": [ "Relatórios" ], "parameters": [ { "name": "dataInicio", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "dataFim", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "usuarioId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "clienteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProdutoVendidoDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/relatorios/produtos/ranking": { "get": { "tags": [ "Relatórios" ], "parameters": [ { "name": "dataInicio", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "dataFim", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "ordem", "in": "query", "schema": { "type": "string", "default": "mais" } }, { "name": "top", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 20 } }, { "name": "incluirSemVendas", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProdutoRankingDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/relatorios/produtos/classificacao-abc": { "get": { "tags": [ "Relatórios" ], "parameters": [ { "name": "dataInicio", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "dataFim", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "limiteA", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0.8 } }, { "name": "limiteB", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0.9 } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClassificacaoAbcDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/relatorios/iva": { "get": { "tags": [ "Relatórios" ], "parameters": [ { "name": "dataInicio", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "dataFim", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResumoIvaDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/relatorios/pagamentos": { "get": { "tags": [ "Relatórios" ], "parameters": [ { "name": "dataInicio", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "dataFim", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "usuarioId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PagamentoRelatorioDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/relatorios/vendas-mensais": { "get": { "tags": [ "Relatórios" ], "parameters": [ { "name": "ano", "in": "query", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "produtoId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VendaMensalDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/relatorios/produtos/{produtoId}/ultimas-vendas": { "get": { "tags": [ "Relatórios" ], "parameters": [ { "name": "produtoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "top", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 10 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VendaItemDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/relatorios/caixas/{id}/resumo": { "get": { "tags": [ "Relatórios" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/relatorios/clientes/ranking": { "get": { "tags": [ "Relatórios" ], "parameters": [ { "name": "dataInicio", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "dataFim", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "top", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClienteRankingDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/relatorios/resumo-facturacao": { "get": { "tags": [ "Relatórios" ], "parameters": [ { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResumoFacturacaoDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/visao-360": { "get": { "tags": [ "Visão 360°" ], "parameters": [ { "name": "periodo", "in": "query", "schema": { "type": "string", "default": "mes" } }, { "name": "estabelecimentoId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/pesquisa": { "get": { "tags": [ "Pesquisa" ], "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "limite", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/encomendas/sugestao": { "get": { "tags": [ "Estoque - Encomendas" ], "parameters": [ { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/encomendas/notas": { "post": { "tags": [ "Estoque - Encomendas" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarNotasDeEncomendaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "get": { "tags": [ "Estoque - Encomendas" ], "parameters": [ { "name": "estado", "in": "query", "schema": { "type": "string" } }, { "name": "fornecedorId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/encomendas/notas/{id}": { "get": { "tags": [ "Estoque - Encomendas" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/encomendas/notas/{id}/recebida": { "post": { "tags": [ "Estoque - Encomendas" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/estoque/encomendas/notas/{id}/cancelar": { "post": { "tags": [ "Estoque - Encomendas" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelarNotaEncomendaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/empresa": { "get": { "tags": [ "Empresa" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmpresaDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/empresa/configuracao-fiscal-compras": { "get": { "tags": [ "Empresa" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguracaoFiscalComprasDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/empresa/configuracao-fiscal-compras/historico": { "get": { "tags": [ "Empresa" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AlteracaoFiscalDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/empresa/logotipo": { "get": { "tags": [ "Empresa" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/empresa/politica-vendas": { "get": { "tags": [ "Empresa" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PoliticaVendasDto" } } } } }, "security": [ { "ChaveApi": [] } ] }, "put": { "tags": [ "Empresa" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AtualizarPoliticaVendasCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/empresa/configuracao-geral": { "get": { "tags": [ "Empresa" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfiguracaoGeralDto" } } } } }, "security": [ { "ChaveApi": [] } ] }, "put": { "tags": [ "Empresa" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AtualizarConfiguracaoGeralCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/caixa/meu": { "get": { "tags": [ "Caixa" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/caixa/historico": { "get": { "tags": [ "Caixa" ], "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/caixa/abertos": { "get": { "tags": [ "Caixa" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/caixa/documentos": { "get": { "tags": [ "Caixa" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/caixa/terminais/{id}": { "get": { "tags": [ "Caixa - Terminais" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/caixa/terminais": { "get": { "tags": [ "Caixa - Terminais" ], "parameters": [ { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lojas": { "get": { "tags": [ "Lojas" ], "parameters": [ { "name": "apenasMinhas", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LojaDto" } } } } } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Lojas" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLojaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lojas/{id}": { "put": { "tags": [ "Lojas" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateLojaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/eventos": { "get": { "tags": [ "Eventos" ], "parameters": [ { "name": "tipo", "in": "query", "schema": { "type": "string" } }, { "name": "desde", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/avencas": { "get": { "tags": [ "Avenças" ], "parameters": [ { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Avenças" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarAvencaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/avencas/{id}/historico": { "get": { "tags": [ "Avenças" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/avencas/{id}/pausar": { "post": { "tags": [ "Avenças" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/avencas/{id}/retomar": { "post": { "tags": [ "Avenças" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/avencas/{id}/cancelar": { "post": { "tags": [ "Avenças" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/avencas/gerar-pendentes": { "post": { "tags": [ "Avenças" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/contas-a-pagar": { "get": { "tags": [ "Financeiro - Contas a Pagar" ], "parameters": [ { "name": "situacao", "in": "query", "schema": { "default": "EmAberto", "$ref": "#/components/schemas/SituacaoContasAPagar" } }, { "name": "fornecedorId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } }, { "name": "origem", "in": "query", "schema": { "$ref": "#/components/schemas/OrigemContaAPagar" } }, { "name": "categoriaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginaResultadoOfContaAPagarDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/contas-a-pagar/resumo": { "get": { "tags": [ "Financeiro - Contas a Pagar" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResumoContasAPagarDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/contas-a-pagar/{id}": { "get": { "tags": [ "Financeiro - Contas a Pagar" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContaAPagarDetalheDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/contas-a-pagar/{id}/pagamentos": { "post": { "tags": [ "Financeiro - Contas a Pagar" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistarPagamentoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/contas-a-pagar/{id}/notas-credito": { "post": { "tags": [ "Financeiro - Contas a Pagar" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistarNotaCreditoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/contas-a-pagar/despesas": { "post": { "tags": [ "Financeiro - Contas a Pagar" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarDespesaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/contas-a-pagar/despesas/resumo-mes": { "get": { "tags": [ "Financeiro - Contas a Pagar" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResumoDespesasMesDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/contas-a-pagar/{id}/anular": { "post": { "tags": [ "Financeiro - Contas a Pagar" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AnularDespesaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/contas-a-pagar/{id}/pagamentos/{pagamentoId}/estornar": { "post": { "tags": [ "Financeiro - Contas a Pagar" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "pagamentoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstornarPagamentoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/contas-a-receber": { "get": { "tags": [ "Financeiro - Contas a Receber" ], "parameters": [ { "name": "situacao", "in": "query", "schema": { "default": "EmAberto", "$ref": "#/components/schemas/SituacaoContasAReceber" } }, { "name": "clienteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaginaResultadoOfContaAReceberDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/contas-a-receber/resumo": { "get": { "tags": [ "Financeiro - Contas a Receber" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResumoContasAReceberDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/fluxo-caixa/realizado": { "get": { "tags": [ "Financeiro - Fluxo de Caixa" ], "parameters": [ { "name": "de", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "ate", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "contaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "granularidade", "in": "query", "schema": { "default": "Auto", "$ref": "#/components/schemas/GranularidadeFluxo" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FluxoCaixaRealizadoDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/fluxo-caixa/realizado/csv": { "get": { "tags": [ "Financeiro - Fluxo de Caixa" ], "parameters": [ { "name": "de", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "ate", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "contaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "comparar", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/fluxo-caixa/previsto": { "get": { "tags": [ "Financeiro - Fluxo de Caixa" ], "parameters": [ { "name": "horizonte", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 90 } }, { "name": "incluirReceberVencido", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FluxoCaixaPrevistoDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/fluxo-caixa/indicadores": { "get": { "tags": [ "Financeiro - Fluxo de Caixa" ], "parameters": [ { "name": "de", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "ate", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IndicadoresTesourariaDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/despesas-recorrentes": { "get": { "tags": [ "Financeiro - Despesas Recorrentes" ], "parameters": [ { "name": "estado", "in": "query", "schema": { "$ref": "#/components/schemas/EstadoAvenca" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DespesaRecorrenteDto" } } } } } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Financeiro - Despesas Recorrentes" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarDespesaRecorrenteCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/despesas-recorrentes/resumo": { "get": { "tags": [ "Financeiro - Despesas Recorrentes" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResumoDespesasRecorrentesDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/despesas-recorrentes/{id}": { "get": { "tags": [ "Financeiro - Despesas Recorrentes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DespesaRecorrenteDetalheDto" } } } } }, "security": [ { "ChaveApi": [] } ] }, "put": { "tags": [ "Financeiro - Despesas Recorrentes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditarDespesaRecorrenteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/despesas-recorrentes/{id}/pausar": { "post": { "tags": [ "Financeiro - Despesas Recorrentes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/despesas-recorrentes/{id}/retomar": { "post": { "tags": [ "Financeiro - Despesas Recorrentes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/despesas-recorrentes/{id}/cancelar": { "post": { "tags": [ "Financeiro - Despesas Recorrentes" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/despesas-recorrentes/lancar-pendentes": { "post": { "tags": [ "Financeiro - Despesas Recorrentes" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResultadoLancamentoDespesasDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/mapa-fornecedores": { "get": { "tags": [ "Financeiro - Mapa de Fornecedores" ], "parameters": [ { "name": "periodo", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MapaFornecedoresDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/mapa-fornecedores/excel": { "get": { "tags": [ "Financeiro - Mapa de Fornecedores" ], "parameters": [ { "name": "periodo", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/categorias": { "get": { "tags": [ "Financeiro - Categorias" ], "parameters": [ { "name": "tipo", "in": "query", "schema": { "$ref": "#/components/schemas/TipoCategoriaFinanceira" } }, { "name": "incluirInactivas", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CategoriaFinanceiraDto" } } } } } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Financeiro - Categorias" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarCategoriaFinanceiraCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/categorias/{id}": { "put": { "tags": [ "Financeiro - Categorias" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NomeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/categorias/{id}/actividade": { "put": { "tags": [ "Financeiro - Categorias" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActividadeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/categorias/{id}/valores-fiscais": { "put": { "tags": [ "Financeiro - Categorias" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValoresFiscaisCategoriaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/categorias/{id}/activa": { "put": { "tags": [ "Financeiro - Categorias" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/centros-custo": { "get": { "tags": [ "Financeiro - Centros de Custo" ], "parameters": [ { "name": "incluirInactivos", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CentroCustoDto" } } } } } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Financeiro - Centros de Custo" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarCentroCustoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/centros-custo/{id}": { "put": { "tags": [ "Financeiro - Centros de Custo" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NomeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/centros-custo/{id}/activo": { "put": { "tags": [ "Financeiro - Centros de Custo" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/creditos-fornecedor": { "get": { "tags": [ "Financeiro - Créditos de Fornecedores" ], "parameters": [ { "name": "fornecedorId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "apenasDisponiveis", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditoFornecedorDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/creditos-fornecedor/{id}": { "get": { "tags": [ "Financeiro - Créditos de Fornecedores" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditoFornecedorDetalheDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/creditos-fornecedor/{id}/compensar": { "post": { "tags": [ "Financeiro - Créditos de Fornecedores" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompensarCreditoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/creditos-fornecedor/{id}/reembolsar": { "post": { "tags": [ "Financeiro - Créditos de Fornecedores" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReembolsarCreditoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/creditos-fornecedor/utilizacoes/{utilizacaoId}/desfazer": { "post": { "tags": [ "Financeiro - Créditos de Fornecedores" ], "parameters": [ { "name": "utilizacaoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DesfazerUtilizacaoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/conciliacao/{contaId}": { "get": { "tags": [ "Financeiro - Conciliação Bancária" ], "parameters": [ { "name": "contaId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstadoConciliacaoDto" } } } } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Financeiro - Conciliação Bancária" ], "parameters": [ { "name": "contaId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConciliarRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/conciliacao/{contaId}/movimentos": { "get": { "tags": [ "Financeiro - Conciliação Bancária" ], "parameters": [ { "name": "contaId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "ate", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MovimentoParaConciliarDto" } } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/conciliacao/desfazer/{id}": { "post": { "tags": [ "Financeiro - Conciliação Bancária" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DesfazerConciliacaoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/periodos": { "get": { "tags": [ "Financeiro - Fecho de Período" ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PeriodosFinanceirosDto" } } } } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/periodos/fechar": { "post": { "tags": [ "Financeiro - Fecho de Período" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FecharPeriodoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/periodos/reabrir": { "post": { "tags": [ "Financeiro - Fecho de Período" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReabrirPeriodoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/contas": { "get": { "tags": [ "Financeiro - Contas" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Financeiro - Contas" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarContaBancariaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/contas/{id}/extracto": { "get": { "tags": [ "Financeiro - Contas" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "de", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "ate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/contas/{id}": { "put": { "tags": [ "Financeiro - Contas" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DadosContaBancariaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/contas/{id}/saldo-inicial": { "put": { "tags": [ "Financeiro - Contas" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaldoInicialRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/contas/{id}/activa": { "put": { "tags": [ "Financeiro - Contas" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/contas/{id}/por-omissao": { "post": { "tags": [ "Financeiro - Contas" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/transferencias": { "post": { "tags": [ "Financeiro - Transferências" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferirEntreContasCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/transferencias/{id}/estornar": { "post": { "tags": [ "Financeiro - Transferências" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstornarTransferenciaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/receitas": { "post": { "tags": [ "Financeiro - Receitas avulsas" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistarReceitaAvulsaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/receitas/{id}/estornar": { "post": { "tags": [ "Financeiro - Receitas avulsas" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstornarTransferenciaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/financeiro/lancamentos": { "get": { "tags": [ "Financeiro - Lançamentos" ], "parameters": [ { "name": "de", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "ate", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "contaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "categoriaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "centroCustoId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "tipo", "in": "query", "schema": { "type": "string" } }, { "name": "semCategoria", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "incluirTransferencias", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/facturacao-electronica/estado": { "get": { "tags": [ "FacturacaoElectronica" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/facturacao-electronica/documentos": { "get": { "tags": [ "FacturacaoElectronica" ], "parameters": [ { "name": "estado", "in": "query", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/facturacao-electronica/documentos/{documentoId}": { "get": { "tags": [ "FacturacaoElectronica" ], "parameters": [ { "name": "documentoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/facturacao-electronica/comunicar": { "post": { "tags": [ "FacturacaoElectronica" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/centros": { "get": { "tags": [ "Produção" ], "parameters": [ { "name": "apenasActivos", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Produção" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarCentroDeTrabalhoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/centros/{id}": { "put": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualizarCentroRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/centros/{id}/activo": { "put": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefinirActivoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/fichas": { "get": { "tags": [ "Produção" ], "parameters": [ { "name": "filtro", "in": "query", "schema": { "type": "string" } }, { "name": "produtoId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "estado", "in": "query", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Produção" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarFichaTecnicaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/fichas/{id}": { "get": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "put": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualizarFichaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/fichas/{id}/activar": { "post": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/fichas/{id}/nova-versao": { "post": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/fichas/{id}/simulacao": { "get": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "quantidade", "in": "query", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } }, { "name": "custoOperacional", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/fichas/{id}/arvore": { "get": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "quantidade", "in": "query", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } }, { "name": "armazemId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/relatorios/custos-por-centro": { "get": { "tags": [ "Produção" ], "parameters": [ { "name": "de", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "ate", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/relatorios": { "get": { "tags": [ "Produção" ], "parameters": [ { "name": "de", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "ate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "produtoId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/painel": { "get": { "tags": [ "Produção" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/ordens": { "get": { "tags": [ "Produção" ], "parameters": [ { "name": "estado", "in": "query", "schema": { "type": "string" } }, { "name": "produtoId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Produção" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarOrdemDeProducaoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/ordens/{id}": { "get": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/ordens/{id}/planear": { "post": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/ordens/{id}/iniciar": { "post": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/ordens/{id}/concluir": { "post": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConcluirOrdemRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/ordens/{id}/cancelar": { "post": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/ordens/{id}/estornar": { "post": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/ordens/{id}/custos": { "post": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustoDaOrdemRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/rastreabilidade/lotes/{loteId}": { "get": { "tags": [ "Produção" ], "parameters": [ { "name": "loteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "sentido", "in": "query", "schema": { "type": "string" } }, { "name": "profundidade", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 6 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/planeamento/parametros": { "get": { "tags": [ "Produção" ], "parameters": [ { "name": "filtro", "in": "query", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/planeamento/parametros/{produtoId}": { "put": { "tags": [ "Produção" ], "parameters": [ { "name": "produtoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParametrosDePlaneamentoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "delete": { "tags": [ "Produção" ], "parameters": [ { "name": "produtoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/planeamento/procura": { "get": { "tags": [ "Produção" ], "parameters": [ { "name": "estado", "in": "query", "schema": { "type": "string" } }, { "name": "produtoId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Produção" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarProcuraDeProducaoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/planeamento/procura/{id}/cancelar": { "post": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/planeamento/qualidade": { "get": { "tags": [ "Produção" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/planeamento/carga": { "get": { "tags": [ "Produção" ], "parameters": [ { "name": "semanas", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 8 } }, { "name": "sugestoes", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/planeamento/planos": { "get": { "tags": [ "Produção" ], "parameters": [ { "name": "quantos", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 20 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Produção" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CorrerPlanoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/planeamento/planos/{id}": { "get": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/planeamento/planos/{id}/firmar": { "post": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirmarSugestoesRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/planeamento/planos/{id}/ignorar": { "post": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IgnorarSugestoesRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/planeamento/calendario": { "get": { "tags": [ "Produção" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/planeamento/calendario/dias-uteis": { "put": { "tags": [ "Produção" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiasUteisRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/planeamento/calendario/encerramentos": { "post": { "tags": [ "Produção" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiaDeEncerramentoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/planeamento/calendario/encerramentos/{id}": { "delete": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/qualidade/planos": { "get": { "tags": [ "Produção" ], "parameters": [ { "name": "produtoId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "momento", "in": "query", "schema": { "type": "string" } }, { "name": "apenasActivos", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Produção" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarPlanoDeInspeccaoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/qualidade/planos/{id}": { "get": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "put": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualizarPlanoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/qualidade/planos/{id}/desactivar": { "post": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/qualidade/inspeccoes": { "get": { "tags": [ "Produção" ], "parameters": [ { "name": "produtoId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "loteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "resultado", "in": "query", "schema": { "type": "string" } }, { "name": "momento", "in": "query", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Produção" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistarInspeccaoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/qualidade/inspeccoes/{id}": { "get": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/qualidade/por-inspeccionar": { "get": { "tags": [ "Produção" ], "parameters": [ { "name": "momento", "in": "query", "schema": { "type": "string" } }, { "name": "dias", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 90 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/qualidade/lotes": { "get": { "tags": [ "Produção" ], "parameters": [ { "name": "produtoId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/qualidade/quarentena/armazens": { "get": { "tags": [ "Produção" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Produção" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarArmazemRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/qualidade/quarentena/armazens/{id}": { "put": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuarentenaDoArmazemRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/qualidade/quarentena/lotes": { "get": { "tags": [ "Produção" ], "parameters": [ { "name": "situacao", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/qualidade/quarentena/lotes/{loteId}/colocar": { "post": { "tags": [ "Produção" ], "parameters": [ { "name": "loteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ColocarEmQuarentenaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/qualidade/quarentena/lotes/{loteId}/libertar": { "post": { "tags": [ "Produção" ], "parameters": [ { "name": "loteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LibertarLoteRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/qualidade/quarentena/movimentos": { "get": { "tags": [ "Produção" ], "parameters": [ { "name": "loteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "quantos", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/qualidade/nao-conformidades": { "get": { "tags": [ "Produção" ], "parameters": [ { "name": "estado", "in": "query", "schema": { "type": "string" } }, { "name": "produtoId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "loteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Produção" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbrirNaoConformidadeCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/qualidade/nao-conformidades/{id}": { "get": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/qualidade/nao-conformidades/{id}/causa": { "put": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CausaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/qualidade/nao-conformidades/{id}/accoes": { "post": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NovaAccaoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/qualidade/nao-conformidades/{id}/accoes/{accaoId}/concluir": { "post": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accaoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotasRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/qualidade/nao-conformidades/{id}/accoes/{accaoId}/cancelar": { "post": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "accaoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotasRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/qualidade/nao-conformidades/{id}/decisao": { "post": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecisaoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/qualidade/instrumentos": { "get": { "tags": [ "Produção" ], "parameters": [ { "name": "apenasActivos", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Produção" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarInstrumentoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/qualidade/instrumentos/{id}": { "put": { "tags": [ "Produção" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualizarInstrumentoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/qualidade/certificado/{loteId}": { "get": { "tags": [ "Produção" ], "parameters": [ { "name": "loteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/producao/qualidade/indicadores": { "get": { "tags": [ "Produção" ], "parameters": [ { "name": "dias", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 90 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/sala": { "get": { "tags": [ "Restauração" ], "parameters": [ { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "apenasActivas", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/sala/zonas": { "post": { "tags": [ "Restauração" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarZonaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/sala/zonas/{id}": { "put": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualizarZonaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/sala/zonas/{id}/activa": { "put": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefinirActivaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/sala/mesas": { "post": { "tags": [ "Restauração" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarMesaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/sala/mesas/{id}": { "put": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualizarMesaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/sala/mesas/{id}/activa": { "put": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefinirActivaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/sala/mesas/{id}/limpar": { "post": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/postos": { "get": { "tags": [ "Restauração" ], "parameters": [ { "name": "apenasActivos", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Restauração" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarPostoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/postos/{id}": { "put": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualizarPostoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/postos/{id}/activo": { "put": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefinirActivoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/menu": { "get": { "tags": [ "Restauração" ], "parameters": [ { "name": "filtro", "in": "query", "schema": { "type": "string" } }, { "name": "categoriaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 200 } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/produtos/{produtoId}/config": { "put": { "tags": [ "Restauração" ], "parameters": [ { "name": "produtoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigDoProdutoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/produtos/{produtoId}/esgotado": { "put": { "tags": [ "Restauração" ], "parameters": [ { "name": "produtoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefinirEsgotadoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/produtos/{produtoId}/quantidade-do-dia": { "put": { "tags": [ "Restauração" ], "parameters": [ { "name": "produtoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefinirQuantidadeDoDiaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/fichas": { "get": { "tags": [ "Restauração" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/fichas/{produtoId}": { "get": { "tags": [ "Restauração" ], "parameters": [ { "name": "produtoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "put": { "tags": [ "Restauração" ], "parameters": [ { "name": "produtoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefinirFichaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/ingredientes": { "get": { "tags": [ "Restauração" ], "parameters": [ { "name": "filtro", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/preparacoes/candidatos": { "get": { "tags": [ "Restauração" ], "parameters": [ { "name": "filtro", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/grupos-opcoes": { "get": { "tags": [ "Restauração" ], "parameters": [ { "name": "apenasActivos", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Restauração" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarGrupoDeOpcoesCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/grupos-opcoes/{id}": { "put": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActualizarGrupoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/produtos/{produtoId}/grupos": { "put": { "tags": [ "Restauração" ], "parameters": [ { "name": "produtoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GruposDoProdutoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/comandas": { "post": { "tags": [ "Restauração" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbrirComandaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/reservas": { "get": { "tags": [ "Restauração" ], "parameters": [ { "name": "dia", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "todas", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Restauração" ], "parameters": [ { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReservaDeMesaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/reservas/{id}": { "get": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "put": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReservaDeMesaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/reservas/{id}/chegou": { "post": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/reservas/{id}/sentar": { "post": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/SentarReservaDeMesaRequest" } ] } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/reservas/{id}/faltou": { "post": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/reservas/{id}/cancelar": { "post": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelarReservaDeMesaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/comandas/{id}": { "get": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/mesas/{mesaId}/comanda": { "get": { "tags": [ "Restauração" ], "parameters": [ { "name": "mesaId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/comandas/{id}/itens": { "post": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LancarItemRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/itens/{itemId}": { "put": { "tags": [ "Restauração" ], "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AlterarItemRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "delete": { "tags": [ "Restauração" ], "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/comandas/{id}/enviar": { "post": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EnviarRequest" } ] } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/itens/{itemId}/servir": { "post": { "tags": [ "Restauração" ], "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/itens/{itemId}/cancelar": { "post": { "tags": [ "Restauração" ], "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelarItemRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/itens/{itemId}/pedir-cancelamento": { "post": { "tags": [ "Restauração" ], "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PedirCancelamentoRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/itens/{itemId}/dispensar-pedido-cancelamento": { "post": { "tags": [ "Restauração" ], "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/comandas/{id}/anular": { "post": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AnularComandaRequest" } ] } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/comandas/{id}/transferir": { "post": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferirComandaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/comandas/{id}/juntar-mesas": { "post": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JuntarMesasRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/comandas/{id}/separar-mesa": { "post": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SepararMesaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/comandas/{id}/trocar-garcom": { "post": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrocarGarcomRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/comandas/{id}/mover-itens": { "post": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MoverItensRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/comandas/{id}/pre-conta": { "get": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/comandas/{id}/pedir-conta": { "post": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/comandas/{id}/reabrir-conta": { "post": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/comandas/{id}/cobrar": { "post": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CobrarRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/comandas/{id}/consulta-de-mesa": { "post": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ConsultaDeMesaRequest" } ] } } } }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/comandas/{id}/consultas-de-mesa": { "get": { "tags": [ "Restauração" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/postos/{postoId}/taloes": { "get": { "tags": [ "Restauração" ], "parameters": [ { "name": "postoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "historico", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/itens/{itemId}/iniciar": { "post": { "tags": [ "Restauração" ], "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/itens/{itemId}/pronto": { "post": { "tags": [ "Restauração" ], "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/itens/{itemId}/desfazer-pronto": { "post": { "tags": [ "Restauração" ], "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/taloes/{talaoId}/pronto": { "post": { "tags": [ "Restauração" ], "parameters": [ { "name": "talaoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/relatorio": { "get": { "tags": [ "Restauração" ], "parameters": [ { "name": "inicio", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "fim", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/engenharia-do-menu": { "get": { "tags": [ "Restauração" ], "parameters": [ { "name": "inicio", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "fim", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/reposicao": { "get": { "tags": [ "Restauração" ], "parameters": [ { "name": "dias", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 14 } }, { "name": "diasAlvo", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 7 } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/restauracao/auditoria": { "get": { "tags": [ "Restauração" ], "parameters": [ { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "userId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "mesaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "accao", "in": "query", "schema": { "type": "string" } }, { "name": "de", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "apenasSensiveis", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "limite", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/contratos": { "get": { "tags": [ "Contratos" ], "parameters": [ { "name": "estado", "in": "query", "schema": { "$ref": "#/components/schemas/EstadoDoContrato" } }, { "name": "sentido", "in": "query", "schema": { "$ref": "#/components/schemas/SentidoDoContrato" } }, { "name": "filtro", "in": "query", "schema": { "type": "string" } }, { "name": "clienteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "fornecedorId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 200 } }, { "name": "soMeus", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Contratos" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarContratoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/contratos/{id}": { "get": { "tags": [ "Contratos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "put": { "tags": [ "Contratos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EditarContratoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/contratos/pendentes-de-facturacao": { "get": { "tags": [ "Contratos" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/contratos/acertos": { "get": { "tags": [ "Contratos" ], "parameters": [ { "name": "estado", "in": "query", "schema": { "$ref": "#/components/schemas/EstadoDoAcerto" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/contratos/configuracao": { "get": { "tags": [ "Contratos" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/contratos/{id}/submeter": { "post": { "tags": [ "Contratos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/contratos/{id}/devolver": { "post": { "tags": [ "Contratos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ComentarioPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/contratos/{id}/aprovar": { "post": { "tags": [ "Contratos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/contratos/{id}/assinatura": { "post": { "tags": [ "Contratos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssinaturaPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/contratos/{id}/dispensar-assinatura": { "post": { "tags": [ "Contratos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/contratos/{id}/activar": { "post": { "tags": [ "Contratos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/contratos/{id}/suspender": { "post": { "tags": [ "Contratos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/contratos/{id}/reactivar": { "post": { "tags": [ "Contratos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/contratos/{id}/renovar": { "post": { "tags": [ "Contratos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenovarPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/contratos/{id}/rescindir": { "post": { "tags": [ "Contratos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RescindirPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/contratos/{id}/encerrar": { "post": { "tags": [ "Contratos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/contratos/{id}/adendas": { "post": { "tags": [ "Contratos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdendaPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/contratos/{id}/versoes/{numero}/aprovar": { "post": { "tags": [ "Contratos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "numero", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/contratos/{id}/versoes/{numero}/recusar": { "post": { "tags": [ "Contratos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "numero", "in": "path", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": "integer", "format": "int32" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/contratos/acertos/{id}/resolver": { "post": { "tags": [ "Contratos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReferenciaPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/contratos/acertos/{id}/dispensar": { "post": { "tags": [ "Contratos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/contratos/{id}/documentos": { "post": { "tags": [ "Contratos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "tipo", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/TipoDeDocumentoDoContrato" } }, { "name": "versao", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "ficheiro" ], "type": "object", "properties": { "ficheiro": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/contratos/{id}/documentos/{documentoId}": { "get": { "tags": [ "Contratos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "documentoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/contratos/modelos": { "get": { "tags": [ "Contratos" ], "parameters": [ { "name": "apenasActivos", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Contratos" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModeloInput" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/contratos/modelos/{id}": { "put": { "tags": [ "Contratos" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ModeloInput" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/contratos/gerar-facturas": { "post": { "tags": [ "Contratos" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/profissionais": { "get": { "tags": [ "Marcações" ], "parameters": [ { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "apenasActivos", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Marcações" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarProfissionalCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/profissionais/{id}": { "put": { "tags": [ "Marcações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProfissionalPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/profissionais/{id}/activo": { "put": { "tags": [ "Marcações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/recursos": { "get": { "tags": [ "Marcações" ], "parameters": [ { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "apenasActivos", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Marcações" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarRecursoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/recursos/{id}": { "put": { "tags": [ "Marcações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarRecursoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/servicos": { "get": { "tags": [ "Marcações" ], "parameters": [ { "name": "apenasActivos", "in": "query", "schema": { "type": "boolean", "default": true } }, { "name": "apenasOnline", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Marcações" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarServicoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/servicos/{id}": { "put": { "tags": [ "Marcações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarServicoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/horarios": { "get": { "tags": [ "Marcações" ], "parameters": [ { "name": "alvo", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/AlvoDoHorario" } }, { "name": "alvoId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "put": { "tags": [ "Marcações" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefinirHorarioCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/excepcoes": { "get": { "tags": [ "Marcações" ], "parameters": [ { "name": "alvo", "in": "query", "schema": { "$ref": "#/components/schemas/AlvoDoHorario" } }, { "name": "alvoId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "de", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "ate", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Marcações" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarExcepcaoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/excepcoes/{id}": { "delete": { "tags": [ "Marcações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/configuracao": { "get": { "tags": [ "Marcações" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "put": { "tags": [ "Marcações" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefinirConfiguracaoDaAgendaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/disponibilidade": { "get": { "tags": [ "Marcações" ], "parameters": [ { "name": "servicoId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "de", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "profissionalId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "maximo", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 100 } }, { "name": "soSugeridas", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/agenda": { "get": { "tags": [ "Marcações" ], "parameters": [ { "name": "de", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "profissionalId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/ocupacao": { "get": { "tags": [ "Marcações" ], "parameters": [ { "name": "de", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "ate", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/clientes/{clienteId}/historico": { "get": { "tags": [ "Marcações" ], "parameters": [ { "name": "clienteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "maximo", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 30 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/{id}": { "get": { "tags": [ "Marcações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes": { "post": { "tags": [ "Marcações" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarMarcacaoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/series": { "post": { "tags": [ "Marcações" ], "parameters": [ { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SeriePedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/series/{serieId}/cancelar": { "post": { "tags": [ "Marcações" ], "parameters": [ { "name": "serieId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelamentoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/{id}/aprovar": { "post": { "tags": [ "Marcações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/{id}/deposito": { "post": { "tags": [ "Marcações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DepositoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/{id}/nota": { "put": { "tags": [ "Marcações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotaPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/{id}/reconfirmar": { "post": { "tags": [ "Marcações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/{id}/chegou": { "post": { "tags": [ "Marcações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/{id}/iniciar": { "post": { "tags": [ "Marcações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/{id}/pausar": { "post": { "tags": [ "Marcações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/{id}/retomar": { "post": { "tags": [ "Marcações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/{id}/concluir": { "post": { "tags": [ "Marcações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/{id}/cancelar": { "post": { "tags": [ "Marcações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelamentoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/{id}/faltou": { "post": { "tags": [ "Marcações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/{id}/servicos": { "post": { "tags": [ "Marcações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServicoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/{id}/reagendar": { "post": { "tags": [ "Marcações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReagendamentoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/{id}/conta": { "post": { "tags": [ "Marcações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContaPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/comissoes": { "get": { "tags": [ "Marcações" ], "parameters": [ { "name": "de", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "profissionalId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/fila": { "get": { "tags": [ "Marcações" ], "parameters": [ { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Marcações" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntrarNaFilaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/fila/{id}/chamar": { "post": { "tags": [ "Marcações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChamadaPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/fila/{id}/desistir": { "post": { "tags": [ "Marcações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/lista-de-espera": { "get": { "tags": [ "Marcações" ], "parameters": [ { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "apenasActivos", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Marcações" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AdicionarPedidoDeEsperaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/lista-de-espera/{id}/cancelar": { "post": { "tags": [ "Marcações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/ofertas/{id}/aceitar": { "post": { "tags": [ "Marcações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/ofertas/{id}/recusar": { "post": { "tags": [ "Marcações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/notificacoes": { "get": { "tags": [ "Marcações" ], "parameters": [ { "name": "estado", "in": "query", "schema": { "$ref": "#/components/schemas/EstadoDaNotificacao" } }, { "name": "canal", "in": "query", "schema": { "$ref": "#/components/schemas/CanalDeNotificacao" } }, { "name": "marcacaoId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "maximo", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/marcacoes/notificacoes/{id}/enviada": { "post": { "tags": [ "Marcações" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/categorias": { "get": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "apenasActivas", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Lavandaria" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarCategoriaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/categorias/{id}": { "put": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarCategoriaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/tipos-de-roupa": { "get": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "apenasActivos", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Lavandaria" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarTipoDeRoupaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/tipos-de-roupa/{id}": { "put": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarTipoDeRoupaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/servicos": { "get": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "apenasActivos", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Lavandaria" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarServicoDeLavandariaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/servicos/{id}": { "put": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarServicoDeLavandariaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/urgencias": { "get": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "apenasActivas", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Lavandaria" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarUrgenciaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/urgencias/{id}": { "put": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarUrgenciaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/maquinas": { "get": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "apenasActivas", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Lavandaria" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarMaquinaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/maquinas/{id}": { "put": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarMaquinaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/maquinas/{id}/avaria": { "post": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotaPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/maquinas/{id}/manutencao": { "post": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotaPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/maquinas/{id}/servico": { "post": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/configuracao": { "get": { "tags": [ "Lavandaria" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "put": { "tags": [ "Lavandaria" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefinirConfiguracaoDaLavandariaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/ordens": { "get": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "estado", "in": "query", "schema": { "$ref": "#/components/schemas/EstadoDaOrdem" } }, { "name": "filtro", "in": "query", "schema": { "type": "string" } }, { "name": "soAtrasadas", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "soPorLevantar", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "clienteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "maximo", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Lavandaria" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceberOrdemCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/ordens/{id}": { "get": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/ordens/{id}/cancelar": { "post": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/ordens/{id}/levantamento/preparacao": { "get": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "itensIds", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/ordens/{id}/levantamento": { "post": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LevantamentoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/ordens/{id}/abandonar": { "post": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DestinoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/prazo": { "get": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "servicosIds", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "urgenciaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "pesoKg", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/pecas/{codigo}": { "get": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "codigo", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/pecas/avancar": { "post": { "tags": [ "Lavandaria" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvancarPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/pecas/qualidade/aprovar": { "post": { "tags": [ "Lavandaria" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AprovarPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/pecas/qualidade/reprovar": { "post": { "tags": [ "Lavandaria" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReprovarPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/pecas/{itemId}/peso-de-saida": { "put": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PesoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/pecas/{itemId}/peso-de-entrada": { "put": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PesoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/pecas/{itemId}/fotos": { "post": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "momento", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/MomentoDaFoto" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "ficheiro" ], "type": "object", "properties": { "ficheiro": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/fotos/{id}": { "get": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/quadro": { "get": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/lotes/fila": { "get": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "fase", "in": "query", "schema": { "default": "Lavagem", "$ref": "#/components/schemas/FaseDaPeca" } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/lotes/sugestao": { "get": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "fase", "in": "query", "schema": { "default": "Lavagem", "$ref": "#/components/schemas/FaseDaPeca" } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/lotes": { "get": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "estado", "in": "query", "schema": { "$ref": "#/components/schemas/EstadoDoLote" } }, { "name": "maximo", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 50 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Lavandaria" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FecharLoteCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/lotes/{id}/terminar": { "post": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/lotes/{id}/parar": { "post": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/incidentes": { "get": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "estado", "in": "query", "schema": { "$ref": "#/components/schemas/EstadoDoIncidente" } }, { "name": "ordemId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "maximo", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Lavandaria" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AbrirIncidenteCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/incidentes/{id}/resolver": { "post": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolverPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/notificacoes": { "get": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "estado", "in": "query", "schema": { "$ref": "#/components/schemas/EstadoDaMensagem" } }, { "name": "canal", "in": "query", "schema": { "$ref": "#/components/schemas/CanalDaMensagem" } }, { "name": "ordemId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "maximo", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/notificacoes/{id}/enviada": { "post": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/lavandaria/painel": { "get": { "tags": [ "Lavandaria" ], "parameters": [ { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/modelos": { "get": { "tags": [ "Beleza" ], "parameters": [ { "name": "segmento", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/servicos": { "get": { "tags": [ "Beleza" ], "parameters": [ { "name": "apenasActivos", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/servicos/{servicoId}": { "put": { "tags": [ "Beleza" ], "parameters": [ { "name": "servicoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AtributosInput" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/servicos/de-modelo": { "post": { "tags": [ "Beleza" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarServicoDeModeloCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/configuracao": { "get": { "tags": [ "Beleza" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "put": { "tags": [ "Beleza" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefinirConfiguracaoDaBelezaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/clientes/{clienteId}/ficha": { "get": { "tags": [ "Beleza" ], "parameters": [ { "name": "clienteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "put": { "tags": [ "Beleza" ], "parameters": [ { "name": "clienteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FichaPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/clientes/{clienteId}/condicoes": { "post": { "tags": [ "Beleza" ], "parameters": [ { "name": "clienteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CondicaoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/condicoes/{id}/remover": { "post": { "tags": [ "Beleza" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/clientes/{clienteId}/testes": { "post": { "tags": [ "Beleza" ], "parameters": [ { "name": "clienteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestePedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/testes/{id}/resultado": { "post": { "tags": [ "Beleza" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResultadoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/testes/{id}/anular": { "post": { "tags": [ "Beleza" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/clientes/{clienteId}/registos": { "get": { "tags": [ "Beleza" ], "parameters": [ { "name": "clienteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "maximo", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 60 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Beleza" ], "parameters": [ { "name": "clienteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/registos/{id}/repetir": { "post": { "tags": [ "Beleza" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RepetirPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/clientes/{clienteId}/consentimentos": { "post": { "tags": [ "Beleza" ], "parameters": [ { "name": "clienteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsentimentoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/consentimentos/{id}/revogar": { "post": { "tags": [ "Beleza" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/clientes/{clienteId}/fotos": { "post": { "tags": [ "Beleza" ], "parameters": [ { "name": "clienteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "momento", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "servicoDaMarcacaoId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "nota", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "ficheiro" ], "type": "object", "properties": { "ficheiro": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/fotos/{id}": { "get": { "tags": [ "Beleza" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/clientes/{clienteId}/acessos": { "get": { "tags": [ "Beleza" ], "parameters": [ { "name": "clienteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "maximo", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/marcacoes/{marcacaoId}/verificacao": { "get": { "tags": [ "Beleza" ], "parameters": [ { "name": "marcacaoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "fase", "in": "query", "schema": { "type": "string", "default": "Iniciar" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/verificar-pedido": { "post": { "tags": [ "Beleza" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerificarPedidoQuery" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/marcacoes/{marcacaoId}/cartao": { "get": { "tags": [ "Beleza" ], "parameters": [ { "name": "marcacaoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/marcacoes/{marcacaoId}/respostas": { "post": { "tags": [ "Beleza" ], "parameters": [ { "name": "marcacaoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RespostaPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/marcacoes/{marcacaoId}/doses": { "post": { "tags": [ "Beleza" ], "parameters": [ { "name": "marcacaoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DosePedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/rebooks": { "get": { "tags": [ "Beleza" ], "parameters": [ { "name": "estado", "in": "query", "schema": { "type": "string" } }, { "name": "dias", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 60 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/marcacoes/{marcacaoId}/rebook": { "post": { "tags": [ "Beleza" ], "parameters": [ { "name": "marcacaoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RebookPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/rebooks/{id}/aceitar": { "post": { "tags": [ "Beleza" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AceitarPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/rebooks/{id}/recusar": { "post": { "tags": [ "Beleza" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/kits": { "get": { "tags": [ "Beleza" ], "parameters": [ { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "apenasActivos", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Beleza" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KitPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/kits/{id}": { "put": { "tags": [ "Beleza" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KitPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/kits/ler": { "post": { "tags": [ "Beleza" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LeituraPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/kits/{id}/sujo": { "post": { "tags": [ "Beleza" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/kits/{id}/esterilizacao/iniciar": { "post": { "tags": [ "Beleza" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/kits/{id}/esterilizacao/concluir": { "post": { "tags": [ "Beleza" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EsterilizacaoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/higiene/relatorio": { "get": { "tags": [ "Beleza" ], "parameters": [ { "name": "de", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/beleza/indicadores": { "get": { "tags": [ "Beleza" ], "parameters": [ { "name": "de", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "ate", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/definicoes": { "get": { "tags": [ "Oficina" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "put": { "tags": [ "Oficina" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefinirDefinicoesDaOficinaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/modelos": { "get": { "tags": [ "Oficina" ], "parameters": [ { "name": "perfil", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/catalogo/carregar-partida": { "post": { "tags": [ "Oficina" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarregarCatalogoDePartidaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/operacoes": { "get": { "tags": [ "Oficina" ], "parameters": [ { "name": "apenasActivas", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Oficina" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarOperacaoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/operacoes/{id}": { "put": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarOperacaoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/operacoes/de-modelo": { "post": { "tags": [ "Oficina" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarOperacaoDeModeloCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/operacoes/{id}/activa": { "put": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/pontos": { "get": { "tags": [ "Oficina" ], "parameters": [ { "name": "apenasActivos", "in": "query", "schema": { "type": "boolean", "default": true } }, { "name": "perfil", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Oficina" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarPontoDeInspeccaoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/pontos/{id}": { "put": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarPontoDeInspeccaoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/pontos/{id}/activo": { "put": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/boxes": { "get": { "tags": [ "Oficina" ], "parameters": [ { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "apenasActivas", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Oficina" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarBoxCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/boxes/{id}": { "put": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarBoxCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/zonas": { "get": { "tags": [ "Oficina" ], "parameters": [ { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "apenasActivas", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Oficina" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarZonaDePatioCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/zonas/{id}": { "put": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarZonaDePatioCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/viaturas": { "get": { "tags": [ "Oficina" ], "parameters": [ { "name": "texto", "in": "query", "schema": { "type": "string" } }, { "name": "clienteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "apenasActivas", "in": "query", "schema": { "type": "boolean", "default": true } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 30 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Oficina" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegistarViaturaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/viaturas/{id}": { "get": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "put": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ViaturaPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/viaturas/{id}/transferir": { "post": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransferenciaPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/viaturas/{id}/activa": { "put": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/viaturas/{id}/km": { "post": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KmPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/viaturas/{id}/livro": { "get": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/viaturas/{id}/garantias": { "get": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/viaturas/{id}/documentos": { "post": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoDaViaturaPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/viaturas/{id}/documentos/{documentoId}": { "put": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "documentoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentoDaViaturaPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "delete": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "documentoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/viaturas/{id}/plano": { "post": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemDoPlanoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/viaturas/{id}/plano/{itemId}": { "put": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemDoPlanoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "delete": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/lembretes": { "get": { "tags": [ "Oficina" ], "parameters": [ { "name": "dias", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 30 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/ordens": { "get": { "tags": [ "Oficina" ], "parameters": [ { "name": "texto", "in": "query", "schema": { "type": "string" } }, { "name": "estado", "in": "query", "schema": { "type": "string" } }, { "name": "soAbertas", "in": "query", "schema": { "type": "boolean", "default": true } }, { "name": "mecanicoId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "viaturaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "clienteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 60 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Oficina" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceberViaturaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/ordens/{id}": { "get": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/quadro": { "get": { "tags": [ "Oficina" ], "parameters": [ { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/patio": { "get": { "tags": [ "Oficina" ], "parameters": [ { "name": "lojaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/ordens/{id}/termo": { "post": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TermoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/ordens/{id}/patio": { "post": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PatioPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/ordens/{id}/prazo": { "post": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrazoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/ordens/{id}/diagnostico": { "post": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiagnosticoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/ordens/{id}/inspeccao": { "post": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InspeccaoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/ordens/{id}/trabalhos": { "post": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrabalhoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/ordens/{id}/trabalhos/de-operacao": { "post": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrabalhoDeOperacaoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/ordens/{id}/trabalhos/{trabalhoId}": { "put": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "trabalhoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrabalhoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "delete": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "trabalhoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/ordens/{id}/orcamento": { "post": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnvioPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/ordens/{id}/trabalhos/{trabalhoId}/decisao": { "post": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "trabalhoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DecisaoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/ordens/{id}/trabalhos/{trabalhoId}/peca-em-falta": { "post": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "trabalhoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PecaEmFaltaPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/ordens/{id}/trabalhos/{trabalhoId}/atribuir": { "post": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "trabalhoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AtribuicaoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/ordens/{id}/trabalhos/{trabalhoId}/iniciar": { "post": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "trabalhoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IniciarPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/ordens/{id}/trabalhos/{trabalhoId}/pausar": { "post": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "trabalhoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PausaPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/ordens/{id}/trabalhos/{trabalhoId}/terminar": { "post": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "trabalhoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/ordens/{id}/trabalhos/{trabalhoId}/linhas/{linhaId}/aplicar": { "post": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "trabalhoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "linhaId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AplicarPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/ordens/{id}/qualidade/aprovar": { "post": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QualidadePedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/ordens/{id}/qualidade/reprovar": { "post": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReprovacaoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/ordens/{id}/entrega/preparacao": { "get": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "armazemId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/ordens/{id}/entrega": { "post": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EntregaPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/ordens/{id}/cancelar": { "post": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/ordens/{id}/responsabilidade": { "post": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponsabilidadePedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/garantias/{garantiaId}/reclamar": { "post": { "tags": [ "Oficina" ], "parameters": [ { "name": "garantiaId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReclamacaoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/ordens/{id}/fotos": { "post": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "momento", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "trabalhoId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "inspeccaoId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "nota", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "required": [ "ficheiro" ], "type": "object", "properties": { "ficheiro": { "$ref": "#/components/schemas/IFormFile" } } } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/fotos/{id}": { "get": { "tags": [ "Oficina" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/oficina/indicadores": { "get": { "tags": [ "Oficina" ], "parameters": [ { "name": "de", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "ate", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/propriedades": { "get": { "tags": [ "Hospedagem" ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Hospedagem" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarPropriedadeCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/propriedades/{id}": { "put": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarPropriedadeCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/tipos-de-quarto": { "get": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "propriedadeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "apenasActivos", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Hospedagem" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarTipoDeQuartoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/tipos-de-quarto/{id}": { "put": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarTipoDeQuartoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/quartos": { "get": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "propriedadeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "apenasActivos", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Hospedagem" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarQuartoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/quartos/{id}": { "put": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarQuartoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/planos": { "get": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "propriedadeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "apenasActivos", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Hospedagem" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarPlanoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/planos/{id}": { "put": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarPlanoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/tarifas": { "get": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "planoId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "de", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "ate", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/tarifas/base": { "put": { "tags": [ "Hospedagem" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefinirTarifaBaseCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/tarifas/dias": { "put": { "tags": [ "Hospedagem" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefinirTarifasDoDiaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/tarifas/dias/remover": { "post": { "tags": [ "Hospedagem" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoverTarifasDoDiaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/restricoes": { "get": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "propriedadeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "de", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "ate", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Hospedagem" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarRestricaoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/restricoes/{id}": { "put": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarRestricaoCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "delete": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/extras": { "get": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "propriedadeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "apenasActivos", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Hospedagem" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarExtraCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/extras/{id}": { "put": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarExtraCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/taxas": { "get": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "propriedadeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "apenasActivas", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Hospedagem" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarTaxaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/taxas/{id}": { "put": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarTaxaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/calendario": { "get": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "de", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "ate", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "propriedadeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "planoId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/orcamento": { "get": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "planoId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "tipoDeQuartoId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "chegada", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "partida", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "adultos", "in": "query", "required": true, "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "propriedadeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "criancas", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } }, { "name": "quartos", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 } }, { "name": "permitirOverbooking", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "excluirReservaId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/reservas": { "get": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "propriedadeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "texto", "in": "query", "schema": { "type": "string" } }, { "name": "estado", "in": "query", "schema": { "type": "string" } }, { "name": "de", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "ate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "clienteId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "soAbertas", "in": "query", "schema": { "type": "boolean", "default": true } }, { "name": "tamanho", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 100 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Hospedagem" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarReservaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/reservas/{id}": { "get": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/chegadas": { "get": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "propriedadeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "data", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/partidas": { "get": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "propriedadeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "data", "in": "query", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/em-casa": { "get": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "propriedadeId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/mapa": { "get": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "propriedadeId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/reservas/{id}/confirmar": { "post": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmarPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/reservas/{id}/cancelar": { "post": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/reservas/{id}/dados": { "put": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DadosPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/reservas/{id}/estadias": { "post": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstadiaPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/reservas/{id}/estadias/{estadiaId}": { "put": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "estadiaId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstadiaPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "delete": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "estadiaId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/reservas/{id}/estadias/{estadiaId}/quarto": { "put": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "estadiaId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuartoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/reservas/{id}/depositos/pedir": { "post": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DepositoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/reservas/{id}/depositos/registar": { "post": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DepositoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/depositos/{id}/pago": { "post": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DepositoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/depositos/{id}/devolver": { "post": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/reservas/{id}/ocupantes": { "post": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OcupantePedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/ocupantes/{id}": { "delete": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/reservas/{id}/check-in": { "post": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckInPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/reservas/{id}/pre-check-in": { "post": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/reservas/{id}/check-out": { "post": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckOutPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/reservas/{id}/estadias/{estadiaId}/estender": { "post": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "estadiaId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstenderPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/reservas/{id}/estadias/{estadiaId}/trocar-quarto": { "post": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "estadiaId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrocaPedida" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/reservas/{id}/folio": { "get": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/reservas/{id}/folio/lancamentos": { "post": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LancamentoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/reservas/{id}/folio/taxas": { "post": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/reservas/{id}/folio/lancamentos/{lancamentoId}/estornar": { "post": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "lancamentoId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EstornoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/reservas/{id}/folio/limite": { "put": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LimitePedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/reservas/{id}/folio/facturacao": { "get": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "janela", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/reservas/{id}/folio/facturar": { "post": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FacturarPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/fichas/{clienteId}": { "get": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "clienteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "put": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "clienteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GuardarFichaCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/fichas/{clienteId}/abrir": { "post": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "clienteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/fichas/{clienteId}/acessos": { "get": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "clienteId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/housekeeping/plano": { "get": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "propriedadeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "data", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "minhas", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/housekeeping/plano/gerar": { "post": { "tags": [ "Hospedagem" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlanoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/housekeeping/plano/distribuir": { "post": { "tags": [ "Hospedagem" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DistribuirPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/housekeeping/tarefas/{id}/camareira": { "put": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CamareiraPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/housekeeping/tarefas/{id}/iniciar": { "post": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/housekeeping/tarefas/{id}/concluir": { "post": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/housekeeping/tarefas/{id}/nao-incomodar": { "post": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotaPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/housekeeping/tarefas/{id}/inspeccionar": { "post": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InspeccaoPedida" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/housekeeping/minibar": { "post": { "tags": [ "Hospedagem" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MinibarPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/manutencao/tickets": { "get": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "propriedadeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "estado", "in": "query", "schema": { "type": "string" } }, { "name": "quartoId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "apenasAbertos", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Hospedagem" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarTicketCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/manutencao/tickets/{id}/tecnico": { "put": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TecnicoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/manutencao/tickets/{id}/iniciar": { "post": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/manutencao/tickets/{id}/resolver": { "post": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResolucaoPedida" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/manutencao/tickets/{id}/cancelar": { "post": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MotivoPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/manutencao/tickets/{id}/prioridade": { "put": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrioridadePedida" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/bloqueios": { "get": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "propriedadeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "apenasEmVigor", "in": "query", "schema": { "type": "boolean", "default": true } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] }, "post": { "tags": [ "Hospedagem" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CriarBloqueioCommand" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/bloqueios/{id}/encerrar": { "post": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/night-audit": { "get": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "propriedadeId", "in": "query", "schema": { "type": "string", "format": "uuid" } }, { "name": "tomar", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 30 } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/night-audit/fechar": { "post": { "tags": [ "Hospedagem" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FecharPedido" } } }, "required": true }, "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } }, "/api/hospedagem/indicadores": { "get": { "tags": [ "Hospedagem" ], "parameters": [ { "name": "de", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "ate", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "propriedadeId", "in": "query", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK" } }, "security": [ { "ChaveApi": [] } ] } } }, "components": { "schemas": { "AbrirComandaCommand": { "required": [ "mesaId", "pessoas" ], "type": "object", "properties": { "mesaId": { "type": "string", "format": "uuid" }, "pessoas": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "AbrirIncidenteCommand": { "required": [ "ordemId", "itemId", "tipo", "descricao", "darComoPerdida" ], "type": "object", "properties": { "ordemId": { "type": "string", "format": "uuid" }, "itemId": { "type": [ "null", "string" ], "format": "uuid" }, "tipo": { "$ref": "#/components/schemas/TipoDeIncidente" }, "descricao": { "type": "string" }, "darComoPerdida": { "type": "boolean" } } }, "AbrirLitigioCommand": { "required": [ "funcionarioId", "processoDisciplinarId", "foro", "numeroProcesso", "dataInicio", "descricao", "valorReclamado" ], "type": "object", "properties": { "funcionarioId": { "type": "string", "format": "uuid" }, "processoDisciplinarId": { "type": [ "null", "string" ], "format": "uuid" }, "foro": { "$ref": "#/components/schemas/ForoLitigio" }, "numeroProcesso": { "type": [ "null", "string" ] }, "dataInicio": { "type": "string", "format": "date" }, "descricao": { "type": "string" }, "valorReclamado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "AbrirNaoConformidadeCommand": { "required": [ "produtoId", "descricao" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "descricao": { "type": "string" }, "loteId": { "type": [ "null", "string" ], "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "causa": { "type": [ "null", "string" ] } } }, "AbrirProcessoDisciplinarCommand": { "required": [ "funcionarioId", "dataOcorrencia", "dataConhecimento", "descricao" ], "type": "object", "properties": { "funcionarioId": { "type": "string", "format": "uuid" }, "dataOcorrencia": { "type": "string", "format": "date" }, "dataConhecimento": { "type": "string", "format": "date" }, "descricao": { "type": "string" } } }, "AceitarPadroesRequest": { "required": [ "validadoPor" ], "type": "object", "properties": { "validadoPor": { "type": [ "null", "string" ] } } }, "AceitarPedido": { "required": [ "inicio", "profissionalId" ], "type": "object", "properties": { "inicio": { "type": "string", "format": "date-time" }, "profissionalId": { "type": [ "null", "string" ], "format": "uuid" } } }, "ActivaRequest": { "required": [ "activa" ], "type": "object", "properties": { "activa": { "type": "boolean" } } }, "ActivaRubricaRequest": { "required": [ "activa" ], "type": "object", "properties": { "activa": { "type": "boolean" } } }, "ActividadeFluxoCaixa": { "enum": [ "Operacional", "Investimento", "Financiamento" ], "default": "Operacional" }, "ActividadeFluxoDto": { "required": [ "actividade", "entradas", "saidas", "liquido", "rubricas" ], "type": "object", "properties": { "actividade": { "type": "string" }, "entradas": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "saidas": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "liquido": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "rubricas": { "type": "array", "items": { "$ref": "#/components/schemas/RubricaFluxoDto" } } } }, "ActividadeRequest": { "required": [ "actividade" ], "type": "object", "properties": { "actividade": { "$ref": "#/components/schemas/ActividadeFluxoCaixa" } } }, "ActivoPedido": { "required": [ "activo" ], "type": "object", "properties": { "activo": { "type": "boolean" } } }, "ActivoRequest": { "required": [ "activo" ], "type": "object", "properties": { "activo": { "type": "boolean" } } }, "ActualizacaoAcidenteRequest": { "required": [ "tipo", "data", "descricao", "dias" ], "type": "object", "properties": { "tipo": { "$ref": "#/components/schemas/TipoActualizacaoAcidente" }, "data": { "type": "string", "format": "date" }, "descricao": { "type": [ "null", "string" ] }, "dias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "ActualizarAcordoRequest": { "required": [ "nome", "ambito", "fonte", "vigenteAte" ], "type": "object", "properties": { "nome": { "type": "string" }, "ambito": { "type": [ "null", "string" ] }, "fonte": { "type": "string" }, "vigenteAte": { "type": [ "null", "string" ], "format": "date" } } }, "ActualizarAvaliacaoRequest": { "required": [ "avaliadorId", "pontuacao", "resumo", "metasCumpridas" ], "type": "object", "properties": { "avaliadorId": { "type": "string", "format": "uuid" }, "pontuacao": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "resumo": { "type": [ "null", "string" ] }, "metasCumpridas": { "type": [ "null", "boolean" ] } } }, "ActualizarCentroRequest": { "required": [ "codigo", "nome" ], "type": "object", "properties": { "codigo": { "type": "string" }, "nome": { "type": "string" }, "custoPorHora": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "horasPorDia": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 8 }, "postos": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 }, "eficienciaPercentual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 100 } } }, "ActualizarFichaRequest": { "required": [ "codigo", "nome", "produtoId", "rendimento", "linhas" ], "type": "object", "properties": { "codigo": { "type": "string" }, "nome": { "type": "string" }, "produtoId": { "type": "string", "format": "uuid" }, "rendimento": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "linhas": { "type": "array", "items": { "$ref": "#/components/schemas/LinhaDaFichaInput" } }, "observacao": { "type": [ "null", "string" ] }, "operacoes": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/OperacaoDaFichaInput" } }, "saidas": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SaidaDaFichaInput" } }, "criterio": { "type": [ "null", "string" ] }, "valorDeReferenciaDoPrincipal": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "ActualizarGrupoRequest": { "required": [ "nome", "minimo", "maximo", "ordem", "activo", "opcoes" ], "type": "object", "properties": { "nome": { "type": "string" }, "minimo": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "maximo": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "ordem": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "activo": { "type": "boolean" }, "opcoes": { "type": "array", "items": { "$ref": "#/components/schemas/OpcaoInput" } } } }, "ActualizarInstrumentoRequest": { "required": [ "nome", "validadeDaCalibracao", "observacao" ], "type": "object", "properties": { "nome": { "type": "string" }, "validadeDaCalibracao": { "type": [ "null", "string" ], "format": "date" }, "observacao": { "type": [ "null", "string" ] }, "activo": { "type": "boolean", "default": true } } }, "ActualizarLinhasCessacaoRequest": { "required": [ "linhas" ], "type": "object", "properties": { "linhas": { "type": "array", "items": { "$ref": "#/components/schemas/EdicaoLinhaCessacaoDto" } } } }, "ActualizarMesaRequest": { "required": [ "zonaId", "numero", "capacidade", "forma", "x", "y", "largura", "altura" ], "type": "object", "properties": { "zonaId": { "type": "string", "format": "uuid" }, "numero": { "type": "string" }, "capacidade": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "forma": { "type": "string" }, "x": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "y": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "largura": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "altura": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "ActualizarPlanoRequest": { "required": [ "observacao", "pontos" ], "type": "object", "properties": { "observacao": { "type": [ "null", "string" ] }, "pontos": { "type": "array", "items": { "$ref": "#/components/schemas/PontoDeControloInput" } }, "exigeLibertacao": { "type": "boolean", "default": false } } }, "ActualizarPostoRequest": { "required": [ "nome", "ordem", "usaPassoEmPreparacao" ], "type": "object", "properties": { "nome": { "type": "string" }, "ordem": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "usaPassoEmPreparacao": { "type": "boolean" } } }, "ActualizarZonaRequest": { "required": [ "nome", "ordem" ], "type": "object", "properties": { "nome": { "type": "string" }, "ordem": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "AdendaPedido": { "required": [ "dataDeEfeito", "motivo", "termos" ], "type": "object", "properties": { "dataDeEfeito": { "type": "string", "format": "date" }, "motivo": { "type": "string" }, "termos": { "$ref": "#/components/schemas/TermosInput" } } }, "AdesaoAcordoRequest": { "required": [ "funcionarioId", "categoria", "desde" ], "type": "object", "properties": { "funcionarioId": { "type": "string", "format": "uuid" }, "categoria": { "type": [ "null", "string" ] }, "desde": { "type": "string", "format": "date" } } }, "AdicionarPedidoDeEsperaCommand": { "required": [ "lojaId", "clienteId", "servicoId", "profissionalId", "de", "ate", "depoisDas", "antesDas", "vip" ], "type": "object", "properties": { "lojaId": { "type": [ "null", "string" ], "format": "uuid" }, "clienteId": { "type": "string", "format": "uuid" }, "servicoId": { "type": "string", "format": "uuid" }, "profissionalId": { "type": [ "null", "string" ], "format": "uuid" }, "de": { "type": "string", "format": "date" }, "ate": { "type": "string", "format": "date" }, "depoisDas": { "type": [ "null", "string" ] }, "antesDas": { "type": [ "null", "string" ] }, "vip": { "type": "boolean" } } }, "AlteracaoFiscalDto": { "required": [ "id", "pergunta", "titulo", "valorAnterior", "confirmadaAnterior", "valorNovo", "confirmadaNova", "validadoPor", "utilizadorNome", "emUtc" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "pergunta": { "type": "string" }, "titulo": { "type": "string" }, "valorAnterior": { "type": [ "null", "string" ] }, "confirmadaAnterior": { "type": [ "null", "boolean" ] }, "valorNovo": { "type": "string" }, "confirmadaNova": { "type": "boolean" }, "validadoPor": { "type": [ "null", "string" ] }, "utilizadorNome": { "type": [ "null", "string" ] }, "emUtc": { "type": "string", "format": "date-time" } } }, "AlterarContratoRequest": { "required": [ "contrato", "motivo" ], "type": "object", "properties": { "contrato": { "$ref": "#/components/schemas/DadosContrato" }, "motivo": { "type": [ "null", "string" ] } } }, "AlterarItemRequest": { "required": [ "quantidade" ], "type": "object", "properties": { "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "observacao": { "type": [ "null", "string" ] }, "lugar": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "fase": { "$ref": "#/components/schemas/FaseDoServico" } } }, "AlvoDoHorario": { "enum": [ "Loja", "Profissional", "Recurso" ] }, "AnularComandaRequest": { "type": "object", "properties": { "motivo": { "type": [ "null", "string" ] } } }, "AnularDespesaRequest": { "required": [ "motivo" ], "type": "object", "properties": { "motivo": { "type": "string" } } }, "AnularReciboRequest": { "required": [ "motivo" ], "type": "object", "properties": { "motivo": { "type": "string" } } }, "AplicarDiuturnidadeRequest": { "required": [ "funcionarioId", "regraId", "desde" ], "type": "object", "properties": { "funcionarioId": { "type": "string", "format": "uuid" }, "regraId": { "type": "string", "format": "uuid" }, "desde": { "type": "string", "format": "date" } } }, "AplicarPedido": { "required": [ "quantidade" ], "type": "object", "properties": { "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "AprovarAusenciaRequest": { "required": [ "efeito" ], "type": "object", "properties": { "efeito": { "$ref": "#/components/schemas/EfeitoSalarialAusencia" } } }, "AprovarFolhaRequest": { "required": [ "lojaId" ], "type": "object", "properties": { "lojaId": { "type": [ "null", "string" ], "format": "uuid" } } }, "AprovarPedido": { "required": [ "itemId", "codigo", "localizacao" ], "type": "object", "properties": { "itemId": { "type": [ "null", "string" ], "format": "uuid" }, "codigo": { "type": [ "null", "string" ] }, "localizacao": { "type": [ "null", "string" ] } } }, "ArmazemDto": { "required": [ "id", "descricao", "localizacao", "predefinido", "lojaId", "lojaNome" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "descricao": { "type": "string" }, "localizacao": { "type": "string" }, "predefinido": { "type": "boolean" }, "lojaId": { "type": "string", "format": "uuid" }, "lojaNome": { "type": "string" } } }, "ArquivarDenunciaRequest": { "required": [ "motivo", "comunicacaoAoDenunciante" ], "type": "object", "properties": { "motivo": { "type": "string" }, "comunicacaoAoDenunciante": { "type": [ "null", "string" ] } } }, "ArquivarDisciplinarRequest": { "required": [ "motivo", "data", "descricao" ], "type": "object", "properties": { "motivo": { "$ref": "#/components/schemas/MotivoArquivamento" }, "data": { "type": "string", "format": "date" }, "descricao": { "type": "string" } } }, "AssinaturaPedido": { "required": [ "data", "signatarios" ], "type": "object", "properties": { "data": { "type": "string", "format": "date" }, "signatarios": { "type": [ "null", "string" ] } } }, "AtribuicaoDeQuarto": { "required": [ "estadiaId", "quartoId" ], "type": "object", "properties": { "estadiaId": { "type": "string", "format": "uuid" }, "quartoId": { "type": "string", "format": "uuid" } } }, "AtribuicaoPedido": { "required": [ "mecanicoId", "boxId" ], "type": "object", "properties": { "mecanicoId": { "type": [ "null", "string" ], "format": "uuid" }, "boxId": { "type": [ "null", "string" ], "format": "uuid" } } }, "AtributosInput": { "required": [ "familia", "patchTest", "patchTestValidadeDias", "patchTestAntecedenciaHoras", "contraIndicacoes", "quimicaIncompativelDias", "exigeRegistoTecnico", "tipoDeRegisto", "exigeFotos", "exigeKit", "consultaPrevia", "cicloDias", "cuidadosEmCasa", "modeloOrigem", "doses" ], "type": "object", "properties": { "familia": { "type": "string" }, "patchTest": { "type": [ "null", "string" ] }, "patchTestValidadeDias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "patchTestAntecedenciaHoras": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "contraIndicacoes": { "type": [ "null", "array" ], "items": { "type": "string" } }, "quimicaIncompativelDias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "exigeRegistoTecnico": { "type": "boolean" }, "tipoDeRegisto": { "type": [ "null", "string" ] }, "exigeFotos": { "type": "boolean" }, "exigeKit": { "type": "boolean" }, "consultaPrevia": { "type": "boolean" }, "cicloDias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "cuidadosEmCasa": { "type": [ "null", "string" ] }, "modeloOrigem": { "type": [ "null", "string" ] }, "doses": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DoseInputDto" } } } }, "AtualizarConfiguracaoGeralCommand": { "required": [ "viasPorOmissao" ], "type": "object", "properties": { "viasPorOmissao": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "comercioAGrosso": { "type": "boolean", "default": false } } }, "AtualizarPoliticaVendasCommand": { "required": [ "permitirPrecoVendaLivre", "descontoMaximoVendaPercentual" ], "type": "object", "properties": { "permitirPrecoVendaLivre": { "type": "boolean" }, "descontoMaximoVendaPercentual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "limiteDescontoOperadorPercentual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "fechoComDiferencaExigeSupervisor": { "type": "boolean", "default": false }, "notaCreditoNoPdvExigeSupervisor": { "type": "boolean", "default": true } } }, "AvancarPedido": { "required": [ "itemId", "codigo", "porLeitura", "nota" ], "type": "object", "properties": { "itemId": { "type": [ "null", "string" ], "format": "uuid" }, "codigo": { "type": [ "null", "string" ] }, "porLeitura": { "type": "boolean" }, "nota": { "type": [ "null", "string" ] } } }, "CalculoRubrica": { "enum": [ "ValorFixo", "PorUnidade" ] }, "CamareiraPedido": { "required": [ "camareiraUserId" ], "type": "object", "properties": { "camareiraUserId": { "type": [ "null", "string" ], "format": "uuid" } } }, "CanalDaMensagem": { "enum": [ "Email", "WhatsAppLigacao", null ] }, "CanalDaOrdem": { "enum": [ "Balcao", "Telefone", "Recolha", "App", "Cacifo", "Contrato" ] }, "CanalDeNotificacao": { "enum": [ "Email", "WhatsAppLigacao", null ] }, "CancelamentoPedido": { "required": [ "motivo", "peloCliente" ], "type": "object", "properties": { "motivo": { "type": "string" }, "peloCliente": { "type": "boolean" } } }, "CancelarItemRequest": { "required": [ "motivo" ], "type": "object", "properties": { "motivo": { "$ref": "#/components/schemas/MotivoDeCancelamento" }, "observacao": { "type": [ "null", "string" ] }, "autorizacaoSupervisorId": { "type": [ "null", "string" ], "format": "uuid" } } }, "CancelarNotaEncomendaRequest": { "required": [ "motivo" ], "type": "object", "properties": { "motivo": { "type": "string" } } }, "CancelarReservaDeMesaRequest": { "required": [ "motivo" ], "type": "object", "properties": { "motivo": { "type": "string" } } }, "CancelarReservaStockRequest": { "required": [ "motivo" ], "type": "object", "properties": { "motivo": { "type": [ "null", "string" ] } } }, "CargoRequest": { "required": [ "codigo", "titulo", "nivel", "departamentoId", "descricao" ], "type": "object", "properties": { "codigo": { "type": "string" }, "titulo": { "type": "string" }, "nivel": { "$ref": "#/components/schemas/NivelQualificacao" }, "departamentoId": { "type": [ "null", "string" ], "format": "uuid" }, "descricao": { "type": [ "null", "string" ] } } }, "CarregarCatalogoDePartidaCommand": { "required": [ "perfis" ], "type": "object", "properties": { "perfis": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "CarregarFeriadosNacionaisRequest": { "required": [ "ano", "pontes" ], "type": "object", "properties": { "ano": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "pontes": { "type": "boolean" } } }, "CatalogoItemDto": { "required": [ "id", "nome", "activo" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "nome": { "type": "string" }, "activo": { "type": "boolean" } } }, "CatalogosDto": { "required": [ "versao", "tiposDocumento", "metodosPagamento", "impostos", "taxasRetencao", "motivosIsencaoIva", "provincias", "municipios", "regimesFiscais" ], "type": "object", "properties": { "versao": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "tiposDocumento": { "type": "array", "items": { "$ref": "#/components/schemas/TipoDocumentoDto" } }, "metodosPagamento": { "type": "array", "items": { "$ref": "#/components/schemas/MetodoPagamentoDto" } }, "impostos": { "type": "array", "items": { "$ref": "#/components/schemas/ImpostoDto" } }, "taxasRetencao": { "type": "array", "items": { "$ref": "#/components/schemas/TaxaRetencaoDto" } }, "motivosIsencaoIva": { "type": "array", "items": { "$ref": "#/components/schemas/MotivoIsencaoIvaDto" } }, "provincias": { "type": "array", "items": { "$ref": "#/components/schemas/ProvinciaDto" } }, "municipios": { "type": "array", "items": { "$ref": "#/components/schemas/MunicipioDto" } }, "regimesFiscais": { "type": "array", "items": { "$ref": "#/components/schemas/RegimeFiscalDto" } } } }, "CategoriaAcessoSensivel": { "enum": [ "Salarios", "Saude", "Disciplinar", "Contencioso", "Avaliacoes", "Denuncias", null ] }, "CategoriaAcordoRequest": { "required": [ "categoria", "salarioMinimo", "vigenteDesde", "clausula" ], "type": "object", "properties": { "categoria": { "type": "string" }, "salarioMinimo": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "vigenteDesde": { "type": "string", "format": "date" }, "clausula": { "type": "string" } } }, "CategoriaActivo": { "enum": [ "Epi", "Informatico", "Viatura", "Telecomunicacoes", "Ferramenta", "Outro", null ] }, "CategoriaDenuncia": { "enum": [ "AssedioMoral", "AssedioSexual", "Discriminacao", "FraudeOuCorrupcao", "SegurancaESaude", "Outra", null ] }, "CategoriaFinanceiraDto": { "required": [ "id", "tipo", "nome", "activa", "deSistema", "actividade" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "tipo": { "type": "string" }, "nome": { "type": "string" }, "activa": { "type": "boolean" }, "deSistema": { "type": "boolean" }, "actividade": { "type": "string" }, "naturezaCompraPorOmissao": { "type": [ "null", "string" ] } } }, "CategoriaMapaRemuneracoes": { "enum": [ "SubsidioAlimentacao", "SubsidioTransporte", "AbonoFamilia", "ReembolsoDespesas", "OutrosNaoSujeitos", "AbonoFalhas", "SubsidioRendaCasa", "CompensacaoRescisao", "SubsidioFerias", "HorasExtras", "SubsidioAtavio", "SubsidioRepresentacao", "Premios", "SubsidioNatal", "OutrosSujeitos", null ] }, "CausaRequest": { "required": [ "causa" ], "type": "object", "properties": { "causa": { "type": [ "null", "string" ] } } }, "CentroCustoDto": { "required": [ "id", "nome", "activo" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "nome": { "type": "string" }, "activo": { "type": "boolean" } } }, "CessarRequest": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": "string", "format": "date" } } }, "ChamadaPedido": { "required": [ "profissionalId" ], "type": "object", "properties": { "profissionalId": { "type": [ "null", "string" ], "format": "uuid" } } }, "CheckInPedido": { "required": [ "atribuicoes", "limiteDeCredito" ], "type": "object", "properties": { "atribuicoes": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/AtribuicaoDeQuarto" } }, "limiteDeCredito": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "CheckOutPedido": { "required": [ "saidaSemFacturar" ], "type": "object", "properties": { "saidaSemFacturar": { "type": "boolean" } } }, "ClassificacaoAbcDto": { "required": [ "produtoId", "produto", "quantidade", "vendas", "percentagemIndividual", "percentagemAcumulada", "classe" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "produto": { "type": "string" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "vendas": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "percentagemIndividual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "percentagemAcumulada": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "classe": { "type": "string" } } }, "ClienteDetalheDto": { "required": [ "id", "nome", "endereco", "numeroContribuinte", "isConsumidorFinal", "telefone", "telemovel", "fax", "email", "website", "especial", "pvpPreferido", "condicaoPagamentoId", "desconto", "limiteCredito", "observacao", "taxaRetencaoId", "municipioId", "enviarAlertas", "enviarDocumentos", "saldoAtual" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "nome": { "type": "string" }, "endereco": { "type": "string" }, "numeroContribuinte": { "type": [ "null", "string" ] }, "isConsumidorFinal": { "type": "boolean" }, "telefone": { "type": [ "null", "string" ] }, "telemovel": { "type": [ "null", "string" ] }, "fax": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "website": { "type": [ "null", "string" ] }, "especial": { "type": "boolean" }, "pvpPreferido": { "type": [ "null", "string" ] }, "condicaoPagamentoId": { "type": [ "null", "string" ], "format": "uuid" }, "desconto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "limiteCredito": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "observacao": { "type": [ "null", "string" ] }, "taxaRetencaoId": { "type": [ "null", "string" ], "format": "uuid" }, "municipioId": { "type": [ "null", "string" ], "format": "uuid" }, "enviarAlertas": { "type": "boolean" }, "enviarDocumentos": { "type": "boolean" }, "saldoAtual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "isProtegido": { "type": "boolean", "default": false }, "pessoaSingular": { "type": "boolean", "default": false } } }, "ClienteImpressaoDto": { "required": [ "id", "nome", "numeroContribuinte", "endereco", "telefone", "email", "isConsumidorFinal" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "nome": { "type": "string" }, "numeroContribuinte": { "type": [ "null", "string" ] }, "endereco": { "type": "string" }, "telefone": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "isConsumidorFinal": { "type": "boolean" } } }, "ClienteRankingDto": { "required": [ "posicao", "clienteId", "cliente", "totalVendas" ], "type": "object", "properties": { "posicao": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "clienteId": { "type": "string", "format": "uuid" }, "cliente": { "type": "string" }, "totalVendas": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "ClienteResumoComprasDto": { "required": [ "totalComprado", "documentos", "emDivida" ], "type": "object", "properties": { "totalComprado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "documentos": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "emDivida": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "ClienteResumoDto": { "required": [ "id", "nome", "numeroContribuinte", "telefone", "especial", "saldoAtual", "isProtegido", "alteradoEmUtc" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "nome": { "type": "string" }, "numeroContribuinte": { "type": [ "null", "string" ] }, "telefone": { "type": [ "null", "string" ] }, "especial": { "type": "boolean" }, "saldoAtual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "isProtegido": { "type": "boolean" }, "alteradoEmUtc": { "type": "string", "format": "date-time" }, "eliminado": { "type": "boolean", "default": false } } }, "CobrarRequest": { "required": [ "tipoDocumento", "pagamentos" ], "type": "object", "properties": { "tipoDocumento": { "type": "string" }, "pagamentos": { "type": "array", "items": { "$ref": "#/components/schemas/PagamentoDocumentoInput" } }, "linhas": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/LinhaACobrar" } }, "clienteId": { "type": [ "null", "string" ], "format": "uuid" }, "observacao": { "type": [ "null", "string" ] }, "armazemId": { "type": [ "null", "string" ], "format": "uuid" }, "dataVencimento": { "type": [ "null", "string" ], "format": "date" }, "descontoFinanceiroPercentual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "autorizacaoSupervisorId": { "type": [ "null", "string" ], "format": "uuid" }, "aplicarPromocoes": { "type": "boolean", "default": false }, "promocoesPermitidas": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } }, "CodigoParametroLegal": { "enum": [ "TaxaInssTrabalhador", "TaxaInssEntidadeEmpregadora", "LimiteIsencaoSubsidioAlimentacao", "LimiteIsencaoSubsidioTransporte", "SalarioMinimo", "HorasSemanaisNormais", "AcrescimoTrabalhoSuplementar", "LimiteHorasFaixaTrabalhoSuplementar", "AcrescimoTrabalhoNocturno", "LimiteTrabalhoSuplementarDiario", "LimiteTrabalhoSuplementarAnual", "DiasFeriasAnuais", "PercentagemSubsidioFerias", "PercentagemSubsidioNatal", "DivisorDescontoFalta", "TectoPenhoraSalario", "IndemnizacaoPorAno", "PrazoCaducidadeDisciplinar", "PrazoRespostaNotaDeCulpa", "DiaLimiteEntregaInss", "DiaLimiteEntregaIrt" ] }, "CodigoPontoRequest": { "required": [ "codigo" ], "type": "object", "properties": { "codigo": { "type": [ "null", "string" ] } } }, "ColocarEmQuarentenaRequest": { "required": [ "armazemOrigemId" ], "type": "object", "properties": { "armazemOrigemId": { "type": "string", "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "motivo": { "type": [ "null", "string" ] } } }, "ColunaMapaDto": { "required": [ "chave", "rotulo", "tipo" ], "type": "object", "properties": { "chave": { "type": "string" }, "rotulo": { "type": "string" }, "tipo": { "type": "string" } } }, "ComentarioPedido": { "required": [ "comentario" ], "type": "object", "properties": { "comentario": { "type": "string" } } }, "CompensarCreditoRequest": { "required": [ "contaAPagarId", "valor" ], "type": "object", "properties": { "contaAPagarId": { "type": "string", "format": "uuid" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "ComponenteInput": { "required": [ "produto", "produtoId", "quantidade", "unidade" ], "type": "object", "properties": { "produto": { "type": "string" }, "produtoId": { "type": [ "null", "string" ], "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "unidade": { "type": "string" } } }, "ConciliacaoDto": { "required": [ "id", "sequencia", "dataExtracto", "saldoExtracto", "saldoAnterior", "totalMovimentos", "numeroMovimentos", "observacao", "realizadaPorNome", "realizadaEmUtc", "anulada", "motivoAnulacao", "anuladaPorNome", "anuladaEmUtc" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sequencia": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "dataExtracto": { "type": "string", "format": "date" }, "saldoExtracto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "saldoAnterior": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalMovimentos": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "numeroMovimentos": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "observacao": { "type": [ "null", "string" ] }, "realizadaPorNome": { "type": [ "null", "string" ] }, "realizadaEmUtc": { "type": "string", "format": "date-time" }, "anulada": { "type": "boolean" }, "motivoAnulacao": { "type": [ "null", "string" ] }, "anuladaPorNome": { "type": [ "null", "string" ] }, "anuladaEmUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "ConciliarRequest": { "required": [ "dataExtracto", "saldoExtracto", "movimentoIds" ], "type": "object", "properties": { "dataExtracto": { "type": "string", "format": "date" }, "saldoExtracto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "movimentoIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "observacao": { "type": [ "null", "string" ] } } }, "ConcluirDenunciaRequest": { "required": [ "resultado", "fundamentacao", "comunicacaoAoDenunciante" ], "type": "object", "properties": { "resultado": { "$ref": "#/components/schemas/ResultadoDenuncia" }, "fundamentacao": { "type": "string" }, "comunicacaoAoDenunciante": { "type": [ "null", "string" ] } } }, "ConcluirOrdemRequest": { "required": [ "quantidadeProduzida" ], "type": "object", "properties": { "quantidadeProduzida": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "lote": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LoteDoAcabadoInput" } ] }, "outrasSaidas": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SaidaConcluidaInput" } } } }, "CondicaoDePagamentoDto": { "required": [ "id", "nome", "dias", "activa", "porOmissao" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "nome": { "type": "string" }, "dias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "activa": { "type": "boolean" }, "porOmissao": { "type": "boolean" } } }, "CondicaoPagamentoEntrada": { "enum": [ "ProntoPagamento", "Dias30", "Dias60", "Dias90", "Dias120" ] }, "CondicaoPedido": { "required": [ "condicao", "fonte", "nota" ], "type": "object", "properties": { "condicao": { "type": "string" }, "fonte": { "type": [ "null", "string" ] }, "nota": { "type": [ "null", "string" ] } } }, "ConfigDoProdutoRequest": { "type": "object", "properties": { "postoId": { "type": [ "null", "string" ], "format": "uuid" }, "nomeCurto": { "type": [ "null", "string" ] }, "tempoAlvoMinutos": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "ConfiguracaoFiscalComprasDto": { "required": [ "perguntas", "porConfirmar" ], "type": "object", "properties": { "perguntas": { "type": "array", "items": { "$ref": "#/components/schemas/PerguntaFiscalDto" } }, "porConfirmar": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "ConfiguracaoGeralDto": { "required": [ "viasPorOmissao" ], "type": "object", "properties": { "viasPorOmissao": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "comercioAGrosso": { "type": "boolean", "default": false } } }, "ConfirmarPedido": { "required": [ "garantia", "aprovarSemGarantia" ], "type": "object", "properties": { "garantia": { "type": "string" }, "aprovarSemGarantia": { "type": "boolean" } } }, "ConsentimentoPedido": { "required": [ "finalidade", "versaoDoTexto" ], "type": "object", "properties": { "finalidade": { "type": "string" }, "versaoDoTexto": { "type": [ "null", "string" ] } } }, "ConsultaDeMesaRequest": { "type": "object", "properties": { "clienteId": { "type": [ "null", "string" ], "format": "uuid" } } }, "ContaAPagarDetalheDto": { "required": [ "conta", "pagamentos", "notasCredito" ], "type": "object", "properties": { "conta": { "$ref": "#/components/schemas/ContaAPagarDto" }, "pagamentos": { "type": "array", "items": { "$ref": "#/components/schemas/PagamentoContaAPagarDto" } }, "notasCredito": { "type": "array", "items": { "$ref": "#/components/schemas/NotaCreditoFornecedorDto" } } } }, "ContaAPagarDto": { "required": [ "id", "numero", "origem", "entradaEstoqueId", "documentoFornecedor", "fornecedorId", "fornecedorNome", "numeroContribuinte", "lojaId", "descricao", "dataDocumento", "vencimento", "valor", "valorPago", "valorCreditado", "valorEmAberto", "diasEmAtraso", "escalao", "situacao", "ultimoPagamentoEmUtc", "categoriaFinanceiraId", "categoriaNome", "centroCustoId", "centroCustoNome", "tipoDocumentoFornecedor", "baseTributavel", "ivaSuportado", "percentagemIvaDedutivel", "naturezaCompra" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "numero": { "type": "string" }, "origem": { "type": "string" }, "entradaEstoqueId": { "type": [ "null", "string" ], "format": "uuid" }, "documentoFornecedor": { "type": [ "null", "string" ] }, "fornecedorId": { "type": [ "null", "string" ], "format": "uuid" }, "fornecedorNome": { "type": [ "null", "string" ] }, "numeroContribuinte": { "type": [ "null", "string" ] }, "lojaId": { "type": "string", "format": "uuid" }, "descricao": { "type": "string" }, "dataDocumento": { "type": "string", "format": "date-time" }, "vencimento": { "type": "string", "format": "date-time" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorPago": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorCreditado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorEmAberto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "diasEmAtraso": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "escalao": { "type": "string" }, "situacao": { "type": "string" }, "ultimoPagamentoEmUtc": { "type": [ "null", "string" ], "format": "date-time" }, "categoriaFinanceiraId": { "type": [ "null", "string" ], "format": "uuid" }, "categoriaNome": { "type": [ "null", "string" ] }, "centroCustoId": { "type": [ "null", "string" ], "format": "uuid" }, "centroCustoNome": { "type": [ "null", "string" ] }, "tipoDocumentoFornecedor": { "type": [ "null", "string" ] }, "baseTributavel": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "ivaSuportado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "percentagemIvaDedutivel": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "naturezaCompra": { "type": [ "null", "string" ] } } }, "ContaAReceberDto": { "required": [ "id", "numero", "sigla", "clienteId", "clienteNome", "numeroContribuinte", "lojaId", "data", "vencimento", "total", "recebido", "creditado", "valorEmAberto", "diasEmAtraso", "escalao", "situacao" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "numero": { "type": "string" }, "sigla": { "type": "string" }, "clienteId": { "type": "string", "format": "uuid" }, "clienteNome": { "type": "string" }, "numeroContribuinte": { "type": [ "null", "string" ] }, "lojaId": { "type": "string", "format": "uuid" }, "data": { "type": "string", "format": "date-time" }, "vencimento": { "type": "string", "format": "date" }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "recebido": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "creditado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorEmAberto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "diasEmAtraso": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "escalao": { "type": "string" }, "situacao": { "type": "string" } } }, "ContaBancariaDto": { "required": [ "banco", "numeroConta", "iban" ], "type": "object", "properties": { "banco": { "type": "string" }, "numeroConta": { "type": [ "null", "string" ] }, "iban": { "type": [ "null", "string" ] } } }, "ContaPedido": { "required": [ "produtos", "pagamentos" ], "type": "object", "properties": { "produtos": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ProdutoVendidoInput" } }, "pagamentos": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/PagamentoDaContaInput" } } } }, "CorDaRoupa": { "enum": [ "Branca", "Clara", "Escura" ] }, "CorrerPlanoRequest": { "type": "object", "properties": { "armazemId": { "type": [ "null", "string" ], "format": "uuid" }, "semanas": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 13 } } }, "CreateArmazemCommand": { "required": [ "descricao", "localizacao" ], "type": "object", "properties": { "descricao": { "type": "string" }, "localizacao": { "type": "string" }, "lojaId": { "type": [ "null", "string" ], "format": "uuid" } } }, "CreateClienteCommand": { "required": [ "nome", "endereco", "numeroContribuinte", "isConsumidorFinal", "email", "telefone", "telemovel", "fax", "website", "municipioId", "taxaRetencaoId", "enviarAlertas", "enviarDocumentos", "observacao", "especial", "pvpPreferido", "condicaoPagamentoId", "desconto", "limiteCredito" ], "type": "object", "properties": { "nome": { "type": "string" }, "endereco": { "type": "string" }, "numeroContribuinte": { "type": [ "null", "string" ] }, "isConsumidorFinal": { "type": "boolean" }, "email": { "type": [ "null", "string" ] }, "telefone": { "type": [ "null", "string" ] }, "telemovel": { "type": [ "null", "string" ] }, "fax": { "type": [ "null", "string" ] }, "website": { "type": [ "null", "string" ] }, "municipioId": { "type": [ "null", "string" ], "format": "uuid" }, "taxaRetencaoId": { "type": [ "null", "string" ], "format": "uuid" }, "enviarAlertas": { "type": "boolean" }, "enviarDocumentos": { "type": "boolean" }, "observacao": { "type": [ "null", "string" ] }, "especial": { "type": "boolean" }, "pvpPreferido": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NivelPreco" } ] }, "condicaoPagamentoId": { "type": [ "null", "string" ], "format": "uuid" }, "desconto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "limiteCredito": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "pessoaSingular": { "type": "boolean", "default": false } } }, "CreateDocumentoCommand": { "required": [ "tipoDocumentoId", "clienteId", "armazemId", "referenciaExternaId", "observacao", "itens", "pagamentos" ], "type": "object", "properties": { "tipoDocumentoId": { "type": "string", "format": "uuid" }, "clienteId": { "type": [ "null", "string" ], "format": "uuid" }, "armazemId": { "type": [ "null", "string" ], "format": "uuid" }, "referenciaExternaId": { "type": [ "null", "string" ], "format": "uuid" }, "observacao": { "type": [ "null", "string" ] }, "itens": { "type": "array", "items": { "$ref": "#/components/schemas/ItemDocumentoInput" } }, "pagamentos": { "type": "array", "items": { "$ref": "#/components/schemas/PagamentoDocumentoInput" } }, "transporte": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DadosTransporte" } ] }, "lojaId": { "type": [ "null", "string" ], "format": "uuid" }, "vendedorOriginadorId": { "type": [ "null", "string" ], "format": "uuid" }, "vendedorFaturadorId": { "type": [ "null", "string" ], "format": "uuid" }, "descontoFinanceiroPercentual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "outrosEncargos": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "referenciaCliente": { "type": [ "null", "string" ] }, "dataVencimento": { "type": [ "null", "string" ], "format": "date" }, "cumpreReservaLinhaIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "autorizacaoSupervisorId": { "type": [ "null", "string" ], "format": "uuid" }, "aplicarPromocoes": { "type": "boolean", "default": false }, "promocoesPermitidas": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "nomeClienteAvulso": { "type": [ "null", "string" ] } } }, "CreateEntradaEstoqueCommand": { "required": [ "factura", "tipoDocumento", "dataFactura", "fornecedorId", "armazemId", "condicaoPagamento", "observacao", "itens" ], "type": "object", "properties": { "factura": { "type": "string" }, "tipoDocumento": { "$ref": "#/components/schemas/TipoDocumentoEntradaEstoque" }, "dataFactura": { "type": "string", "format": "date-time" }, "fornecedorId": { "type": "string", "format": "uuid" }, "armazemId": { "type": "string", "format": "uuid" }, "condicaoPagamento": { "$ref": "#/components/schemas/CondicaoPagamentoEntrada" }, "observacao": { "type": [ "null", "string" ] }, "itens": { "type": "array", "items": { "$ref": "#/components/schemas/ItemEntradaEstoqueInput" } }, "valorPago": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "metodoPagamentoId": { "type": [ "null", "string" ], "format": "uuid" }, "atualizarPrecoCusto": { "type": "boolean", "default": false }, "atualizarPrecoVenda": { "type": "boolean", "default": false }, "custosAdicionais": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "percentagemIvaDedutivel": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "moedaCodigo": { "type": [ "null", "string" ] }, "cambio": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "CreateFornecedorCommand": { "required": [ "nome", "numeroContribuinte", "telefone", "municipioId", "email", "endereco", "contacto", "website", "fax", "codigoPostal", "observacao" ], "type": "object", "properties": { "nome": { "type": "string" }, "numeroContribuinte": { "type": "string" }, "telefone": { "type": "string" }, "municipioId": { "type": [ "null", "string" ], "format": "uuid" }, "email": { "type": [ "null", "string" ] }, "endereco": { "type": [ "null", "string" ] }, "contacto": { "type": [ "null", "string" ] }, "website": { "type": [ "null", "string" ] }, "fax": { "type": [ "null", "string" ] }, "codigoPostal": { "type": [ "null", "string" ] }, "observacao": { "type": [ "null", "string" ] }, "nifEmAngola": { "type": "boolean", "default": true }, "pais": { "type": [ "null", "string" ] }, "cidade": { "type": [ "null", "string" ] } } }, "CreateLojaCommand": { "required": [ "nome", "codigo", "endereco" ], "type": "object", "properties": { "nome": { "type": "string" }, "codigo": { "type": "string" }, "endereco": { "type": [ "null", "string" ] } } }, "CreateLoteCommand": { "required": [ "descricao" ], "type": "object", "properties": { "descricao": { "type": "string" }, "validade": { "type": [ "null", "string" ], "format": "date-time" } } }, "CreateNotaCreditoCommand": { "required": [ "documentoOriginalId", "motivo", "metodoReembolsoId", "numeroOperacaoBancaria", "dataOperacaoBancaria", "itens" ], "type": "object", "properties": { "documentoOriginalId": { "type": "string", "format": "uuid" }, "motivo": { "type": "string" }, "metodoReembolsoId": { "type": [ "null", "string" ], "format": "uuid" }, "numeroOperacaoBancaria": { "type": [ "null", "string" ] }, "dataOperacaoBancaria": { "type": [ "null", "string" ], "format": "date-time" }, "itens": { "type": "array", "items": { "$ref": "#/components/schemas/ItemNotaCreditoInput" } }, "autorizacaoSupervisorId": { "type": [ "null", "string" ], "format": "uuid" } } }, "CreateProdutoCommand": { "required": [ "nome", "tipoProduto", "impostoId", "motivoIsencaoIvaId", "informarPrecoNoPdv", "precoCusto", "valorCIF", "despesasTransporte", "despesasArmazenagem", "encargosAduaneiros", "despesasBancarias", "encargosGerais", "margemPvp1", "margemPvp2", "margemPvp3", "margemPvp4", "codigoInterno", "codigoBarra", "descricao", "categoriaId", "unidadeId", "marcaId", "modeloId", "fabricanteId", "tamanhoId", "fornecedorId", "taxaRetencaoId", "estocavel", "estoqueMinimo", "controlarValidade", "paisOrigemId", "origem", "peso", "comprimento", "largura", "altura" ], "type": "object", "properties": { "nome": { "type": "string" }, "tipoProduto": { "$ref": "#/components/schemas/TipoProduto" }, "impostoId": { "type": "string", "format": "uuid" }, "motivoIsencaoIvaId": { "type": [ "null", "string" ], "format": "uuid" }, "informarPrecoNoPdv": { "type": "boolean" }, "precoCusto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "valorCIF": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "despesasTransporte": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "despesasArmazenagem": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "encargosAduaneiros": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "despesasBancarias": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "encargosGerais": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "margemPvp1": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "margemPvp2": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "margemPvp3": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "margemPvp4": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "codigoInterno": { "type": [ "null", "string" ] }, "codigoBarra": { "type": [ "null", "string" ] }, "descricao": { "type": [ "null", "string" ] }, "categoriaId": { "type": [ "null", "string" ], "format": "uuid" }, "unidadeId": { "type": [ "null", "string" ], "format": "uuid" }, "marcaId": { "type": [ "null", "string" ], "format": "uuid" }, "modeloId": { "type": [ "null", "string" ], "format": "uuid" }, "fabricanteId": { "type": [ "null", "string" ], "format": "uuid" }, "tamanhoId": { "type": [ "null", "string" ], "format": "uuid" }, "fornecedorId": { "type": [ "null", "string" ], "format": "uuid" }, "taxaRetencaoId": { "type": [ "null", "string" ], "format": "uuid" }, "estocavel": { "type": "boolean" }, "estoqueMinimo": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "controlarValidade": { "type": "boolean" }, "paisOrigemId": { "type": [ "null", "string" ], "format": "uuid" }, "origem": { "type": [ "null", "string" ] }, "peso": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "comprimento": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "largura": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "altura": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "precificacaoAvancada": { "type": "boolean", "default": false }, "tipoInventarioFiscal": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/TipoInventarioFiscal" } ] }, "paraVenda": { "type": "boolean", "default": true }, "controlarLote": { "type": "boolean", "default": false } } }, "CreateReciboCommand": { "required": [ "clienteId", "metodoPagamentoId", "numeroOperacaoBancaria", "dataOperacaoBancaria", "observacao", "liquidacoes" ], "type": "object", "properties": { "clienteId": { "type": "string", "format": "uuid" }, "metodoPagamentoId": { "type": "string", "format": "uuid" }, "numeroOperacaoBancaria": { "type": [ "null", "string" ] }, "dataOperacaoBancaria": { "type": [ "null", "string" ], "format": "date-time" }, "observacao": { "type": [ "null", "string" ] }, "liquidacoes": { "type": "array", "items": { "$ref": "#/components/schemas/LiquidacaoInput" } }, "lojaId": { "type": [ "null", "string" ], "format": "uuid" } } }, "CreateTransferenciaEstoqueCommand": { "required": [ "armazemOrigemId", "armazemDestinoId", "autorizadoPor", "observacao", "itens" ], "type": "object", "properties": { "armazemOrigemId": { "type": "string", "format": "uuid" }, "armazemDestinoId": { "type": "string", "format": "uuid" }, "autorizadoPor": { "type": [ "null", "string" ] }, "observacao": { "type": [ "null", "string" ] }, "itens": { "type": "array", "items": { "$ref": "#/components/schemas/ItemTransferenciaEstoqueInput" } } } }, "CreditoFornecedorDetalheDto": { "required": [ "credito", "utilizacoes" ], "type": "object", "properties": { "credito": { "$ref": "#/components/schemas/CreditoFornecedorDto" }, "utilizacoes": { "type": "array", "items": { "$ref": "#/components/schemas/UtilizacaoCreditoDto" } } } }, "CreditoFornecedorDto": { "required": [ "id", "fornecedorId", "fornecedorNome", "lojaId", "notaCreditoId", "notaCreditoNumero", "notaCreditoData", "contaAPagarId", "contaAPagarNumero", "valor", "valorUtilizado", "valorDisponivel", "criadoEmUtc" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "fornecedorId": { "type": "string", "format": "uuid" }, "fornecedorNome": { "type": "string" }, "lojaId": { "type": "string", "format": "uuid" }, "notaCreditoId": { "type": "string", "format": "uuid" }, "notaCreditoNumero": { "type": "string" }, "notaCreditoData": { "type": "string", "format": "date-time" }, "contaAPagarId": { "type": "string", "format": "uuid" }, "contaAPagarNumero": { "type": "string" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorUtilizado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorDisponivel": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "criadoEmUtc": { "type": "string", "format": "date-time" } } }, "CriarAcordoCommand": { "required": [ "nome", "ambito", "fonte", "vigenteDesde", "vigenteAte" ], "type": "object", "properties": { "nome": { "type": "string" }, "ambito": { "type": [ "null", "string" ] }, "fonte": { "type": "string" }, "vigenteDesde": { "type": "string", "format": "date" }, "vigenteAte": { "type": [ "null", "string" ], "format": "date" } } }, "CriarArmazemRequest": { "type": "object", "properties": { "lojaId": { "type": [ "null", "string" ], "format": "uuid" } } }, "CriarAvaliacaoCommand": { "required": [ "funcionarioId", "avaliadorId", "ano" ], "type": "object", "properties": { "funcionarioId": { "type": "string", "format": "uuid" }, "avaliadorId": { "type": "string", "format": "uuid" }, "ano": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "escalaMaxima": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 5 } } }, "CriarAvencaCommand": { "required": [ "clienteId", "frequencia", "diaEmissao", "prazoPagamentoDias", "dataInicio", "dataFim", "enviarEmail", "observacao", "linhas" ], "type": "object", "properties": { "clienteId": { "type": "string", "format": "uuid" }, "frequencia": { "$ref": "#/components/schemas/FrequenciaAvenca" }, "diaEmissao": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "prazoPagamentoDias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "dataInicio": { "type": "string", "format": "date" }, "dataFim": { "type": [ "null", "string" ], "format": "date" }, "enviarEmail": { "type": "boolean" }, "observacao": { "type": [ "null", "string" ] }, "linhas": { "type": "array", "items": { "$ref": "#/components/schemas/LinhaAvencaInput" } }, "lojaId": { "type": [ "null", "string" ], "format": "uuid" } } }, "CriarBloqueioCommand": { "required": [ "propriedadeId", "quartoId", "tipo", "de", "ate", "motivo", "ticketId" ], "type": "object", "properties": { "propriedadeId": { "type": [ "null", "string" ], "format": "uuid" }, "quartoId": { "type": "string", "format": "uuid" }, "tipo": { "type": "string" }, "de": { "type": "string", "format": "date" }, "ate": { "type": "string", "format": "date" }, "motivo": { "type": "string" }, "ticketId": { "type": [ "null", "string" ], "format": "uuid" } } }, "CriarCargoCommand": { "required": [ "codigo", "titulo", "nivel", "departamentoId", "descricao" ], "type": "object", "properties": { "codigo": { "type": "string" }, "titulo": { "type": "string" }, "nivel": { "$ref": "#/components/schemas/NivelQualificacao" }, "departamentoId": { "type": [ "null", "string" ], "format": "uuid" }, "descricao": { "type": [ "null", "string" ] } } }, "CriarCatalogoItemRequest": { "required": [ "nome" ], "type": "object", "properties": { "nome": { "type": "string" } } }, "CriarCategoriaFinanceiraCommand": { "required": [ "tipo", "nome" ], "type": "object", "properties": { "tipo": { "$ref": "#/components/schemas/TipoCategoriaFinanceira" }, "nome": { "type": "string" }, "actividade": { "$ref": "#/components/schemas/ActividadeFluxoCaixa" } } }, "CriarCentroCustoCommand": { "required": [ "nome" ], "type": "object", "properties": { "nome": { "type": "string" } } }, "CriarCentroDeTrabalhoCommand": { "required": [ "codigo", "nome" ], "type": "object", "properties": { "codigo": { "type": "string" }, "nome": { "type": "string" }, "custoPorHora": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "horasPorDia": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 8 }, "postos": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 1 }, "eficienciaPercentual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 100 } } }, "CriarCondicaoDePagamentoCommand": { "required": [ "nome", "dias" ], "type": "object", "properties": { "nome": { "type": "string" }, "dias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "CriarContaBancariaCommand": { "required": [ "nome", "banco", "numeroConta", "iban" ], "type": "object", "properties": { "nome": { "type": "string" }, "banco": { "type": [ "null", "string" ] }, "numeroConta": { "type": [ "null", "string" ] }, "iban": { "type": [ "null", "string" ] }, "saldoInicial": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "dataSaldoInicial": { "type": [ "null", "string" ], "format": "date-time" } } }, "CriarContratoCommand": { "required": [ "sentido", "tipo", "clienteId", "fornecedorId", "modeloId", "titulo", "objecto", "dataInicio", "responsavelUserId", "lojaId", "termos", "plano" ], "type": "object", "properties": { "sentido": { "$ref": "#/components/schemas/SentidoDoContrato" }, "tipo": { "$ref": "#/components/schemas/TipoDeContrato" }, "clienteId": { "type": [ "null", "string" ], "format": "uuid" }, "fornecedorId": { "type": [ "null", "string" ], "format": "uuid" }, "modeloId": { "type": [ "null", "string" ], "format": "uuid" }, "titulo": { "type": "string" }, "objecto": { "type": [ "null", "string" ] }, "dataInicio": { "type": "string", "format": "date" }, "responsavelUserId": { "type": [ "null", "string" ], "format": "uuid" }, "lojaId": { "type": [ "null", "string" ], "format": "uuid" }, "termos": { "$ref": "#/components/schemas/TermosInput" }, "plano": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PlanoInput" } ] } } }, "CriarDepartamentoCommand": { "required": [ "codigo", "nome", "departamentoSuperiorId" ], "type": "object", "properties": { "codigo": { "type": "string" }, "nome": { "type": "string" }, "departamentoSuperiorId": { "type": [ "null", "string" ], "format": "uuid" } } }, "CriarDespesaCommand": { "required": [ "categoriaFinanceiraId", "descricao", "valor", "dataDocumento", "vencimento" ], "type": "object", "properties": { "categoriaFinanceiraId": { "type": "string", "format": "uuid" }, "descricao": { "type": "string" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "dataDocumento": { "type": "string", "format": "date-time" }, "vencimento": { "type": "string", "format": "date-time" }, "lojaId": { "type": [ "null", "string" ], "format": "uuid" }, "fornecedorId": { "type": [ "null", "string" ], "format": "uuid" }, "centroCustoId": { "type": [ "null", "string" ], "format": "uuid" }, "documentoFornecedor": { "type": [ "null", "string" ] }, "valorPago": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "metodoPagamentoId": { "type": [ "null", "string" ], "format": "uuid" }, "numeroOperacaoBancaria": { "type": [ "null", "string" ] }, "dataOperacaoBancaria": { "type": [ "null", "string" ], "format": "date-time" }, "tipoDocumentoFornecedor": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/TipoDocumentoFornecedor" } ] }, "baseTributavel": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "ivaSuportado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "percentagemIvaDedutivel": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "naturezaCompra": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NaturezaCompraFiscal" } ] }, "dataPagamento": { "type": [ "null", "string" ], "format": "date-time" } } }, "CriarDespesaRecorrenteCommand": { "required": [ "categoriaFinanceiraId", "descricao", "valor", "frequencia", "diaLancamento", "prazoPagamentoDias", "dataInicio" ], "type": "object", "properties": { "categoriaFinanceiraId": { "type": "string", "format": "uuid" }, "descricao": { "type": "string" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "frequencia": { "$ref": "#/components/schemas/FrequenciaAvenca" }, "diaLancamento": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "prazoPagamentoDias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "dataInicio": { "type": "string", "format": "date" }, "dataFim": { "type": [ "null", "string" ], "format": "date" }, "fornecedorId": { "type": [ "null", "string" ], "format": "uuid" }, "centroCustoId": { "type": [ "null", "string" ], "format": "uuid" }, "lojaId": { "type": [ "null", "string" ], "format": "uuid" }, "observacao": { "type": [ "null", "string" ] } } }, "CriarExcepcaoCommand": { "required": [ "alvo", "alvoId", "tipo", "inicio", "fim", "dia", "janelaInicio", "janelaFim", "motivo", "confirmarConflitos" ], "type": "object", "properties": { "alvo": { "$ref": "#/components/schemas/AlvoDoHorario" }, "alvoId": { "type": "string", "format": "uuid" }, "tipo": { "$ref": "#/components/schemas/TipoDeExcepcao" }, "inicio": { "type": [ "null", "string" ], "format": "date-time" }, "fim": { "type": [ "null", "string" ], "format": "date-time" }, "dia": { "type": [ "null", "string" ], "format": "date" }, "janelaInicio": { "type": [ "null", "string" ] }, "janelaFim": { "type": [ "null", "string" ] }, "motivo": { "type": [ "null", "string" ] }, "confirmarConflitos": { "type": "boolean" } } }, "CriarFichaTecnicaCommand": { "required": [ "codigo", "nome", "produtoId", "rendimento", "linhas" ], "type": "object", "properties": { "codigo": { "type": "string" }, "nome": { "type": "string" }, "produtoId": { "type": "string", "format": "uuid" }, "rendimento": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "linhas": { "type": "array", "items": { "$ref": "#/components/schemas/LinhaDaFichaInput" } }, "observacao": { "type": [ "null", "string" ] }, "operacoes": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/OperacaoDaFichaInput" } }, "saidas": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/SaidaDaFichaInput" } }, "criterio": { "type": [ "null", "string" ] }, "valorDeReferenciaDoPrincipal": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "CriarFuncionarioCommand": { "required": [ "dados", "dataAdmissao", "contrato", "contasBancarias", "dependentes" ], "type": "object", "properties": { "dados": { "$ref": "#/components/schemas/DadosFuncionario" }, "dataAdmissao": { "type": "string", "format": "date" }, "contrato": { "$ref": "#/components/schemas/DadosContrato" }, "contasBancarias": { "type": "array", "items": { "$ref": "#/components/schemas/DadosContaBancariaFuncionario" } }, "dependentes": { "type": "array", "items": { "$ref": "#/components/schemas/DadosDependente" } } } }, "CriarGrupoDeOpcoesCommand": { "required": [ "nome", "minimo", "maximo", "ordem", "opcoes" ], "type": "object", "properties": { "nome": { "type": "string" }, "minimo": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "maximo": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "ordem": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "opcoes": { "type": "array", "items": { "$ref": "#/components/schemas/OpcaoInput" } } } }, "CriarInstrumentoCommand": { "required": [ "codigo", "nome" ], "type": "object", "properties": { "codigo": { "type": "string" }, "nome": { "type": "string" }, "validadeDaCalibracao": { "type": [ "null", "string" ], "format": "date" }, "observacao": { "type": [ "null", "string" ] } } }, "CriarMarcacaoCommand": { "required": [ "lojaId", "clienteId", "servicos", "origem", "nota", "overbooking" ], "type": "object", "properties": { "lojaId": { "type": [ "null", "string" ], "format": "uuid" }, "clienteId": { "type": "string", "format": "uuid" }, "servicos": { "type": "array", "items": { "$ref": "#/components/schemas/ServicoPedido" } }, "origem": { "$ref": "#/components/schemas/OrigemDaMarcacao" }, "nota": { "type": [ "null", "string" ] }, "overbooking": { "type": "boolean" } } }, "CriarMesaCommand": { "required": [ "zonaId", "numero", "capacidade", "forma", "x", "y" ], "type": "object", "properties": { "zonaId": { "type": "string", "format": "uuid" }, "numero": { "type": "string" }, "capacidade": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "forma": { "type": "string" }, "x": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "y": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "largura": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 8 }, "altura": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 8 } } }, "CriarNotasDeEncomendaCommand": { "required": [ "itens" ], "type": "object", "properties": { "itens": { "type": "array", "items": { "$ref": "#/components/schemas/ItemNotaEncomendaInput" } }, "lojaId": { "type": [ "null", "string" ], "format": "uuid" }, "observacao": { "type": [ "null", "string" ] } } }, "CriarOperacaoDeModeloCommand": { "required": [ "chave", "produtoServicoId", "nome" ], "type": "object", "properties": { "chave": { "type": "string" }, "produtoServicoId": { "type": [ "null", "string" ], "format": "uuid" }, "nome": { "type": [ "null", "string" ] } } }, "CriarOrdemDeProducaoCommand": { "required": [ "fichaTecnicaId", "quantidadeAlvo" ], "type": "object", "properties": { "fichaTecnicaId": { "type": "string", "format": "uuid" }, "quantidadeAlvo": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "lojaId": { "type": [ "null", "string" ], "format": "uuid" }, "armazemOrigemId": { "type": [ "null", "string" ], "format": "uuid" }, "armazemDestinoId": { "type": [ "null", "string" ], "format": "uuid" }, "inicioPlaneado": { "type": [ "null", "string" ], "format": "date" }, "fimPlaneado": { "type": [ "null", "string" ], "format": "date" }, "origem": { "type": [ "null", "string" ] }, "ordemMaeId": { "type": [ "null", "string" ], "format": "uuid" } } }, "CriarPedidoReservaStockCommand": { "required": [ "clienteId", "prazoMinutos", "expiraEmUtc", "observacao", "itens" ], "type": "object", "properties": { "clienteId": { "type": "string", "format": "uuid" }, "prazoMinutos": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "expiraEmUtc": { "type": [ "null", "string" ], "format": "date-time" }, "observacao": { "type": [ "null", "string" ] }, "itens": { "type": "array", "items": { "$ref": "#/components/schemas/ItemReservaStockInput" } }, "lojaId": { "type": [ "null", "string" ], "format": "uuid" } } }, "CriarPlanoDeInspeccaoCommand": { "required": [ "produtoId", "momento", "observacao", "pontos" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "momento": { "type": "string" }, "observacao": { "type": [ "null", "string" ] }, "pontos": { "type": "array", "items": { "$ref": "#/components/schemas/PontoDeControloInput" } }, "exigeLibertacao": { "type": "boolean", "default": false } } }, "CriarPostoCommand": { "required": [ "nome" ], "type": "object", "properties": { "nome": { "type": "string" }, "ordem": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 }, "usaPassoEmPreparacao": { "type": "boolean", "default": false } } }, "CriarProcuraDeProducaoCommand": { "required": [ "linhas" ], "type": "object", "properties": { "linhas": { "type": "array", "items": { "$ref": "#/components/schemas/LinhaDeProcuraInput" } } } }, "CriarProfissionalCommand": { "required": [ "lojaId", "nome", "userId", "cor", "aceitaOnline", "comissaoServicoPct", "comissaoProdutoPct", "descricao" ], "type": "object", "properties": { "lojaId": { "type": [ "null", "string" ], "format": "uuid" }, "nome": { "type": "string" }, "userId": { "type": [ "null", "string" ], "format": "uuid" }, "cor": { "type": "string" }, "aceitaOnline": { "type": "boolean" }, "comissaoServicoPct": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "comissaoProdutoPct": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "descricao": { "type": [ "null", "string" ] } } }, "CriarRegraDiuturnidadeCommand": { "required": [ "acordoId", "rubricaId", "anosPorDiuturnidade", "modo", "valor", "maximo", "vigenteDesde", "fonte" ], "type": "object", "properties": { "acordoId": { "type": [ "null", "string" ], "format": "uuid" }, "rubricaId": { "type": "string", "format": "uuid" }, "anosPorDiuturnidade": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "modo": { "$ref": "#/components/schemas/ModoValorDiuturnidade" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "maximo": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "vigenteDesde": { "type": "string", "format": "date" }, "fonte": { "type": "string" } } }, "CriarReservaCommand": { "required": [ "propriedadeId", "clienteId", "empresaClienteId", "planoId", "canal", "segmento", "estadias", "modo", "garantia", "depositoValor", "depositoReferencia", "depositoMetodoPagamentoId", "prazoDaGarantiaHoras", "horaPrevistaDeChegada", "notas", "pedidosEspeciais", "vip", "rotas", "aceitarOverbooking", "aprovarSemGarantia" ], "type": "object", "properties": { "propriedadeId": { "type": [ "null", "string" ], "format": "uuid" }, "clienteId": { "type": "string", "format": "uuid" }, "empresaClienteId": { "type": [ "null", "string" ], "format": "uuid" }, "planoId": { "type": "string", "format": "uuid" }, "canal": { "type": "string" }, "segmento": { "type": "string" }, "estadias": { "type": "array", "items": { "$ref": "#/components/schemas/EstadiaPedida" } }, "modo": { "type": "string" }, "garantia": { "type": [ "null", "string" ] }, "depositoValor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "depositoReferencia": { "type": [ "null", "string" ] }, "depositoMetodoPagamentoId": { "type": [ "null", "string" ], "format": "uuid" }, "prazoDaGarantiaHoras": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "horaPrevistaDeChegada": { "type": [ "null", "string" ] }, "notas": { "type": [ "null", "string" ] }, "pedidosEspeciais": { "type": [ "null", "string" ] }, "vip": { "type": "boolean" }, "rotas": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RotasDto" } ] }, "aceitarOverbooking": { "type": "boolean" }, "aprovarSemGarantia": { "type": "boolean" } } }, "CriarServicoDeModeloCommand": { "required": [ "modeloChave", "produtoId", "nome", "preco" ], "type": "object", "properties": { "modeloChave": { "type": "string" }, "produtoId": { "type": "string", "format": "uuid" }, "nome": { "type": [ "null", "string" ] }, "preco": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "CriarTicketCommand": { "required": [ "propriedadeId", "quartoId", "area", "descricao", "prioridade" ], "type": "object", "properties": { "propriedadeId": { "type": [ "null", "string" ], "format": "uuid" }, "quartoId": { "type": [ "null", "string" ], "format": "uuid" }, "area": { "type": "string" }, "descricao": { "type": "string" }, "prioridade": { "type": "string" } } }, "CriarVariacaoRequest": { "required": [ "variacao" ], "type": "object", "properties": { "variacao": { "type": "string" }, "nome": { "type": [ "null", "string" ] }, "codigoInterno": { "type": [ "null", "string" ] }, "codigoBarra": { "type": [ "null", "string" ] } } }, "CriarVariacoesEmSerieRequest": { "required": [ "variacoes" ], "type": "object", "properties": { "variacoes": { "type": "array", "items": { "type": "string" } }, "grupoVariacaoId": { "type": [ "null", "string" ], "format": "uuid" }, "novoGrupo": { "type": [ "null", "string" ] }, "variacaoDaOrigem": { "type": [ "null", "string" ] } } }, "CriarZonaCommand": { "required": [ "nome" ], "type": "object", "properties": { "nome": { "type": "string" }, "ordem": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 }, "lojaId": { "type": [ "null", "string" ], "format": "uuid" } } }, "CustoDaOrdemRequest": { "required": [ "tipo", "descricao" ], "type": "object", "properties": { "tipo": { "type": "string" }, "descricao": { "type": "string" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "horas": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "taxa": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "centroDeTrabalhoId": { "type": [ "null", "string" ], "format": "uuid" } } }, "DadosContaBancariaFuncionario": { "required": [ "banco", "iban", "principal", "percentagemDivisao" ], "type": "object", "properties": { "banco": { "type": "string" }, "iban": { "type": "string" }, "principal": { "type": "boolean" }, "percentagemDivisao": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "DadosContaBancariaRequest": { "required": [ "nome", "banco", "numeroConta", "iban" ], "type": "object", "properties": { "nome": { "type": "string" }, "banco": { "type": [ "null", "string" ] }, "numeroConta": { "type": [ "null", "string" ] }, "iban": { "type": [ "null", "string" ] } } }, "DadosContrato": { "required": [ "tipo", "vigenteDesde", "dataFim", "periodoExperimentalDias", "salarioBase", "horasSemanais", "regime", "formaPagamento", "isentoDeHorario", "cargoId", "departamentoId", "lojaId" ], "type": "object", "properties": { "tipo": { "$ref": "#/components/schemas/TipoContratoTrabalho" }, "vigenteDesde": { "type": "string", "format": "date" }, "dataFim": { "type": [ "null", "string" ], "format": "date" }, "periodoExperimentalDias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "salarioBase": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "horasSemanais": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "regime": { "$ref": "#/components/schemas/RegimeRemuneratorio" }, "formaPagamento": { "$ref": "#/components/schemas/FormaPagamentoSalario" }, "isentoDeHorario": { "type": "boolean" }, "cargoId": { "type": [ "null", "string" ], "format": "uuid" }, "departamentoId": { "type": [ "null", "string" ], "format": "uuid" }, "lojaId": { "type": [ "null", "string" ], "format": "uuid" } } }, "DadosDaViaturaPedido": { "required": [ "categoria", "marca", "modelo", "versao", "ano", "cor", "combustivel", "cilindradaCc", "caixa", "usoDaMoto", "condutorHabitual", "empresaId", "gestorDeFrota", "pneusMedida", "notas" ], "type": "object", "properties": { "categoria": { "type": "string" }, "marca": { "type": "string" }, "modelo": { "type": "string" }, "versao": { "type": [ "null", "string" ] }, "ano": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "cor": { "type": [ "null", "string" ] }, "combustivel": { "type": [ "null", "string" ] }, "cilindradaCc": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "caixa": { "type": [ "null", "string" ] }, "usoDaMoto": { "type": [ "null", "string" ] }, "condutorHabitual": { "type": [ "null", "string" ] }, "empresaId": { "type": [ "null", "string" ], "format": "uuid" }, "gestorDeFrota": { "type": [ "null", "string" ] }, "pneusMedida": { "type": [ "null", "string" ] }, "notas": { "type": [ "null", "string" ] } } }, "DadosDependente": { "required": [ "nome", "parentesco", "dataNascimento", "numeroDocumento", "deficiencia", "estudante", "direitoAbonoFamilia" ], "type": "object", "properties": { "nome": { "type": "string" }, "parentesco": { "$ref": "#/components/schemas/ParentescoDependente" }, "dataNascimento": { "type": "string", "format": "date" }, "numeroDocumento": { "type": [ "null", "string" ] }, "deficiencia": { "type": "boolean" }, "estudante": { "type": "boolean" }, "direitoAbonoFamilia": { "type": "boolean" } } }, "DadosFormacaoProfissional": { "required": [ "titulo", "entidade", "dataConclusao", "validoAte", "cargaHoraria", "numeroCertificado", "observacao" ], "type": "object", "properties": { "titulo": { "type": "string" }, "entidade": { "type": [ "null", "string" ] }, "dataConclusao": { "type": "string", "format": "date" }, "validoAte": { "type": [ "null", "string" ], "format": "date" }, "cargaHoraria": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "numeroCertificado": { "type": [ "null", "string" ] }, "observacao": { "type": [ "null", "string" ] } } }, "DadosFuncionario": { "required": [ "nome", "nomeUsual", "numeroContribuinte", "tipoDocumento", "numeroDocumento", "documentoEmitidoEm", "documentoValidoAte", "documentoEmitidoPor", "numeroInss", "genero", "dataNascimento", "estadoCivil", "nacionalidade", "grupoSanguineo", "telemovel", "telefoneAlternativo", "emailPessoal", "emailTrabalho", "endereco", "municipioId", "numeroAutorizacaoTrabalho", "validadeAutorizacaoTrabalho" ], "type": "object", "properties": { "nome": { "type": "string" }, "nomeUsual": { "type": [ "null", "string" ] }, "numeroContribuinte": { "type": "string" }, "tipoDocumento": { "$ref": "#/components/schemas/TipoDocumentoIdentificacao" }, "numeroDocumento": { "type": "string" }, "documentoEmitidoEm": { "type": [ "null", "string" ], "format": "date" }, "documentoValidoAte": { "type": [ "null", "string" ], "format": "date" }, "documentoEmitidoPor": { "type": [ "null", "string" ] }, "numeroInss": { "type": [ "null", "string" ] }, "genero": { "$ref": "#/components/schemas/GeneroFuncionario" }, "dataNascimento": { "type": "string", "format": "date" }, "estadoCivil": { "$ref": "#/components/schemas/EstadoCivil" }, "nacionalidade": { "type": "string" }, "grupoSanguineo": { "type": [ "null", "string" ] }, "telemovel": { "type": "string" }, "telefoneAlternativo": { "type": [ "null", "string" ] }, "emailPessoal": { "type": [ "null", "string" ] }, "emailTrabalho": { "type": [ "null", "string" ] }, "endereco": { "type": [ "null", "string" ] }, "municipioId": { "type": [ "null", "string" ], "format": "uuid" }, "numeroAutorizacaoTrabalho": { "type": [ "null", "string" ] }, "validadeAutorizacaoTrabalho": { "type": [ "null", "string" ], "format": "date" } } }, "DadosHabilitacaoAcademica": { "required": [ "nivel", "curso", "instituicao", "pais", "anoConclusao", "emCurso", "numeroDiploma", "observacao" ], "type": "object", "properties": { "nivel": { "$ref": "#/components/schemas/NivelAcademico" }, "curso": { "type": [ "null", "string" ] }, "instituicao": { "type": [ "null", "string" ] }, "pais": { "type": [ "null", "string" ] }, "anoConclusao": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "emCurso": { "type": "boolean" }, "numeroDiploma": { "type": [ "null", "string" ] }, "observacao": { "type": [ "null", "string" ] } } }, "DadosPedido": { "required": [ "empresaClienteId", "planoId", "segmento", "horaPrevistaDeChegada", "notas", "pedidosEspeciais", "vip", "rotas" ], "type": "object", "properties": { "empresaClienteId": { "type": [ "null", "string" ], "format": "uuid" }, "planoId": { "type": "string", "format": "uuid" }, "segmento": { "type": "string" }, "horaPrevistaDeChegada": { "type": [ "null", "string" ] }, "notas": { "type": [ "null", "string" ] }, "pedidosEspeciais": { "type": [ "null", "string" ] }, "vip": { "type": "boolean" }, "rotas": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RotasDto" } ] } } }, "DadosPromocao": { "required": [ "nome", "nomeCurto", "tipo", "inicio" ], "type": "object", "properties": { "nome": { "type": "string" }, "nomeCurto": { "type": "string" }, "descricao": { "type": [ "null", "string" ] }, "tipo": { "$ref": "#/components/schemas/TipoPromocao" }, "todosOsArtigos": { "type": "boolean" }, "produtoIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "categoriaIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "produtosExcluidosIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "categoriasExcluidasIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "unidades": { "$ref": "#/components/schemas/UnidadesAbrangidas" }, "leveX": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "pagueY": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "percentagem": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "valorDesconto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "preco": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "escaloes": { "type": "array", "items": { "$ref": "#/components/schemas/EscalaoPromocao" } }, "itensPack": { "type": "array", "items": { "$ref": "#/components/schemas/ItemPackPromocao" } }, "precoPack": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "produtoOferecidoId": { "type": [ "null", "string" ], "format": "uuid" }, "quantidadeOferecida": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "inicio": { "type": "string", "format": "date-time" }, "fim": { "type": [ "null", "string" ], "format": "date-time" }, "diasSemana": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "horaInicio": { "type": [ "null", "string" ], "format": "time" }, "horaFim": { "type": [ "null", "string" ], "format": "time" }, "clienteIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "quantidadeMinima": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "valorMinimo": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "metodoPagamentoIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "lojaIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "limiteUsosTotal": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "limiteUsosPorCliente": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "limiteAplicacoesPorVenda": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "stockPromocional": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "prioridade": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "acumula": { "type": "boolean" }, "permiteDescontoManual": { "type": "boolean" } } }, "DadosRubrica": { "required": [ "codigo", "nome", "natureza", "calculo", "unidade", "sujeitaIrt", "sujeitaInss", "limiteIsencao", "baseLegal" ], "type": "object", "properties": { "codigo": { "type": "string" }, "nome": { "type": "string" }, "natureza": { "$ref": "#/components/schemas/NaturezaRubrica" }, "calculo": { "$ref": "#/components/schemas/CalculoRubrica" }, "unidade": { "type": [ "null", "string" ] }, "sujeitaIrt": { "type": "boolean" }, "sujeitaInss": { "type": "boolean" }, "limiteIsencao": { "$ref": "#/components/schemas/LimiteIsencaoRubrica" }, "baseLegal": { "type": [ "null", "string" ] }, "categoriaMapa": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CategoriaMapaRemuneracoes" } ] } } }, "DadosTransporte": { "required": [ "inicioTransporte", "fimTransporte", "matricula", "origem", "destino" ], "type": "object", "properties": { "inicioTransporte": { "type": "string", "format": "date-time" }, "fimTransporte": { "type": [ "null", "string" ], "format": "date-time" }, "matricula": { "type": [ "null", "string" ] }, "origem": { "$ref": "#/components/schemas/EnderecoTransporte" }, "destino": { "$ref": "#/components/schemas/EnderecoTransporte" } } }, "DanoPedido": { "required": [ "zona", "descricao", "gravidade" ], "type": "object", "properties": { "zona": { "type": "string" }, "descricao": { "type": "string" }, "gravidade": { "type": "string" } } }, "DayOfWeek": { "enum": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ] }, "DecisaoPedido": { "required": [ "decisao", "canal", "decididoPor", "nota" ], "type": "object", "properties": { "decisao": { "type": "string" }, "canal": { "type": "string" }, "decididoPor": { "type": "string" }, "nota": { "type": [ "null", "string" ] } } }, "DecisaoRequest": { "required": [ "decisao", "motivo" ], "type": "object", "properties": { "decisao": { "type": "string" }, "motivo": { "type": "string" } } }, "DefinirActivaRequest": { "required": [ "activa" ], "type": "object", "properties": { "activa": { "type": "boolean" } } }, "DefinirActivoRequest": { "required": [ "activo" ], "type": "object", "properties": { "activo": { "type": "boolean" } } }, "DefinirComponenteRequest": { "required": [ "rubricaId", "valor", "vigenteDesde", "motivo" ], "type": "object", "properties": { "rubricaId": { "type": "string", "format": "uuid" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "vigenteDesde": { "type": "string", "format": "date" }, "motivo": { "type": [ "null", "string" ] } } }, "DefinirConfiguracaoDaAgendaCommand": { "required": [ "perfil", "granularidadeMin", "toleranciaDeFaltaMin", "horasParaExpirarPedida", "minutosUteis", "overbookingMaximoPorHora" ], "type": "object", "properties": { "perfil": { "$ref": "#/components/schemas/PerfilDeNegocio" }, "granularidadeMin": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "toleranciaDeFaltaMin": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "horasParaExpirarPedida": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "minutosUteis": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "overbookingMaximoPorHora": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "DefinirConfiguracaoDaBelezaCommand": { "required": [ "segmentos", "avisoDoCicloDias", "toleranciaDoCicloDias", "janelaDoBriefingHoras", "relacaoComAFichaDias", "validadeDaEsterilizacaoDias" ], "type": "object", "properties": { "segmentos": { "type": "array", "items": { "type": "string" } }, "avisoDoCicloDias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "toleranciaDoCicloDias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "janelaDoBriefingHoras": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "relacaoComAFichaDias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "validadeDaEsterilizacaoDias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "DefinirConfiguracaoDaLavandariaCommand": { "required": [ "prefixoDaOrdem", "abertura", "fecho", "dias", "folgaDeProducaoHoras", "capacidadeDiariaKg", "diasParaPorLevantar", "toleranciaDePesoPct", "maximoDeReprocessamentos", "abandonoActivo", "diasParaAbandono" ], "type": "object", "properties": { "prefixoDaOrdem": { "type": "string" }, "abertura": { "type": "string" }, "fecho": { "type": "string" }, "dias": { "type": "array", "items": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, "folgaDeProducaoHoras": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "capacidadeDiariaKg": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "diasParaPorLevantar": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "toleranciaDePesoPct": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "maximoDeReprocessamentos": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "abandonoActivo": { "type": "boolean" }, "diasParaAbandono": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "DefinirDefinicoesDaOficinaCommand": { "required": [ "perfis", "diagnosticoIncluido", "validadeDoOrcamentoDias", "horasSemRespostaParaAlerta", "diasNoPatioParaAviso", "artigoMaoDeObraId", "taxaMecanica", "taxaElectrica", "taxaDiagnostico", "taxaChaparia", "taxaPintura", "taxaMotos", "termoDeEntrada" ], "type": "object", "properties": { "perfis": { "type": "array", "items": { "type": "string" } }, "diagnosticoIncluido": { "type": "boolean" }, "validadeDoOrcamentoDias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "horasSemRespostaParaAlerta": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "diasNoPatioParaAviso": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "artigoMaoDeObraId": { "type": [ "null", "string" ], "format": "uuid" }, "taxaMecanica": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "taxaElectrica": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "taxaDiagnostico": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "taxaChaparia": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "taxaPintura": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "taxaMotos": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "termoDeEntrada": { "type": [ "null", "string" ] } } }, "DefinirEsgotadoRequest": { "required": [ "esgotado" ], "type": "object", "properties": { "esgotado": { "type": "boolean" }, "lojaId": { "type": [ "null", "string" ], "format": "uuid" } } }, "DefinirFichaRequest": { "required": [ "activa", "ingredientes" ], "type": "object", "properties": { "activa": { "type": "boolean" }, "ingredientes": { "type": "array", "items": { "$ref": "#/components/schemas/IngredienteInput" } }, "lojaId": { "type": [ "null", "string" ], "format": "uuid" } } }, "DefinirHabilitacoesRequest": { "required": [ "academicas", "formacoes" ], "type": "object", "properties": { "academicas": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DadosHabilitacaoAcademica" } }, "formacoes": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DadosFormacaoProfissional" } } } }, "DefinirHorarioCommand": { "required": [ "alvo", "alvoId", "janelas" ], "type": "object", "properties": { "alvo": { "$ref": "#/components/schemas/AlvoDoHorario" }, "alvoId": { "type": "string", "format": "uuid" }, "janelas": { "type": "array", "items": { "$ref": "#/components/schemas/JanelaInput" } } } }, "DefinirQuantidadeDoDiaRequest": { "required": [ "quantidade" ], "type": "object", "properties": { "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "lojaId": { "type": [ "null", "string" ], "format": "uuid" } } }, "DefinirSituacaoFiscalRequest": { "required": [ "isentoIrt", "fonteIrt", "naoSujeitoSegurancaSocial", "fonteSegurancaSocial", "vigenteDesde", "motivo" ], "type": "object", "properties": { "isentoIrt": { "type": "boolean" }, "fonteIrt": { "type": [ "null", "string" ] }, "naoSujeitoSegurancaSocial": { "type": "boolean" }, "fonteSegurancaSocial": { "type": [ "null", "string" ] }, "vigenteDesde": { "type": "string", "format": "date" }, "motivo": { "type": [ "null", "string" ] } } }, "DefinirTarifaBaseCommand": { "required": [ "planoId", "tipoDeQuartoId", "preco" ], "type": "object", "properties": { "planoId": { "type": "string", "format": "uuid" }, "tipoDeQuartoId": { "type": "string", "format": "uuid" }, "preco": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "DefinirTarifasDoDiaCommand": { "required": [ "planoId", "tipoDeQuartoId", "de", "ate", "preco", "diasDaSemana" ], "type": "object", "properties": { "planoId": { "type": "string", "format": "uuid" }, "tipoDeQuartoId": { "type": [ "null", "string" ], "format": "uuid" }, "de": { "type": "string", "format": "date" }, "ate": { "type": "string", "format": "date" }, "preco": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "diasDaSemana": { "type": [ "null", "array" ], "items": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } }, "DefinirVariacaoRequest": { "required": [ "grupoVariacaoId", "variacao" ], "type": "object", "properties": { "grupoVariacaoId": { "type": [ "null", "string" ], "format": "uuid" }, "variacao": { "type": [ "null", "string" ] } } }, "DepartamentoRequest": { "required": [ "codigo", "nome", "departamentoSuperiorId" ], "type": "object", "properties": { "codigo": { "type": "string" }, "nome": { "type": "string" }, "departamentoSuperiorId": { "type": [ "null", "string" ], "format": "uuid" } } }, "DepositoPedido": { "required": [ "valor", "referencia" ], "type": "object", "properties": { "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "referencia": { "type": [ "null", "string" ] } } }, "DesfazerConciliacaoRequest": { "required": [ "motivo" ], "type": "object", "properties": { "motivo": { "type": "string" } } }, "DesfazerUtilizacaoRequest": { "required": [ "motivo" ], "type": "object", "properties": { "motivo": { "type": "string" } } }, "DespesaRecorrenteDetalheDto": { "required": [ "despesa", "historico" ], "type": "object", "properties": { "despesa": { "$ref": "#/components/schemas/DespesaRecorrenteDto" }, "historico": { "type": "array", "items": { "$ref": "#/components/schemas/LancamentoRecorrenteDto" } } } }, "DespesaRecorrenteDto": { "required": [ "id", "numero", "lojaId", "categoriaFinanceiraId", "categoriaNome", "descricao", "valor", "fornecedorId", "fornecedorNome", "centroCustoId", "centroCustoNome", "frequencia", "diaLancamento", "prazoPagamentoDias", "dataInicio", "dataFim", "proximaEmissao", "estado", "pendente", "ciclosEmAtraso", "observacao", "criadaEmUtc" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "numero": { "type": "string" }, "lojaId": { "type": "string", "format": "uuid" }, "categoriaFinanceiraId": { "type": "string", "format": "uuid" }, "categoriaNome": { "type": "string" }, "descricao": { "type": "string" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "fornecedorId": { "type": [ "null", "string" ], "format": "uuid" }, "fornecedorNome": { "type": [ "null", "string" ] }, "centroCustoId": { "type": [ "null", "string" ], "format": "uuid" }, "centroCustoNome": { "type": [ "null", "string" ] }, "frequencia": { "type": "string" }, "diaLancamento": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "prazoPagamentoDias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "dataInicio": { "type": "string", "format": "date" }, "dataFim": { "type": [ "null", "string" ], "format": "date" }, "proximaEmissao": { "type": "string", "format": "date" }, "estado": { "type": "string" }, "pendente": { "type": "boolean" }, "ciclosEmAtraso": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "observacao": { "type": [ "null", "string" ] }, "criadaEmUtc": { "type": "string", "format": "date-time" } } }, "DestinoPedido": { "required": [ "destino" ], "type": "object", "properties": { "destino": { "type": [ "null", "string" ] } } }, "DevolucaoActivoRequest": { "required": [ "data", "condicao" ], "type": "object", "properties": { "data": { "type": "string", "format": "date" }, "condicao": { "type": [ "null", "string" ] } } }, "DiaDeEncerramentoRequest": { "required": [ "data", "descricao" ], "type": "object", "properties": { "data": { "type": "string", "format": "date" }, "descricao": { "type": "string" } } }, "DiagnosticoPedido": { "required": [ "texto", "tempoMin", "codigosObd" ], "type": "object", "properties": { "texto": { "type": "string" }, "tempoMin": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "codigosObd": { "type": [ "null", "string" ] } } }, "DiasUteisRequest": { "required": [ "diasUteis" ], "type": "object", "properties": { "diasUteis": { "type": "array", "items": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } } }, "DisponibilidadeLojaDto": { "required": [ "lojaId", "lojaNome", "lojaCodigo", "armazemId", "armazemDescricao", "quantidadeDisponivel" ], "type": "object", "properties": { "lojaId": { "type": "string", "format": "uuid" }, "lojaNome": { "type": "string" }, "lojaCodigo": { "type": "string" }, "armazemId": { "type": "string", "format": "uuid" }, "armazemDescricao": { "type": "string" }, "quantidadeDisponivel": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "DisponibilidadeTransferenciaDto": { "required": [ "produtoId", "disponivel" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "disponivel": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "lotes": { "type": "array", "items": { "$ref": "#/components/schemas/LoteTransferenciaDto" } } } }, "DistribuirPedido": { "required": [ "propriedadeId", "data", "camareiras" ], "type": "object", "properties": { "propriedadeId": { "type": [ "null", "string" ], "format": "uuid" }, "data": { "type": [ "null", "string" ], "format": "date" }, "camareiras": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } }, "DocumentoDaViaturaPedido": { "required": [ "tipo", "referencia", "validadeAte", "nota" ], "type": "object", "properties": { "tipo": { "type": "string" }, "referencia": { "type": [ "null", "string" ] }, "validadeAte": { "type": [ "null", "string" ], "format": "date" }, "nota": { "type": [ "null", "string" ] } } }, "DocumentoDto": { "required": [ "id", "tipoDocumentoId", "numero", "data", "clienteId", "clienteNome", "caixaId", "armazemId", "referenciaExternaId", "estado", "motivoAnulacao", "observacao", "hash", "hashControlo", "versaoChavePrivada", "dataHoraAssinatura", "subtotal", "valorImposto", "totalValorRetencao", "valorLiquidado", "valorCreditado", "vendedorOriginadorId", "vendedorFaturadorId", "outrosEncargos", "referenciaCliente", "montantePago", "totalDesconto", "operadorNome", "dataVencimento", "registadoOfflineEmUtc", "chaveApiId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "tipoDocumentoId": { "type": "string", "format": "uuid" }, "numero": { "type": "string" }, "data": { "type": "string", "format": "date-time" }, "clienteId": { "type": "string", "format": "uuid" }, "clienteNome": { "type": [ "null", "string" ] }, "caixaId": { "type": [ "null", "string" ], "format": "uuid" }, "armazemId": { "type": [ "null", "string" ], "format": "uuid" }, "referenciaExternaId": { "type": [ "null", "string" ], "format": "uuid" }, "estado": { "type": "string" }, "motivoAnulacao": { "type": [ "null", "string" ] }, "observacao": { "type": [ "null", "string" ] }, "hash": { "type": [ "null", "string" ] }, "hashControlo": { "type": [ "null", "string" ] }, "versaoChavePrivada": { "type": [ "null", "string" ] }, "dataHoraAssinatura": { "type": [ "null", "string" ], "format": "date-time" }, "subtotal": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorImposto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalValorRetencao": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorLiquidado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorCreditado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "vendedorOriginadorId": { "type": [ "null", "string" ], "format": "uuid" }, "vendedorFaturadorId": { "type": [ "null", "string" ], "format": "uuid" }, "outrosEncargos": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "referenciaCliente": { "type": [ "null", "string" ] }, "montantePago": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalDesconto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "operadorNome": { "type": [ "null", "string" ] }, "dataVencimento": { "type": [ "null", "string" ], "format": "date" }, "registadoOfflineEmUtc": { "type": [ "null", "string" ], "format": "date-time" }, "chaveApiId": { "type": [ "null", "string" ], "format": "uuid" }, "importadoOfflineOperador": { "type": [ "null", "string" ] }, "importadoOfflineDispositivo": { "type": [ "null", "string" ] }, "importadoOfflinePorNome": { "type": [ "null", "string" ] }, "totalGeral": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalRecebido": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalDocumento": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorPendente": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalGeralPorExtenso": { "type": [ "null", "string" ] }, "itens": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentoItemDto" } }, "pagamentos": { "type": "array", "items": { "$ref": "#/components/schemas/PagamentoDto" } }, "liquidacoes": { "type": "array", "items": { "$ref": "#/components/schemas/LiquidacaoDto" } }, "pagamentosRecebidos": { "type": "array", "items": { "$ref": "#/components/schemas/PagamentoRecebidoDto" } } } }, "DocumentoEmitidoDto": { "required": [ "id", "siglaDocumento", "tipoDescricao", "numero", "data", "clienteId", "clienteNome", "usuarioId", "estado", "motivoAnulacao", "referencia", "subtotal", "imposto", "desconto", "retencao", "totalGeral", "pago", "porPagar" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "siglaDocumento": { "type": "string" }, "tipoDescricao": { "type": "string" }, "numero": { "type": "string" }, "data": { "type": "string", "format": "date-time" }, "clienteId": { "type": "string", "format": "uuid" }, "clienteNome": { "type": "string" }, "usuarioId": { "type": [ "null", "string" ], "format": "uuid" }, "estado": { "type": "string" }, "motivoAnulacao": { "type": [ "null", "string" ] }, "referencia": { "type": [ "null", "string" ] }, "subtotal": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "imposto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "desconto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "retencao": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalGeral": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "pago": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "porPagar": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "DocumentoImpressaoDto": { "required": [ "empresa", "cliente", "tipoDescricao", "siglaDocumento", "numero", "data", "estado", "motivoAnulacao", "observacao", "numeroDocumentoReferencia", "referenciaCliente", "itens", "resumoImpostos", "totalDesconto", "subtotal", "totalImposto", "totalRetencao", "totalGeral", "totalPorExtenso", "pagamentos", "liquidacoes", "montantePago", "hash", "hashControlo", "linhaAssinatura", "naoServeDeFactura" ], "type": "object", "properties": { "empresa": { "$ref": "#/components/schemas/EmpresaImpressaoDto" }, "cliente": { "$ref": "#/components/schemas/ClienteImpressaoDto" }, "tipoDescricao": { "type": "string" }, "siglaDocumento": { "type": "string" }, "numero": { "type": "string" }, "data": { "type": "string", "format": "date-time" }, "estado": { "type": "string" }, "motivoAnulacao": { "type": [ "null", "string" ] }, "observacao": { "type": [ "null", "string" ] }, "numeroDocumentoReferencia": { "type": [ "null", "string" ] }, "referenciaCliente": { "type": [ "null", "string" ] }, "itens": { "type": "array", "items": { "$ref": "#/components/schemas/ItemImpressaoDto" } }, "resumoImpostos": { "type": "array", "items": { "$ref": "#/components/schemas/ResumoImpostoDto" } }, "totalDesconto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "subtotal": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalImposto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalRetencao": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalGeral": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalPorExtenso": { "type": "string" }, "pagamentos": { "type": "array", "items": { "$ref": "#/components/schemas/PagamentoImpressaoDto" } }, "liquidacoes": { "type": "array", "items": { "$ref": "#/components/schemas/LiquidacaoDto" } }, "montantePago": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "hash": { "type": [ "null", "string" ] }, "hashControlo": { "type": [ "null", "string" ] }, "linhaAssinatura": { "type": [ "null", "string" ] }, "naoServeDeFactura": { "type": "boolean" }, "ehRecibo": { "type": "boolean" }, "empresaGestora": { "type": "boolean" }, "rodapeDaMarca": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RodapeDaMarcaDto" } ] }, "mostraRodapeDoPlano": { "type": "boolean" }, "dataVencimento": { "type": [ "null", "string" ], "format": "date" }, "transporte": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DadosTransporte" } ] }, "qrCode": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/QrCodeDto" } ] }, "documentoId": { "type": "string", "format": "uuid" }, "localDaOperacao": { "type": [ "null", "string" ] }, "naturezaDaCorreccao": { "type": [ "null", "string" ] } } }, "DocumentoItemDto": { "required": [ "id", "produtoId", "loteId", "descricao", "precoUnitario", "quantidade", "descontoPercentual", "descontoFinanceiroPercentual", "impostoPercentual", "taxaRetencaoPercentual", "referenciaItemOrigemId", "creditadaEmDocumentoId", "motivoAnulacaoItem" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "produtoId": { "type": "string", "format": "uuid" }, "loteId": { "type": [ "null", "string" ], "format": "uuid" }, "descricao": { "type": "string" }, "precoUnitario": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "descontoPercentual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "descontoFinanceiroPercentual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "impostoPercentual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "taxaRetencaoPercentual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "referenciaItemOrigemId": { "type": [ "null", "string" ], "format": "uuid" }, "creditadaEmDocumentoId": { "type": [ "null", "string" ], "format": "uuid" }, "motivoAnulacaoItem": { "type": [ "null", "string" ] }, "descontoPromocao": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "promocaoId": { "type": [ "null", "string" ], "format": "uuid" }, "promocaoNome": { "type": [ "null", "string" ] }, "oferta": { "type": "boolean", "default": false }, "precoTotal": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorDesconto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "subtotal": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorImposto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalValorRetencao": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorPagar": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "DocumentoPendenteDto": { "required": [ "id", "numero", "data", "tipoDocumentoId", "siglaDocumento", "totalGeral", "valorLiquidado", "valorCreditado" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "numero": { "type": "string" }, "data": { "type": "string", "format": "date-time" }, "tipoDocumentoId": { "type": "string", "format": "uuid" }, "siglaDocumento": { "type": "string" }, "totalGeral": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorLiquidado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorCreditado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorPendente": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "DoseInputDto": { "required": [ "produtoId", "quantidade", "unidade", "descartavel" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "unidade": { "type": "string" }, "descartavel": { "type": "boolean" } } }, "DosePedido": { "required": [ "servicoDaMarcacaoId", "produtoId", "produtoNome", "quantidade", "unidade", "ePadrao", "descartavel" ], "type": "object", "properties": { "servicoDaMarcacaoId": { "type": [ "null", "string" ], "format": "uuid" }, "produtoId": { "type": [ "null", "string" ], "format": "uuid" }, "produtoNome": { "type": [ "null", "string" ] }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "unidade": { "type": "string" }, "ePadrao": { "type": "boolean" }, "descartavel": { "type": "boolean" } } }, "EdicaoLinhaCessacaoDto": { "required": [ "id", "tipo", "natureza", "descricao", "incluida", "valor", "justificacao", "fonteLegal" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ], "format": "uuid" }, "tipo": { "$ref": "#/components/schemas/TipoLinhaCessacao" }, "natureza": { "$ref": "#/components/schemas/NaturezaRubrica" }, "descricao": { "type": [ "null", "string" ] }, "incluida": { "type": "boolean" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "justificacao": { "type": [ "null", "string" ] }, "fonteLegal": { "type": [ "null", "string" ] } } }, "EditarCondicaoDePagamentoRequest": { "required": [ "nome", "dias", "activa", "porOmissao" ], "type": "object", "properties": { "nome": { "type": "string" }, "dias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "activa": { "type": "boolean" }, "porOmissao": { "type": "boolean" } } }, "EditarContratoPedido": { "required": [ "titulo", "objecto", "dataInicio", "responsavelUserId", "termos", "plano" ], "type": "object", "properties": { "titulo": { "type": "string" }, "objecto": { "type": [ "null", "string" ] }, "dataInicio": { "type": "string", "format": "date" }, "responsavelUserId": { "type": [ "null", "string" ], "format": "uuid" }, "termos": { "$ref": "#/components/schemas/TermosInput" }, "plano": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PlanoInput" } ] } } }, "EditarDespesaRecorrenteRequest": { "required": [ "descricao", "valor", "categoriaFinanceiraId", "prazoPagamentoDias" ], "type": "object", "properties": { "descricao": { "type": "string" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "categoriaFinanceiraId": { "type": "string", "format": "uuid" }, "prazoPagamentoDias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "fornecedorId": { "type": [ "null", "string" ], "format": "uuid" }, "centroCustoId": { "type": [ "null", "string" ], "format": "uuid" }, "observacao": { "type": [ "null", "string" ] } } }, "EfeitoSalarialAusencia": { "enum": [ "SemDesconto", "DescontoDoSalario", "PagoPelaSegurancaSocial" ] }, "EmpresaDto": { "required": [ "nome", "slug", "email", "numeroContribuinte", "endereco", "municipioId", "regimeFiscalId", "informacaoFactura", "contasBancarias", "telefone", "website", "temLogotipo", "observacao", "dadosFiscaisBloqueados" ], "type": "object", "properties": { "nome": { "type": "string" }, "slug": { "type": "string" }, "email": { "type": "string" }, "numeroContribuinte": { "type": [ "null", "string" ] }, "endereco": { "type": [ "null", "string" ] }, "municipioId": { "type": [ "null", "string" ], "format": "uuid" }, "regimeFiscalId": { "type": [ "null", "string" ], "format": "uuid" }, "informacaoFactura": { "type": [ "null", "string" ] }, "contasBancarias": { "type": "array", "items": { "$ref": "#/components/schemas/ContaBancariaDto" } }, "telefone": { "type": [ "null", "string" ] }, "website": { "type": [ "null", "string" ] }, "temLogotipo": { "type": "boolean" }, "observacao": { "type": [ "null", "string" ] }, "dadosFiscaisBloqueados": { "type": "boolean" }, "bloqueadaNaVersaoDeTestes": { "type": "boolean", "default": false } } }, "EmpresaImpressaoDto": { "required": [ "nome", "numeroContribuinte", "endereco", "telefone", "email", "website", "temLogotipo", "informacaoFactura", "contasBancarias", "numeroCertificadoAgt" ], "type": "object", "properties": { "nome": { "type": "string" }, "numeroContribuinte": { "type": [ "null", "string" ] }, "endereco": { "type": [ "null", "string" ] }, "telefone": { "type": [ "null", "string" ] }, "email": { "type": "string" }, "website": { "type": [ "null", "string" ] }, "temLogotipo": { "type": "boolean" }, "informacaoFactura": { "type": [ "null", "string" ] }, "contasBancarias": { "type": "array", "items": { "$ref": "#/components/schemas/ContaBancariaDto" } }, "numeroCertificadoAgt": { "type": [ "null", "string" ] } } }, "EncerrarAdesaoRequest": { "required": [ "ate" ], "type": "object", "properties": { "ate": { "type": "string", "format": "date" } } }, "EncerrarComponenteRequest": { "required": [ "ate" ], "type": "object", "properties": { "ate": { "type": "string", "format": "date" } } }, "EncerrarLitigioRequest": { "required": [ "resultado", "data", "valorFinal", "descricao" ], "type": "object", "properties": { "resultado": { "$ref": "#/components/schemas/EstadoLitigio" }, "data": { "type": "string", "format": "date" }, "valorFinal": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "descricao": { "type": "string" } } }, "EnderecoTransporte": { "required": [ "detalhe", "cidade", "codigoPostal" ], "type": "object", "properties": { "detalhe": { "type": "string" }, "cidade": { "type": "string" }, "codigoPostal": { "type": [ "null", "string" ] }, "pais": { "type": "string", "default": "AO" } } }, "EntradaEstoqueDetalheDto": { "required": [ "id", "numero", "data", "factura", "tipoDocumento", "dataFactura", "fornecedorId", "fornecedorNome", "armazemId", "armazemDescricao", "condicaoPagamento", "vencimento", "observacao", "custosAdicionais", "anexoNomeOriginal", "anexoTipoConteudo", "anexoTamanhoBytes", "total" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "numero": { "type": "string" }, "data": { "type": "string", "format": "date-time" }, "factura": { "type": "string" }, "tipoDocumento": { "type": "string" }, "dataFactura": { "type": "string", "format": "date-time" }, "fornecedorId": { "type": "string", "format": "uuid" }, "fornecedorNome": { "type": "string" }, "armazemId": { "type": "string", "format": "uuid" }, "armazemDescricao": { "type": "string" }, "condicaoPagamento": { "type": "string" }, "vencimento": { "type": "string", "format": "date-time" }, "observacao": { "type": [ "null", "string" ] }, "custosAdicionais": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "anexoNomeOriginal": { "type": [ "null", "string" ] }, "anexoTipoConteudo": { "type": [ "null", "string" ] }, "anexoTamanhoBytes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int64" }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "moedaCodigo": { "type": [ "null", "string" ] }, "cambio": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "valorNaMoeda": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "itens": { "type": "array", "items": { "$ref": "#/components/schemas/EntradaEstoqueItemDto" } }, "pagamentos": { "type": "array", "items": { "$ref": "#/components/schemas/PagamentoEntradaEstoqueDto" } }, "totalPago": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "divida": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "identidade": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/IdentidadeDeDocumentoDto" } ] } } }, "EntradaEstoqueItemDto": { "required": [ "produtoId", "produtoNome", "loteId", "loteDescricao", "precoUnitario", "quantidade", "descontoPercentual", "impostoPercentual", "precoTotal", "valorDesconto", "subtotal", "valorImposto", "valorPagar" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "produtoNome": { "type": "string" }, "loteId": { "type": [ "null", "string" ], "format": "uuid" }, "loteDescricao": { "type": [ "null", "string" ] }, "precoUnitario": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "descontoPercentual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "impostoPercentual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "precoTotal": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorDesconto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "subtotal": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorImposto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorPagar": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "EntradaEstoqueResumoDto": { "required": [ "id", "numero", "data", "factura", "tipoDocumento", "fornecedorNome", "armazemDescricao", "total", "vencimento" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "numero": { "type": "string" }, "data": { "type": "string", "format": "date-time" }, "factura": { "type": "string" }, "tipoDocumento": { "type": "string" }, "fornecedorNome": { "type": "string" }, "armazemDescricao": { "type": "string" }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "vencimento": { "type": "string", "format": "date-time" } } }, "EntrarNaFilaCommand": { "required": [ "lojaId", "clienteId", "servicoId", "profissionalPreferidoId" ], "type": "object", "properties": { "lojaId": { "type": [ "null", "string" ], "format": "uuid" }, "clienteId": { "type": "string", "format": "uuid" }, "servicoId": { "type": "string", "format": "uuid" }, "profissionalPreferidoId": { "type": [ "null", "string" ], "format": "uuid" } } }, "EntregaPedido": { "required": [ "entregaId", "pagamentos", "kmSaida", "levantadoPor", "armazemId" ], "type": "object", "properties": { "entregaId": { "type": "string", "format": "uuid" }, "pagamentos": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/PagamentoDaEntrega" } }, "kmSaida": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "levantadoPor": { "type": [ "null", "string" ] }, "armazemId": { "type": [ "null", "string" ], "format": "uuid" } } }, "EntregarActivoCommand": { "required": [ "funcionarioId", "categoria", "descricao", "numeroSerie", "dataEntrega", "validade", "condicaoNaEntrega" ], "type": "object", "properties": { "funcionarioId": { "type": "string", "format": "uuid" }, "categoria": { "$ref": "#/components/schemas/CategoriaActivo" }, "descricao": { "type": "string" }, "numeroSerie": { "type": [ "null", "string" ] }, "dataEntrega": { "type": "string", "format": "date" }, "validade": { "type": [ "null", "string" ], "format": "date" }, "condicaoNaEntrega": { "type": [ "null", "string" ] } } }, "EnviarEmailRequest": { "required": [ "destinatario" ], "type": "object", "properties": { "destinatario": { "type": [ "null", "string" ] } } }, "EnviarExtractoRequest": { "type": "object", "properties": { "de": { "type": [ "null", "string" ], "format": "date" }, "ate": { "type": [ "null", "string" ], "format": "date" }, "destinatario": { "type": [ "null", "string" ] } } }, "EnviarRequest": { "type": "object", "properties": { "faseAPedir": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/FaseDoServico" } ] } } }, "EnvioDocumentoDto": { "required": [ "id", "destinatario", "origem", "tipo", "estado", "tentativas", "ultimoErro", "criadoEmUtc", "proximaTentativaEmUtc", "enviadoEmUtc", "solicitadoPor" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "destinatario": { "type": "string" }, "origem": { "type": "string" }, "tipo": { "type": "string" }, "estado": { "type": "string" }, "tentativas": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "ultimoErro": { "type": [ "null", "string" ] }, "criadoEmUtc": { "type": "string", "format": "date-time" }, "proximaTentativaEmUtc": { "type": [ "null", "string" ], "format": "date-time" }, "enviadoEmUtc": { "type": [ "null", "string" ], "format": "date-time" }, "solicitadoPor": { "type": [ "null", "string" ] } } }, "EnvioPedido": { "required": [ "comLigacao" ], "type": "object", "properties": { "comLigacao": { "type": "boolean" } } }, "EquipamentoPontoRequest": { "required": [ "nome", "marca", "modelo", "numeroSerie", "lojaId", "observacao", "activo" ], "type": "object", "properties": { "nome": { "type": "string" }, "marca": { "$ref": "#/components/schemas/MarcaEquipamentoPonto" }, "modelo": { "type": [ "null", "string" ] }, "numeroSerie": { "type": [ "null", "string" ] }, "lojaId": { "type": [ "null", "string" ], "format": "uuid" }, "observacao": { "type": [ "null", "string" ] }, "activo": { "type": [ "null", "boolean" ] } } }, "EscalaoPromocao": { "required": [ "quantidadeMinima", "precoUnitario" ], "type": "object", "properties": { "quantidadeMinima": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "precoUnitario": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "EstadiaPedida": { "required": [ "tipoDeQuartoId", "quartoId", "chegada", "partida", "adultos", "criancas", "hospedeNome" ], "type": "object", "properties": { "tipoDeQuartoId": { "type": "string", "format": "uuid" }, "quartoId": { "type": [ "null", "string" ], "format": "uuid" }, "chegada": { "type": "string", "format": "date" }, "partida": { "type": "string", "format": "date" }, "adultos": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "criancas": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "hospedeNome": { "type": [ "null", "string" ] } } }, "EstadiaPedido": { "required": [ "estadia", "aceitarOverbooking" ], "type": "object", "properties": { "estadia": { "$ref": "#/components/schemas/EstadiaPedida" }, "aceitarOverbooking": { "type": "boolean" } } }, "EstadoActivo": { "enum": [ "Entregue", "Devolvido", "Anulado", null ] }, "EstadoAvaliacao": { "enum": [ "Rascunho", "Concluida", "Anulada", null ] }, "EstadoAvenca": { "enum": [ "Activo", "Pausado", "Concluido", "Cancelado", null ] }, "EstadoCessacao": { "enum": [ "Rascunho", "Aprovada", null ] }, "EstadoCivil": { "enum": [ "Solteiro", "Casado", "Divorciado", "Viuvo", "UniaoDeFacto" ] }, "EstadoConciliacaoDto": { "required": [ "contaFinanceiraId", "conta", "conciliadaAte", "saldoConciliado", "saldoNoSistema", "movimentosPorConciliar", "podeDesfazer", "historico" ], "type": "object", "properties": { "contaFinanceiraId": { "type": "string", "format": "uuid" }, "conta": { "type": "string" }, "conciliadaAte": { "type": [ "null", "string" ], "format": "date" }, "saldoConciliado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "saldoNoSistema": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "movimentosPorConciliar": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "podeDesfazer": { "type": [ "null", "string" ], "format": "uuid" }, "historico": { "type": "array", "items": { "$ref": "#/components/schemas/ConciliacaoDto" } } } }, "EstadoDaMensagem": { "enum": [ "Pendente", "Enviada", "Falhou", null ] }, "EstadoDaNotificacao": { "enum": [ "Pendente", "Enviada", "Falhou", null ] }, "EstadoDaOrdem": { "enum": [ "Recebida", "EmProducao", "Pronta", "Entregue", "Cancelada", "Abandonada", null ] }, "EstadoDenuncia": { "enum": [ "Recebida", "EmAnalise", "Concluida", "Arquivada", null ] }, "EstadoDoAcerto": { "enum": [ "Pendente", "Resolvido", "Dispensado", null ] }, "EstadoDoContrato": { "enum": [ "Rascunho", "EmAprovacao", "Aprovado", "Assinado", "Activo", "Suspenso", "EmRenovacao", "Expirado", "Rescindido", "Encerrado", null ] }, "EstadoDoIncidente": { "enum": [ "Aberto", "Resolvido", null ] }, "EstadoDoLote": { "enum": [ "EmCiclo", "Concluido", "Cancelado", null ] }, "EstadoFuncionario": { "enum": [ "Activo", "Suspenso", "EmLicenca", "Cessado", null ] }, "EstadoLitigio": { "enum": [ "Aberto", "AcordoAlcancado", "GanhoPelaEmpresa", "PerdidoPelaEmpresa", null ] }, "EstadoPedidoRh": { "enum": [ "Pendente", "Aprovado", "Rejeitado", "Anulado", null ] }, "EstadoProcessoDisciplinar": { "enum": [ "EmCurso", "Concluido", "Arquivado", null ] }, "EstadoRequest": { "required": [ "estado" ], "type": "object", "properties": { "estado": { "$ref": "#/components/schemas/EstadoFuncionario" }, "motivo": { "type": [ "null", "string" ] }, "dataInicio": { "type": [ "null", "string" ], "format": "date" }, "retornoPrevisto": { "type": [ "null", "string" ], "format": "date" }, "dataRetorno": { "type": [ "null", "string" ], "format": "date" } } }, "EstenderPedido": { "required": [ "novaPartida" ], "type": "object", "properties": { "novaPartida": { "type": "string", "format": "date" } } }, "EsterilizacaoPedido": { "required": [ "lote", "aparelho", "validadeDias" ], "type": "object", "properties": { "lote": { "type": [ "null", "string" ] }, "aparelho": { "type": [ "null", "string" ] }, "validadeDias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "EstornarPagamentoRequest": { "required": [ "motivo" ], "type": "object", "properties": { "motivo": { "type": "string" } } }, "EstornarTransferenciaRequest": { "required": [ "motivo" ], "type": "object", "properties": { "motivo": { "type": "string" } } }, "EstornoPedido": { "required": [ "quantidade", "motivo" ], "type": "object", "properties": { "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "motivo": { "type": [ "null", "string" ] } } }, "EventoDescontoRequest": { "required": [ "tipo", "aPartirDe", "motivo" ], "type": "object", "properties": { "tipo": { "$ref": "#/components/schemas/TipoEventoDesconto" }, "aPartirDe": { "type": "string", "format": "date" }, "motivo": { "type": "string" } } }, "EventoLitigioRequest": { "required": [ "tipo", "data", "descricao", "valor", "novoForo" ], "type": "object", "properties": { "tipo": { "$ref": "#/components/schemas/TipoEventoLitigio" }, "data": { "type": "string", "format": "date" }, "descricao": { "type": "string" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "novoForo": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/ForoLitigio" } ] } } }, "ExigenciaDeDeposito": { "enum": [ "Nunca", "Sempre", "SoRisco" ] }, "FacturarPedido": { "required": [ "pedidoId", "janela", "pagamentos" ], "type": "object", "properties": { "pedidoId": { "type": "string", "format": "uuid" }, "janela": { "type": "string" }, "pagamentos": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/PagamentoDaFacturacao" } } } }, "FalhaLancamentoDto": { "required": [ "numero", "erro" ], "type": "object", "properties": { "numero": { "type": "string" }, "erro": { "type": "string" } } }, "FaseDaPeca": { "enum": [ "Triagem", "Lavagem", "Secagem", "Acabamento", "Qualidade", "Pronta", "Entregue", "NaoRecuperavel", "Perdida", "Cancelada" ] }, "FaseDisciplinarRequest": { "required": [ "tipo", "data", "descricao" ], "type": "object", "properties": { "tipo": { "$ref": "#/components/schemas/TipoFaseDisciplinar" }, "data": { "type": "string", "format": "date" }, "descricao": { "type": "string" } } }, "FaseDoServico": { "enum": [ "Agora", "Entrada", "Principal", "Sobremesa" ], "default": "Agora" }, "FecharLoteCommand": { "required": [ "maquinaId", "fase", "itensIds", "nota" ], "type": "object", "properties": { "maquinaId": { "type": "string", "format": "uuid" }, "fase": { "$ref": "#/components/schemas/FaseDaPeca" }, "itensIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "nota": { "type": [ "null", "string" ] } } }, "FecharPedido": { "required": [ "propriedadeId", "antecipar" ], "type": "object", "properties": { "propriedadeId": { "type": [ "null", "string" ], "format": "uuid" }, "antecipar": { "type": "boolean" } } }, "FecharPeriodoRequest": { "required": [ "ate" ], "type": "object", "properties": { "ate": { "type": "string", "format": "date" } } }, "FechoDePeriodoDto": { "required": [ "id", "sequencia", "tipo", "fechadoAte", "fechadoAteAnterior", "motivo", "realizadoPorNome", "realizadoEmUtc" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "sequencia": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "tipo": { "type": "string" }, "fechadoAte": { "type": [ "null", "string" ], "format": "date" }, "fechadoAteAnterior": { "type": [ "null", "string" ], "format": "date" }, "motivo": { "type": [ "null", "string" ] }, "realizadoPorNome": { "type": [ "null", "string" ] }, "realizadoEmUtc": { "type": "string", "format": "date-time" } } }, "FeriadoRequest": { "required": [ "data", "nome", "tipo", "fonte" ], "type": "object", "properties": { "data": { "type": "string", "format": "date" }, "nome": { "type": "string" }, "tipo": { "$ref": "#/components/schemas/TipoFeriado" }, "fonte": { "type": [ "null", "string" ] } } }, "FichaPedido": { "required": [ "capilar", "pele", "unhas", "pestanas", "preferencias", "ultimaQuimicaEm", "notasDaEquipa" ], "type": "object", "properties": { "capilar": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PerfilCapilar" } ] }, "pele": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PerfilDePele" } ] }, "unhas": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PerfilDeUnhas" } ] }, "pestanas": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PerfilDePestanas" } ] }, "preferencias": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/PreferenciasDoCliente" } ] }, "ultimaQuimicaEm": { "type": [ "null", "string" ], "format": "date" }, "notasDaEquipa": { "type": [ "null", "string" ] } } }, "FirmarSugestaoInput": { "required": [ "sugestaoId" ], "type": "object", "properties": { "sugestaoId": { "type": "string", "format": "uuid" }, "fornecedorId": { "type": [ "null", "string" ], "format": "uuid" } } }, "FirmarSugestoesRequest": { "required": [ "sugestoes" ], "type": "object", "properties": { "sugestoes": { "type": "array", "items": { "$ref": "#/components/schemas/FirmarSugestaoInput" } } } }, "FluxoCaixaPrevistoDto": { "required": [ "hoje", "horizonte", "saldoActual", "receberVencido", "pagarVencido", "incluiReceberVencido", "totalAReceber", "totalAPagar", "saldoFinalProjectado", "saldoMinimoProjectado", "primeiroDiaNegativo", "diasDeCaixa", "pontos" ], "type": "object", "properties": { "hoje": { "type": "string", "format": "date" }, "horizonte": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "saldoActual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "receberVencido": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "pagarVencido": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "incluiReceberVencido": { "type": "boolean" }, "totalAReceber": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalAPagar": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "saldoFinalProjectado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "saldoMinimoProjectado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "primeiroDiaNegativo": { "type": [ "null", "string" ], "format": "date" }, "diasDeCaixa": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "pontos": { "type": "array", "items": { "$ref": "#/components/schemas/PontoPrevistoDto" } }, "totalAPagarRecorrente": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "totalAReceberAvencas": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 } } }, "FluxoCaixaRealizadoDto": { "required": [ "de", "ate", "contaId", "granularidade", "saldoInicial", "entradas", "saidas", "transferencias", "ajustesDeSaldoInicial", "saldoFinal", "actividades", "periodos" ], "type": "object", "properties": { "de": { "type": "string", "format": "date" }, "ate": { "type": "string", "format": "date" }, "contaId": { "type": [ "null", "string" ], "format": "uuid" }, "granularidade": { "type": "string" }, "saldoInicial": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "entradas": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "saidas": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "transferencias": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "ajustesDeSaldoInicial": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "saldoFinal": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "actividades": { "type": "array", "items": { "$ref": "#/components/schemas/ActividadeFluxoDto" } }, "periodos": { "type": "array", "items": { "$ref": "#/components/schemas/PeriodoFluxoDto" } } } }, "FormaPagamentoSalario": { "enum": [ "Transferencia", "Numerario", "Cheque" ] }, "FormatoMapaRemuneracoesAgt": { "enum": [ "Simplificado", "Detalhado" ] }, "FormatoSaftInventario": { "enum": [ "Xml", "Json", "Excel" ] }, "FornecedorDetalheDto": { "required": [ "id", "nome", "numeroContribuinte", "telefone", "municipioId", "email", "endereco", "contacto", "website", "fax", "codigoPostal", "observacao" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "nome": { "type": "string" }, "numeroContribuinte": { "type": "string" }, "telefone": { "type": "string" }, "municipioId": { "type": [ "null", "string" ], "format": "uuid" }, "email": { "type": [ "null", "string" ] }, "endereco": { "type": [ "null", "string" ] }, "contacto": { "type": [ "null", "string" ] }, "website": { "type": [ "null", "string" ] }, "fax": { "type": [ "null", "string" ] }, "codigoPostal": { "type": [ "null", "string" ] }, "observacao": { "type": [ "null", "string" ] }, "nifEmAngola": { "type": "boolean", "default": true }, "pais": { "type": [ "null", "string" ] }, "cidade": { "type": [ "null", "string" ] } } }, "FornecedorResumoDto": { "required": [ "id", "nome", "numeroContribuinte", "telefone", "alteradoEmUtc" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "nome": { "type": "string" }, "numeroContribuinte": { "type": "string" }, "telefone": { "type": "string" }, "alteradoEmUtc": { "type": "string", "format": "date-time" }, "eliminado": { "type": "boolean", "default": false } } }, "ForoLitigio": { "enum": [ "MediacaoIgt", "TribunalDoTrabalho", "Arbitragem" ] }, "FrequenciaAvenca": { "enum": [ "Mensal", "Trimestral", "Semestral", "Anual" ] }, "FrequenciaDaSerie": { "enum": [ "Semanal", "Quinzenal", "QuatroSemanas" ] }, "FrequenciaDoPlano": { "enum": [ "Mensal", "Trimestral", "Semestral", "Anual" ] }, "GeneroFuncionario": { "enum": [ "Masculino", "Feminino" ] }, "GerarSubsidiosExtraordinariosRequest": { "required": [ "tipo", "modo", "competencia", "rubricaId", "funcionarioIds" ], "type": "object", "properties": { "tipo": { "$ref": "#/components/schemas/TipoSubsidioExtraordinario" }, "modo": { "$ref": "#/components/schemas/ModoSubsidioExtraordinario" }, "competencia": { "type": "string", "format": "date" }, "rubricaId": { "type": "string", "format": "uuid" }, "funcionarioIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } }, "GranularidadeFluxo": { "enum": [ "Auto", "Dia", "Semana", "Mes" ] }, "GravidadeAcidente": { "enum": [ "Ligeiro", "Grave", "Mortal" ] }, "GruposDoProdutoRequest": { "required": [ "grupoIds" ], "type": "object", "properties": { "grupoIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "GrupoVariacaoDto": { "required": [ "id", "nome", "variacoes" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "nome": { "type": "string" }, "variacoes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "GuardarBoxCommand": { "required": [ "id", "lojaId", "nome", "tipo", "activa" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ], "format": "uuid" }, "lojaId": { "type": [ "null", "string" ], "format": "uuid" }, "nome": { "type": "string" }, "tipo": { "type": "string" }, "activa": { "type": "boolean" } } }, "GuardarCategoriaCommand": { "required": [ "id", "nome", "icone", "pesoMedioKg", "ordem", "activa" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ], "format": "uuid" }, "nome": { "type": "string" }, "icone": { "type": [ "null", "string" ] }, "pesoMedioKg": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "ordem": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "activa": { "type": "boolean" } } }, "GuardarExtraCommand": { "required": [ "id", "propriedadeId", "nome", "artigoId", "regra", "categoria", "precoPadrao", "activo" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ], "format": "uuid" }, "propriedadeId": { "type": [ "null", "string" ], "format": "uuid" }, "nome": { "type": "string" }, "artigoId": { "type": "string", "format": "uuid" }, "regra": { "type": "string" }, "categoria": { "type": "string" }, "precoPadrao": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "activo": { "type": "boolean" } } }, "GuardarFichaCommand": { "required": [ "clienteId", "documentoTipo", "documentoNumero", "documentoValidade", "nacionalidade", "dataDeNascimento", "morada", "profissao", "preferencias", "vip", "vipMotivo", "listaNegra", "listaNegraMotivo", "notas" ], "type": "object", "properties": { "clienteId": { "type": "string", "format": "uuid" }, "documentoTipo": { "type": [ "null", "string" ] }, "documentoNumero": { "type": [ "null", "string" ] }, "documentoValidade": { "type": [ "null", "string" ], "format": "date" }, "nacionalidade": { "type": [ "null", "string" ] }, "dataDeNascimento": { "type": [ "null", "string" ], "format": "date" }, "morada": { "type": [ "null", "string" ] }, "profissao": { "type": [ "null", "string" ] }, "preferencias": { "type": [ "null", "string" ] }, "vip": { "type": "boolean" }, "vipMotivo": { "type": [ "null", "string" ] }, "listaNegra": { "type": "boolean" }, "listaNegraMotivo": { "type": [ "null", "string" ] }, "notas": { "type": [ "null", "string" ] } } }, "GuardarMaquinaCommand": { "required": [ "id", "lojaId", "nome", "tipo", "capacidadeKg", "activa" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ], "format": "uuid" }, "lojaId": { "type": [ "null", "string" ], "format": "uuid" }, "nome": { "type": "string" }, "tipo": { "$ref": "#/components/schemas/TipoDeMaquina" }, "capacidadeKg": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "activa": { "type": "boolean" } } }, "GuardarOperacaoCommand": { "required": [ "id", "codigo", "nome", "descricaoTecnica", "sistema", "dificuldade", "competencia", "tipoDeTrabalho", "produtoServicoId", "valorFixo", "interna", "garantiaDias", "garantiaKm", "intervaloKm", "intervaloMeses", "perfis", "modeloOrigem", "tempos", "pecas" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ], "format": "uuid" }, "codigo": { "type": "string" }, "nome": { "type": "string" }, "descricaoTecnica": { "type": [ "null", "string" ] }, "sistema": { "type": "string" }, "dificuldade": { "type": "string" }, "competencia": { "type": [ "null", "string" ] }, "tipoDeTrabalho": { "type": "string" }, "produtoServicoId": { "type": [ "null", "string" ], "format": "uuid" }, "valorFixo": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "interna": { "type": "boolean" }, "garantiaDias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "garantiaKm": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "intervaloKm": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "intervaloMeses": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "perfis": { "type": [ "null", "array" ], "items": { "type": "string" } }, "modeloOrigem": { "type": [ "null", "string" ] }, "tempos": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/TempoPadraoInput" } }, "pecas": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/PecaSugeridaInput" } } } }, "GuardarPlanoCommand": { "required": [ "id", "propriedadeId", "nome", "regime", "diasGratuitos", "penalizacao", "percentagemDePenalizacao", "garantiaExigida", "publico", "activo" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ], "format": "uuid" }, "propriedadeId": { "type": [ "null", "string" ], "format": "uuid" }, "nome": { "type": "string" }, "regime": { "type": "string" }, "diasGratuitos": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "penalizacao": { "type": "string" }, "percentagemDePenalizacao": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "garantiaExigida": { "type": "string" }, "publico": { "type": "boolean" }, "activo": { "type": "boolean" } } }, "GuardarPontoDeInspeccaoCommand": { "required": [ "id", "codigo", "nome", "grupo", "unidade", "perfis", "ordem" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ], "format": "uuid" }, "codigo": { "type": "string" }, "nome": { "type": "string" }, "grupo": { "type": "string" }, "unidade": { "type": [ "null", "string" ] }, "perfis": { "type": [ "null", "array" ], "items": { "type": "string" } }, "ordem": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "GuardarPropriedadeCommand": { "required": [ "id", "lojaId", "nome", "categoria", "morada", "telefone", "email", "perfis", "horaDeCheckIn", "horaDeCheckOut", "prazoDoDepositoHoras", "horaDoNightAudit", "creditoDaPartida", "creditoDaEstadia", "creditoDaPreparacao", "activa" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ], "format": "uuid" }, "lojaId": { "type": [ "null", "string" ], "format": "uuid" }, "nome": { "type": "string" }, "categoria": { "type": [ "null", "string" ] }, "morada": { "type": [ "null", "string" ] }, "telefone": { "type": [ "null", "string" ] }, "email": { "type": [ "null", "string" ] }, "perfis": { "type": [ "null", "array" ], "items": { "type": "string" } }, "horaDeCheckIn": { "type": "string" }, "horaDeCheckOut": { "type": "string" }, "prazoDoDepositoHoras": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "horaDoNightAudit": { "type": "string" }, "creditoDaPartida": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "creditoDaEstadia": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "creditoDaPreparacao": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "activa": { "type": "boolean" } } }, "GuardarQuartoCommand": { "required": [ "id", "propriedadeId", "tipoDeQuartoId", "numero", "piso", "caracteristicas", "activo" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ], "format": "uuid" }, "propriedadeId": { "type": [ "null", "string" ], "format": "uuid" }, "tipoDeQuartoId": { "type": "string", "format": "uuid" }, "numero": { "type": "string" }, "piso": { "type": [ "null", "string" ] }, "caracteristicas": { "type": [ "null", "string" ] }, "activo": { "type": "boolean" } } }, "GuardarRecursoCommand": { "required": [ "id", "lojaId", "nome", "tipo", "activo" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ], "format": "uuid" }, "lojaId": { "type": [ "null", "string" ], "format": "uuid" }, "nome": { "type": "string" }, "tipo": { "$ref": "#/components/schemas/TipoDeRecurso" }, "activo": { "type": "boolean" } } }, "GuardarRestricaoCommand": { "required": [ "id", "propriedadeId", "planoId", "tipoDeQuartoId", "de", "ate", "estadiaMinima", "estadiaMaxima", "fechadoAChegada", "fechadoAPartida", "fechadoAVenda", "antecedenciaMinimaDias" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ], "format": "uuid" }, "propriedadeId": { "type": [ "null", "string" ], "format": "uuid" }, "planoId": { "type": [ "null", "string" ], "format": "uuid" }, "tipoDeQuartoId": { "type": [ "null", "string" ], "format": "uuid" }, "de": { "type": "string", "format": "date" }, "ate": { "type": "string", "format": "date" }, "estadiaMinima": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "estadiaMaxima": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "fechadoAChegada": { "type": "boolean" }, "fechadoAPartida": { "type": "boolean" }, "fechadoAVenda": { "type": "boolean" }, "antecedenciaMinimaDias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "GuardarServicoCommand": { "required": [ "id", "produtoId", "nome", "categoria", "descricaoPublica", "marcavelOnline", "antecedenciaMinOnlineMin", "antecedenciaMaxOnlineDias", "deposito", "depositoValor", "bufferAntesMin", "bufferDepoisMin", "preco", "activo", "segmentos", "profissionais", "recursos" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ], "format": "uuid" }, "produtoId": { "type": "string", "format": "uuid" }, "nome": { "type": "string" }, "categoria": { "type": [ "null", "string" ] }, "descricaoPublica": { "type": [ "null", "string" ] }, "marcavelOnline": { "type": "boolean" }, "antecedenciaMinOnlineMin": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "antecedenciaMaxOnlineDias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "deposito": { "$ref": "#/components/schemas/ExigenciaDeDeposito" }, "depositoValor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "bufferAntesMin": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "bufferDepoisMin": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "preco": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "activo": { "type": "boolean" }, "segmentos": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentoInput" } }, "profissionais": { "type": "array", "items": { "$ref": "#/components/schemas/ServicoProfissionalInput" } }, "recursos": { "type": "array", "items": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "exigeAprovacao": { "type": "boolean", "default": false } } }, "GuardarServicoDeLavandariaCommand": { "required": [ "id", "produtoId", "nome", "grupo", "unidade", "lavagem", "secagem", "acabamento", "programa", "prazoHoras", "precoBase", "exigeAceitacaoDeRisco", "activo", "precos" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ], "format": "uuid" }, "produtoId": { "type": "string", "format": "uuid" }, "nome": { "type": "string" }, "grupo": { "type": [ "null", "string" ] }, "unidade": { "$ref": "#/components/schemas/UnidadeDeVenda" }, "lavagem": { "type": "boolean" }, "secagem": { "type": "boolean" }, "acabamento": { "type": "boolean" }, "programa": { "$ref": "#/components/schemas/ProgramaDeLavagem" }, "prazoHoras": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "precoBase": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "exigeAceitacaoDeRisco": { "type": "boolean" }, "activo": { "type": "boolean" }, "precos": { "type": "array", "items": { "$ref": "#/components/schemas/PrecoInput" } } } }, "GuardarTaxaCommand": { "required": [ "id", "propriedadeId", "nome", "artigoId", "base", "valor", "activa" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ], "format": "uuid" }, "propriedadeId": { "type": [ "null", "string" ], "format": "uuid" }, "nome": { "type": "string" }, "artigoId": { "type": "string", "format": "uuid" }, "base": { "type": "string" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "activa": { "type": "boolean" } } }, "GuardarTipoDeQuartoCommand": { "required": [ "id", "propriedadeId", "nome", "adultosMaximo", "criancasMaximo", "camas", "areaM2", "descricao", "artigoDeAlojamentoId", "ordemDeVenda", "overbookingMaximo", "activo" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ], "format": "uuid" }, "propriedadeId": { "type": [ "null", "string" ], "format": "uuid" }, "nome": { "type": "string" }, "adultosMaximo": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "criancasMaximo": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "camas": { "type": [ "null", "string" ] }, "areaM2": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "descricao": { "type": [ "null", "string" ] }, "artigoDeAlojamentoId": { "type": [ "null", "string" ], "format": "uuid" }, "ordemDeVenda": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "overbookingMaximo": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "activo": { "type": "boolean" } } }, "GuardarTipoDeRoupaCommand": { "required": [ "id", "nome", "ordem", "activo" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ], "format": "uuid" }, "nome": { "type": "string" }, "ordem": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "activo": { "type": "boolean" } } }, "GuardarUrgenciaCommand": { "required": [ "id", "nome", "horas", "acrescimoPct", "activa" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ], "format": "uuid" }, "nome": { "type": "string" }, "horas": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "acrescimoPct": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "activa": { "type": "boolean" } } }, "GuardarZonaDePatioCommand": { "required": [ "id", "lojaId", "nome", "ordem", "activa" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ], "format": "uuid" }, "lojaId": { "type": [ "null", "string" ], "format": "uuid" }, "nome": { "type": "string" }, "ordem": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "activa": { "type": "boolean" } } }, "GuiaTransferenciaInternaDto": { "required": [ "id", "produtoId", "produtoNome", "quantidade", "lojaOrigemId", "lojaOrigemNome", "lojaDestinoId", "lojaDestinoNome", "numero", "data", "estado", "usuarioAutorizadorId", "usuarioReceptorId", "dataRecepcao", "hash", "hashControlo", "transferenciaEstoqueId", "reservaEstoqueId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "produtoId": { "type": [ "null", "string" ], "format": "uuid" }, "produtoNome": { "type": [ "null", "string" ] }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "lojaOrigemId": { "type": "string", "format": "uuid" }, "lojaOrigemNome": { "type": "string" }, "lojaDestinoId": { "type": "string", "format": "uuid" }, "lojaDestinoNome": { "type": "string" }, "numero": { "type": "string" }, "data": { "type": "string", "format": "date-time" }, "estado": { "type": "string" }, "usuarioAutorizadorId": { "type": "string", "format": "uuid" }, "usuarioReceptorId": { "type": [ "null", "string" ], "format": "uuid" }, "dataRecepcao": { "type": [ "null", "string" ], "format": "date-time" }, "hash": { "type": "string" }, "hashControlo": { "type": "string" }, "transferenciaEstoqueId": { "type": "string", "format": "uuid" }, "reservaEstoqueId": { "type": [ "null", "string" ], "format": "uuid" } } }, "HistoricoCustoProdutoDto": { "required": [ "id", "custoUnitario", "vigenteDesde", "origem" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "custoUnitario": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "vigenteDesde": { "type": "string", "format": "date-time" }, "origem": { "type": "string" } } }, "HistoricoMovimentoProdutoDto": { "required": [ "data", "armazemDescricao", "loteDescricao", "tipo", "quantidade", "saldoAposMovimento", "documento" ], "type": "object", "properties": { "data": { "type": "string", "format": "date-time" }, "armazemDescricao": { "type": "string" }, "loteDescricao": { "type": [ "null", "string" ] }, "tipo": { "type": "string" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "saldoAposMovimento": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "documento": { "type": [ "null", "string" ] } } }, "HistoricoReservaStockDto": { "required": [ "linhaId", "pedidoId", "numero", "clienteNome", "produtoNome", "unidade", "armazemDescricao", "loteDescricao", "quantidade", "criadoEmUtc", "estado" ], "type": "object", "properties": { "linhaId": { "type": "string", "format": "uuid" }, "pedidoId": { "type": "string", "format": "uuid" }, "numero": { "type": "string" }, "clienteNome": { "type": "string" }, "produtoNome": { "type": "string" }, "unidade": { "type": [ "null", "string" ] }, "armazemDescricao": { "type": "string" }, "loteDescricao": { "type": [ "null", "string" ] }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "criadoEmUtc": { "type": "string", "format": "date-time" }, "estado": { "type": "string" } } }, "IdentidadeDeDocumentoDto": { "required": [ "empresa", "empresaGestora", "rodapeDaMarca", "mostraRodapeDoPlano" ], "type": "object", "properties": { "empresa": { "$ref": "#/components/schemas/EmpresaImpressaoDto" }, "empresaGestora": { "type": "boolean" }, "rodapeDaMarca": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RodapeDaMarcaDto" } ] }, "mostraRodapeDoPlano": { "type": "boolean" } } }, "IFormFile": { "type": "string", "format": "binary" }, "IgnorarSugestoesRequest": { "required": [ "sugestaoIds" ], "type": "object", "properties": { "sugestaoIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "ImpostoDto": { "required": [ "id", "descricao", "taxa", "tipoTaxa" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "descricao": { "type": "string" }, "taxa": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "tipoTaxa": { "type": [ "null", "string" ] } } }, "ImpressaoRegistadaDto": { "required": [ "sequencia", "original", "mencao" ], "type": "object", "properties": { "sequencia": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "original": { "type": "boolean" }, "mencao": { "type": "string" } } }, "IndicadoresTesourariaDto": { "required": [ "de", "ate", "prazoMedioRecebimentoDias", "baseRecebimentos", "prazoMedioPagamentoDias", "basePagamentos", "retencaoSuportada" ], "type": "object", "properties": { "de": { "type": "string", "format": "date" }, "ate": { "type": "string", "format": "date" }, "prazoMedioRecebimentoDias": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "baseRecebimentos": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "prazoMedioPagamentoDias": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "basePagamentos": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "retencaoSuportada": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "recebimentosRegistos": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 }, "pagamentosRegistos": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } }, "IngredienteInput": { "required": [ "ingredienteId", "quantidadePorDose" ], "type": "object", "properties": { "ingredienteId": { "type": "string", "format": "uuid" }, "quantidadePorDose": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "rendimentoPercentual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 100 } } }, "IniciarPedido": { "required": [ "boxId" ], "type": "object", "properties": { "boxId": { "type": [ "null", "string" ], "format": "uuid" } } }, "InspeccaoPedida": { "required": [ "aprovado", "motivo" ], "type": "object", "properties": { "aprovado": { "type": "boolean" }, "motivo": { "type": [ "null", "string" ] } } }, "InspeccaoPedido": { "required": [ "pontoId", "nome", "grupo", "cor", "medicao", "unidade", "nota" ], "type": "object", "properties": { "pontoId": { "type": [ "null", "string" ], "format": "uuid" }, "nome": { "type": [ "null", "string" ] }, "grupo": { "type": [ "null", "string" ] }, "cor": { "type": "string" }, "medicao": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "unidade": { "type": [ "null", "string" ] }, "nota": { "type": [ "null", "string" ] } } }, "ItemDocumentoInput": { "required": [ "produtoId", "quantidade", "precoUnitario", "descontoPercentual" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "precoUnitario": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "descontoPercentual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "descricao": { "type": [ "null", "string" ] }, "unidadeVendaId": { "type": [ "null", "string" ], "format": "uuid" } } }, "ItemDoPlanoPedido": { "required": [ "operacaoId", "descricao", "intervaloKm", "intervaloMeses", "ultimoKm", "ultimaData" ], "type": "object", "properties": { "operacaoId": { "type": [ "null", "string" ], "format": "uuid" }, "descricao": { "type": [ "null", "string" ] }, "intervaloKm": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "intervaloMeses": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "ultimoKm": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "ultimaData": { "type": [ "null", "string" ], "format": "date" } } }, "ItemEntradaEstoqueInput": { "required": [ "produtoId", "loteId", "precoUnitario", "quantidade", "descontoPercentual", "impostoPercentual" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "loteId": { "type": [ "null", "string" ], "format": "uuid" }, "precoUnitario": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "descontoPercentual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "impostoPercentual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "ItemImpressaoDto": { "required": [ "codigoInterno", "descricao", "unidade", "lote", "quantidade", "precoUnitario", "descontoPercentual", "valorDesconto", "subtotal", "impostoPercentual", "valorImposto", "taxaRetencaoPercentual", "valorRetencao", "valorPagar", "motivoIsencao", "codigoIsencao" ], "type": "object", "properties": { "codigoInterno": { "type": [ "null", "string" ] }, "descricao": { "type": "string" }, "unidade": { "type": [ "null", "string" ] }, "lote": { "type": [ "null", "string" ] }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "precoUnitario": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "descontoPercentual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorDesconto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "subtotal": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "impostoPercentual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorImposto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "taxaRetencaoPercentual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorRetencao": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorPagar": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "motivoIsencao": { "type": [ "null", "string" ] }, "codigoIsencao": { "type": [ "null", "string" ] }, "unidadeVendida": { "type": [ "null", "string" ] }, "promocaoNome": { "type": [ "null", "string" ] }, "descontoPromocao": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "oferta": { "type": "boolean", "default": false } } }, "ItemNotaCreditoInput": { "required": [ "documentoItemId", "quantidade" ], "type": "object", "properties": { "documentoItemId": { "type": "string", "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "ItemNotaEncomendaInput": { "required": [ "produtoId", "quantidade" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "fornecedorId": { "type": [ "null", "string" ], "format": "uuid" } } }, "ItemPackPromocao": { "required": [ "produtoId", "quantidade" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "ItemPedido": { "required": [ "tipo", "categoriaId", "tipoDeRoupaId", "descricao", "cor", "pesoKg", "quantidadeDePecas", "servicosIds", "estadoNaEntrada", "objectosEncontrados", "valorDeclarado", "aceitouRisco", "instrucoes" ], "type": "object", "properties": { "tipo": { "$ref": "#/components/schemas/TipoDeItem" }, "categoriaId": { "type": [ "null", "string" ], "format": "uuid" }, "tipoDeRoupaId": { "type": [ "null", "string" ], "format": "uuid" }, "descricao": { "type": "string" }, "cor": { "$ref": "#/components/schemas/CorDaRoupa" }, "pesoKg": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "quantidadeDePecas": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "servicosIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "estadoNaEntrada": { "type": [ "null", "string" ] }, "objectosEncontrados": { "type": [ "null", "string" ] }, "valorDeclarado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "aceitouRisco": { "type": "boolean" }, "instrucoes": { "type": [ "null", "string" ] } } }, "ItemReservaStockInput": { "required": [ "produtoId", "armazemId", "loteId", "quantidade" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "armazemId": { "type": "string", "format": "uuid" }, "loteId": { "type": [ "null", "string" ], "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "ItemTransferenciaEstoqueInput": { "required": [ "produtoId", "quantidade" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "loteId": { "type": [ "null", "string" ], "format": "uuid" } } }, "JanelaInput": { "required": [ "dia", "inicio", "fim" ], "type": "object", "properties": { "dia": { "$ref": "#/components/schemas/DayOfWeek" }, "inicio": { "type": "string" }, "fim": { "type": "string" } } }, "JuntarMesasRequest": { "required": [ "mesaIds" ], "type": "object", "properties": { "mesaIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "KitPedido": { "required": [ "lojaId", "codigo", "nome", "activo" ], "type": "object", "properties": { "lojaId": { "type": [ "null", "string" ], "format": "uuid" }, "codigo": { "type": [ "null", "string" ] }, "nome": { "type": [ "null", "string" ] }, "activo": { "type": [ "null", "boolean" ] } } }, "KmPedido": { "required": [ "km", "origem", "justificacao" ], "type": "object", "properties": { "km": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "origem": { "type": [ "null", "string" ] }, "justificacao": { "type": [ "null", "string" ] } } }, "LancamentoPedido": { "required": [ "extraId", "artigoId", "descricao", "quantidade", "precoUnitario", "categoria", "janela" ], "type": "object", "properties": { "extraId": { "type": [ "null", "string" ], "format": "uuid" }, "artigoId": { "type": [ "null", "string" ], "format": "uuid" }, "descricao": { "type": [ "null", "string" ] }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "precoUnitario": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "categoria": { "type": [ "null", "string" ] }, "janela": { "type": [ "null", "string" ] } } }, "LancamentoRecorrenteDto": { "required": [ "id", "cicloData", "executadaEmUtc", "estado", "contaAPagarId", "contaNumero", "erro" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "cicloData": { "type": "string", "format": "date" }, "executadaEmUtc": { "type": "string", "format": "date-time" }, "estado": { "type": "string" }, "contaAPagarId": { "type": [ "null", "string" ], "format": "uuid" }, "contaNumero": { "type": [ "null", "string" ] }, "erro": { "type": [ "null", "string" ] } } }, "LancarItemRequest": { "required": [ "produtoId" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 1 }, "observacao": { "type": [ "null", "string" ] }, "lugar": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "fase": { "$ref": "#/components/schemas/FaseDoServico" }, "precoUnitario": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "opcaoIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } }, "LeituraPedido": { "required": [ "codigo", "marcacaoId", "profissionalId" ], "type": "object", "properties": { "codigo": { "type": [ "null", "string" ] }, "marcacaoId": { "type": [ "null", "string" ], "format": "uuid" }, "profissionalId": { "type": [ "null", "string" ], "format": "uuid" } } }, "LevantamentoPedido": { "required": [ "entregaId", "itensIds", "pagamentos", "levantadoPor" ], "type": "object", "properties": { "entregaId": { "type": "string", "format": "uuid" }, "itensIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "pagamentos": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/PagamentoDoLevantamento" } }, "levantadoPor": { "type": [ "null", "string" ] } } }, "LibertarLoteRequest": { "required": [ "armazemDeQuarentenaId" ], "type": "object", "properties": { "armazemDeQuarentenaId": { "type": "string", "format": "uuid" }, "armazemDestinoId": { "type": [ "null", "string" ], "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "motivo": { "type": [ "null", "string" ] } } }, "LimiteIsencaoRubrica": { "enum": [ "Nenhum", "SubsidioAlimentacao", "SubsidioTransporte" ] }, "LimitePedido": { "required": [ "limiteDeCredito" ], "type": "object", "properties": { "limiteDeCredito": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "LinhaACobrar": { "required": [ "itemId", "quantidade" ], "type": "object", "properties": { "itemId": { "type": "string", "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "LinhaAvencaInput": { "required": [ "produtoId", "descricao", "quantidade", "precoUnitario" ], "type": "object", "properties": { "produtoId": { "type": [ "null", "string" ], "format": "uuid" }, "descricao": { "type": "string" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "precoUnitario": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "impostoId": { "type": [ "null", "string" ], "format": "uuid" }, "motivoIsencaoIvaId": { "type": [ "null", "string" ], "format": "uuid" }, "taxaRetencaoId": { "type": [ "null", "string" ], "format": "uuid" } } }, "LinhaComposicaoInput": { "required": [ "produtoAssociadoId", "quantidade", "precoUnitario" ], "type": "object", "properties": { "produtoAssociadoId": { "type": "string", "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "precoUnitario": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "LinhaDaFichaInput": { "required": [ "produtoId", "quantidade" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "quebraPercentual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "unidadeId": { "type": [ "null", "string" ], "format": "uuid" }, "factor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 1 }, "opcional": { "type": "boolean", "default": false } } }, "LinhaDeProcuraInput": { "required": [ "produtoId", "quantidade", "dataDeEntrega" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "dataDeEntrega": { "type": "string", "format": "date" }, "origem": { "type": [ "null", "string" ] }, "referencia": { "type": [ "null", "string" ] }, "observacao": { "type": [ "null", "string" ] } } }, "LinhaInput": { "required": [ "produtoId", "descricao", "quantidade", "precoUnitario" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "descricao": { "type": [ "null", "string" ] }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "precoUnitario": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "LinhaMapaFornecedorDto": { "required": [ "numeroOrdem", "nifEmAngola", "nif", "nome", "tipoDocumento", "data", "numeroDocumento", "valorFactura", "valorTributavel", "ivaSuportado" ], "type": "object", "properties": { "numeroOrdem": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "nifEmAngola": { "type": "string" }, "nif": { "type": "string" }, "nome": { "type": "string" }, "tipoDocumento": { "type": "string" }, "data": { "type": "string", "format": "date" }, "numeroDocumento": { "type": "string" }, "valorFactura": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorTributavel": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "ivaSuportado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "LinhaPedido": { "required": [ "tipo", "descricao", "produtoId", "operacaoId", "quantidade", "precoUnitario", "descontoPct", "origem" ], "type": "object", "properties": { "tipo": { "type": "string" }, "descricao": { "type": [ "null", "string" ] }, "produtoId": { "type": [ "null", "string" ], "format": "uuid" }, "operacaoId": { "type": [ "null", "string" ], "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "precoUnitario": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "descontoPct": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "origem": { "type": [ "null", "string" ] } } }, "LinhaReservaStockDto": { "required": [ "id", "produtoId", "produtoNome", "unidade", "armazemId", "armazemDescricao", "loteId", "loteDescricao", "quantidade" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "produtoId": { "type": "string", "format": "uuid" }, "produtoNome": { "type": "string" }, "unidade": { "type": [ "null", "string" ] }, "armazemId": { "type": "string", "format": "uuid" }, "armazemDescricao": { "type": "string" }, "loteId": { "type": [ "null", "string" ], "format": "uuid" }, "loteDescricao": { "type": [ "null", "string" ] }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "LinhaSaftComprasDto": { "required": [ "tipo", "data", "numeroDocumento", "fornecedorNif", "fornecedorNome", "valorTotal", "iva", "natureza", "percentagemDedutivel", "ivaDedutivel" ], "type": "object", "properties": { "tipo": { "type": "string" }, "data": { "type": "string", "format": "date" }, "numeroDocumento": { "type": "string" }, "fornecedorNif": { "type": "string" }, "fornecedorNome": { "type": "string" }, "valorTotal": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "iva": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "natureza": { "type": [ "null", "string" ] }, "percentagemDedutivel": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "ivaDedutivel": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "LinhaSaftInventarioDto": { "required": [ "tipo", "productCode", "productDescription", "quantity", "unitOfMeasure", "valor" ], "type": "object", "properties": { "tipo": { "type": "string" }, "productCode": { "type": "string" }, "productDescription": { "type": "string" }, "quantity": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "unitOfMeasure": { "type": "string" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "LinhaSimulacao": { "required": [ "produtoId", "quantidade" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "unidadeVendaId": { "type": [ "null", "string" ], "format": "uuid" }, "precoUnitario": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "descontoManualPercentual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 } } }, "LinhaUnidadeVendaInput": { "required": [ "unidadeId", "factor" ], "type": "object", "properties": { "unidadeId": { "type": "string", "format": "uuid" }, "factor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "pvp1": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "pvp2": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "pvp3": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "pvp4": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "LiquidacaoDto": { "required": [ "id", "documentoLiquidadoId", "numeroDocumentoLiquidado", "valor", "dataDocumentoLiquidado", "totalDocumentoLiquidado", "totalRetencaoDocumentoLiquidado", "totalImpostoDocumentoLiquidado", "totalPagoAposEsta", "totalEmFaltaAposEsta" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "documentoLiquidadoId": { "type": "string", "format": "uuid" }, "numeroDocumentoLiquidado": { "type": "string" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "dataDocumentoLiquidado": { "type": "string", "format": "date-time" }, "totalDocumentoLiquidado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalRetencaoDocumentoLiquidado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalImpostoDocumentoLiquidado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalPagoAposEsta": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalEmFaltaAposEsta": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "LiquidacaoInput": { "required": [ "documentoId", "valor" ], "type": "object", "properties": { "documentoId": { "type": "string", "format": "uuid" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "LojaDto": { "required": [ "id", "nome", "codigo", "endereco", "limiteAlertaSaldoGaveta", "toleranciaQuebraFechoCaixa", "fechamentoCegoActivo" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "nome": { "type": "string" }, "codigo": { "type": "string" }, "endereco": { "type": [ "null", "string" ] }, "limiteAlertaSaldoGaveta": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "toleranciaQuebraFechoCaixa": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "fechamentoCegoActivo": { "type": "boolean" }, "municipioId": { "type": [ "null", "string" ], "format": "uuid" } } }, "LoteDoAcabadoInput": { "type": "object", "properties": { "loteId": { "type": [ "null", "string" ], "format": "uuid" }, "novoLoteDescricao": { "type": [ "null", "string" ] }, "novoLoteValidade": { "type": [ "null", "string" ], "format": "date-time" } } }, "LoteDto": { "required": [ "id", "descricao", "validade" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "descricao": { "type": "string" }, "validade": { "type": [ "null", "string" ], "format": "date-time" } } }, "LoteTransferenciaDto": { "required": [ "loteId", "descricao", "validade", "disponivel" ], "type": "object", "properties": { "loteId": { "type": "string", "format": "uuid" }, "descricao": { "type": "string" }, "validade": { "type": [ "null", "string" ], "format": "date-time" }, "disponivel": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "MapaDto": { "required": [ "codigo", "titulo", "nota", "inicio", "fim", "colunas", "linhas", "totais", "truncado" ], "type": "object", "properties": { "codigo": { "type": "string" }, "titulo": { "type": "string" }, "nota": { "type": [ "null", "string" ] }, "inicio": { "type": "string", "format": "date" }, "fim": { "type": "string", "format": "date" }, "colunas": { "type": "array", "items": { "$ref": "#/components/schemas/ColunaMapaDto" } }, "linhas": { "type": "array", "items": { "type": "object" } }, "totais": { "type": "array", "items": { "$ref": "#/components/schemas/TotalMapaDto" } }, "truncado": { "type": "boolean" } } }, "MapaFornecedoresDto": { "required": [ "nifContribuinte", "periodo", "linhas", "totalValorFactura", "totalValorTributavel", "totalIvaSuportado", "despesasSemDocumento", "valorDespesasSemDocumento", "perguntasPorConfirmar", "avisos" ], "type": "object", "properties": { "nifContribuinte": { "type": "string" }, "periodo": { "type": "string" }, "linhas": { "type": "array", "items": { "$ref": "#/components/schemas/LinhaMapaFornecedorDto" } }, "totalValorFactura": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalValorTributavel": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalIvaSuportado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "despesasSemDocumento": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "valorDespesasSemDocumento": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "perguntasPorConfirmar": { "type": "array", "items": { "type": "string" } }, "avisos": { "type": "array", "items": { "type": "string" } } } }, "MarcacaoManualRequest": { "required": [ "funcionarioId", "dataHoraLocal", "tipo", "motivo" ], "type": "object", "properties": { "funcionarioId": { "type": "string", "format": "uuid" }, "dataHoraLocal": { "type": "string", "format": "date-time" }, "tipo": { "$ref": "#/components/schemas/TipoMarcacaoPonto" }, "motivo": { "type": "string" } } }, "MarcaEquipamentoPonto": { "enum": [ "Hikvision", "ZKTeco", "Outro" ] }, "MarcarFeriasCommand": { "required": [ "funcionarioId", "ano", "dataInicio", "dataFim", "observacao" ], "type": "object", "properties": { "funcionarioId": { "type": "string", "format": "uuid" }, "ano": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "dataInicio": { "type": "string", "format": "date" }, "dataFim": { "type": "string", "format": "date" }, "observacao": { "type": [ "null", "string" ] } } }, "MarcarReporteRequest": { "required": [ "referencia" ], "type": "object", "properties": { "referencia": { "type": [ "null", "string" ] } } }, "MedicaoInput": { "required": [ "pontoId" ], "type": "object", "properties": { "pontoId": { "type": "string", "format": "uuid" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "passou": { "type": [ "null", "boolean" ] } } }, "MetodoPagamentoDto": { "required": [ "id", "descricao", "tipoLancamento", "pedirComprovativo", "aceitaContaCorrente", "activo" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "descricao": { "type": "string" }, "tipoLancamento": { "type": "string" }, "pedirComprovativo": { "type": "boolean" }, "aceitaContaCorrente": { "type": "boolean" }, "activo": { "type": "boolean" } } }, "MinibarPedido": { "required": [ "quartoId", "extraId", "quantidade" ], "type": "object", "properties": { "quartoId": { "type": "string", "format": "uuid" }, "extraId": { "type": "string", "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "ModeloInput": { "required": [ "nome", "sentido", "tipo", "descricao", "clausulas", "duracaoEmMeses", "preAvisoDias", "renovacao", "renovacaoMeses", "revisao", "percentagemDeRevisao", "prazoPagamentoDias", "frequencia", "diaDeEmissao", "antecipada", "prazoMinimoDePagamentoDias", "valorAnualMinimo" ], "type": "object", "properties": { "nome": { "type": "string" }, "sentido": { "$ref": "#/components/schemas/SentidoDoContrato" }, "tipo": { "$ref": "#/components/schemas/TipoDeContrato" }, "descricao": { "type": [ "null", "string" ] }, "clausulas": { "type": [ "null", "string" ] }, "duracaoEmMeses": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "preAvisoDias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "renovacao": { "$ref": "#/components/schemas/RenovacaoDoContrato" }, "renovacaoMeses": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "revisao": { "$ref": "#/components/schemas/RevisaoDePreco" }, "percentagemDeRevisao": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "prazoPagamentoDias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "frequencia": { "$ref": "#/components/schemas/FrequenciaDoPlano" }, "diaDeEmissao": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "antecipada": { "type": "boolean" }, "prazoMinimoDePagamentoDias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "valorAnualMinimo": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "activo": { "type": "boolean", "default": true } } }, "ModoDesconto": { "enum": [ "PrestacoesFixas", "PercentagemDoSalario" ] }, "ModoSubsidioExtraordinario": { "enum": [ "Integral", "Duodecimos" ] }, "ModoValorDiuturnidade": { "enum": [ "Fixo", "PercentagemDoSalarioBase" ] }, "MoedaDto": { "required": [ "id", "codigo", "nome", "simbolo", "activo" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "codigo": { "type": "string" }, "nome": { "type": "string" }, "simbolo": { "type": "string" }, "activo": { "type": "boolean" } } }, "MomentoDaFoto": { "enum": [ "Entrada", "Saida", "Incidente" ] }, "MotivoArquivamento": { "enum": [ "Caducidade", "Improcedencia", "Cancelamento" ] }, "MotivoCessacao": { "enum": [ "AcordoMutuo", "CaducidadeDoContrato", "DespedimentoPorJustaCausa", "DespedimentoPorExtincaoDoPosto", "DemissaoDoTrabalhador", "PeriodoExperimental", "Reforma", "Falecimento", "Outro" ] }, "MotivoDeCancelamento": { "enum": [ "ErroDeLancamento", "ClienteDesistiu", "CozinhaSemStock", "Cortesia" ] }, "MotivoIsencaoIvaDto": { "required": [ "id", "codigoInterno", "motivo", "mencaoFactura", "normaLegalAplicavel" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "codigoInterno": { "type": "string" }, "motivo": { "type": "string" }, "mencaoFactura": { "type": [ "null", "string" ] }, "normaLegalAplicavel": { "type": [ "null", "string" ] } } }, "MotivoPedido": { "required": [ "motivo" ], "type": "object", "properties": { "motivo": { "type": "string" } } }, "MotivoRequest": { "type": "object", "properties": { "motivo": { "type": [ "null", "string" ] } } }, "MoverItensRequest": { "required": [ "itemIds" ], "type": "object", "properties": { "itemIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "MovimentoClienteDto": { "required": [ "id", "data", "valor", "tipo", "documento", "saldoAposMovimento" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "data": { "type": "string", "format": "date-time" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "tipo": { "type": "string" }, "documento": { "type": [ "null", "string" ] }, "saldoAposMovimento": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "MovimentoDescontoRequest": { "required": [ "tipo", "valor", "data", "motivo" ], "type": "object", "properties": { "tipo": { "$ref": "#/components/schemas/TipoMovimentoDesconto" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "data": { "type": "string", "format": "date" }, "motivo": { "type": "string" } } }, "MovimentoParaConciliarDto": { "required": [ "id", "data", "tipo", "categoria", "valor", "metodoPagamentoDescricao", "documento" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "data": { "type": "string", "format": "date-time" }, "tipo": { "type": "string" }, "categoria": { "type": "string" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "metodoPagamentoDescricao": { "type": [ "null", "string" ] }, "documento": { "type": [ "null", "string" ] } } }, "MunicipioDto": { "required": [ "id", "provinciaId", "nome" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "provinciaId": { "type": "string", "format": "uuid" }, "nome": { "type": "string" } } }, "NaturezaCompraFiscal": { "enum": [ "MFI", "INV", "OBC", "SERV", "IMPT", "SCE", null ] }, "NaturezaRubrica": { "enum": [ "Provento", "Desconto" ] }, "NivelAcademico": { "enum": [ "EnsinoPrimario", "PrimeiroCicloSecundario", "SegundoCicloSecundario", "EnsinoMedioTecnico", "Bacharelato", "Licenciatura", "PosGraduacao", "Mestrado", "Doutoramento", "Outro" ] }, "NivelPreco": { "enum": [ "Pvp1", "Pvp2", "Pvp3", "Pvp4", null ] }, "NivelQualificacao": { "enum": [ "NaoQualificado", "Qualificado", "TecnicoMedio", "TecnicoSuperior", "Chefia" ] }, "NomeDoGrupoRequest": { "required": [ "nome" ], "type": "object", "properties": { "nome": { "type": "string" } } }, "NomeRequest": { "required": [ "nome" ], "type": "object", "properties": { "nome": { "type": "string" } } }, "NotaCreditoFornecedorDto": { "required": [ "id", "numero", "data", "baseTributavel", "ivaSuportado", "valor", "motivo", "criadaEmUtc" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "numero": { "type": "string" }, "data": { "type": "string", "format": "date-time" }, "baseTributavel": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "ivaSuportado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "motivo": { "type": "string" }, "criadaEmUtc": { "type": "string", "format": "date-time" }, "valorEmCredito": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 } } }, "NotaPedido": { "required": [ "nota" ], "type": "object", "properties": { "nota": { "type": [ "null", "string" ] } } }, "NotasRequest": { "type": "object", "properties": { "notas": { "type": [ "null", "string" ] } } }, "NovaAccaoRequest": { "required": [ "descricao" ], "type": "object", "properties": { "descricao": { "type": "string" }, "responsavel": { "type": [ "null", "string" ] }, "prazo": { "type": [ "null", "string" ], "format": "date" } } }, "NumeroProcessoRequest": { "required": [ "numeroProcesso" ], "type": "object", "properties": { "numeroProcesso": { "type": [ "null", "string" ] } } }, "OcupantePedido": { "required": [ "nome", "ehCrianca", "documentoTipo", "documentoNumero", "nacionalidade", "dataDeNascimento" ], "type": "object", "properties": { "nome": { "type": "string" }, "ehCrianca": { "type": "boolean" }, "documentoTipo": { "type": [ "null", "string" ] }, "documentoNumero": { "type": [ "null", "string" ] }, "nacionalidade": { "type": [ "null", "string" ] }, "dataDeNascimento": { "type": [ "null", "string" ], "format": "date" } } }, "OpcaoFiscalDto": { "required": [ "codigo", "rotulo" ], "type": "object", "properties": { "codigo": { "type": "string" }, "rotulo": { "type": "string" } } }, "OpcaoInput": { "required": [ "id", "nome" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ], "format": "uuid" }, "nome": { "type": "string" }, "produtoExtraId": { "type": [ "null", "string" ], "format": "uuid" }, "ordem": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 }, "activa": { "type": "boolean", "default": true } } }, "OperacaoDaFichaInput": { "required": [ "nome" ], "type": "object", "properties": { "nome": { "type": "string" }, "centroDeTrabalhoId": { "type": [ "null", "string" ], "format": "uuid" }, "tempoDePreparacaoMinutos": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "tempoDeExecucaoMinutos": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 } } }, "OrigemContaAPagar": { "enum": [ "CompraEstoque", "Despesa", null ] }, "OrigemDaMarcacao": { "enum": [ "Recepcao", "Telefone", "Online", "WhatsApp", "App", "FilaDeEspera", "ListaDeEspera", "Reactivacao", "Recorrencia" ] }, "OrigemDireitoFerias": { "enum": [ "DireitoDoAno", "Acordo", "Ajuste" ] }, "PagamentoContaAPagarDto": { "required": [ "id", "tipo", "metodoPagamentoId", "metodoPagamentoDescricao", "valor", "juros", "desconto", "valorEfectivo", "data", "numeroOperacaoBancaria", "dataOperacaoBancaria", "motivo", "estornoDoPagamentoId", "estornado", "registadoEmUtc" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "tipo": { "type": "string" }, "metodoPagamentoId": { "type": "string", "format": "uuid" }, "metodoPagamentoDescricao": { "type": "string" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "juros": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "desconto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorEfectivo": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "data": { "type": "string", "format": "date-time" }, "numeroOperacaoBancaria": { "type": [ "null", "string" ] }, "dataOperacaoBancaria": { "type": [ "null", "string" ], "format": "date-time" }, "motivo": { "type": [ "null", "string" ] }, "estornoDoPagamentoId": { "type": [ "null", "string" ], "format": "uuid" }, "estornado": { "type": "boolean" }, "registadoEmUtc": { "type": "string", "format": "date-time" } } }, "PagamentoDaContaInput": { "required": [ "metodoPagamentoId", "valor" ], "type": "object", "properties": { "metodoPagamentoId": { "type": "string", "format": "uuid" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "PagamentoDaEntrega": { "required": [ "metodoPagamentoId", "valor" ], "type": "object", "properties": { "metodoPagamentoId": { "type": "string", "format": "uuid" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "PagamentoDaFacturacao": { "required": [ "metodoPagamentoId", "valor" ], "type": "object", "properties": { "metodoPagamentoId": { "type": "string", "format": "uuid" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "PagamentoDocumentoInput": { "required": [ "metodoPagamentoId", "valor" ], "type": "object", "properties": { "metodoPagamentoId": { "type": "string", "format": "uuid" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "numeroOperacaoBancaria": { "type": [ "null", "string" ] }, "dataOperacaoBancaria": { "type": [ "null", "string" ], "format": "date-time" } } }, "PagamentoDoLevantamento": { "required": [ "metodoPagamentoId", "valor" ], "type": "object", "properties": { "metodoPagamentoId": { "type": "string", "format": "uuid" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "PagamentoDto": { "required": [ "id", "metodoPagamentoId", "valor", "tipoLancamento", "data", "numeroOperacaoBancaria", "dataOperacaoBancaria" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "metodoPagamentoId": { "type": "string", "format": "uuid" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "tipoLancamento": { "type": "string" }, "data": { "type": "string", "format": "date-time" }, "numeroOperacaoBancaria": { "type": [ "null", "string" ] }, "dataOperacaoBancaria": { "type": [ "null", "string" ], "format": "date-time" }, "metodoDescricao": { "type": [ "null", "string" ] } } }, "PagamentoEntradaEstoqueDto": { "required": [ "id", "metodoPagamentoId", "metodoPagamentoDescricao", "valor", "data" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "metodoPagamentoId": { "type": "string", "format": "uuid" }, "metodoPagamentoDescricao": { "type": "string" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "data": { "type": "string", "format": "date-time" } } }, "PagamentoImpressaoDto": { "required": [ "metodo", "valor", "numeroOperacaoBancaria", "dataOperacaoBancaria" ], "type": "object", "properties": { "metodo": { "type": "string" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "numeroOperacaoBancaria": { "type": [ "null", "string" ] }, "dataOperacaoBancaria": { "type": [ "null", "string" ], "format": "date-time" } } }, "PagamentoRecebidoDto": { "required": [ "documentoId", "documentoNumero", "data", "valor", "metodo", "operador", "observacao" ], "type": "object", "properties": { "documentoId": { "type": "string", "format": "uuid" }, "documentoNumero": { "type": "string" }, "data": { "type": "string", "format": "date-time" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "metodo": { "type": "string" }, "operador": { "type": [ "null", "string" ] }, "observacao": { "type": [ "null", "string" ] } } }, "PagamentoRelatorioDto": { "required": [ "data", "documento", "tipoDocumento", "metodo", "valor", "sentido", "usuarioId" ], "type": "object", "properties": { "data": { "type": "string", "format": "date-time" }, "documento": { "type": "string" }, "tipoDocumento": { "type": "string" }, "metodo": { "type": "string" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "sentido": { "type": "string" }, "usuarioId": { "type": [ "null", "string" ], "format": "uuid" } } }, "PaginaResultadoOfArmazemDto": { "required": [ "itens", "proximoCursor" ], "type": "object", "properties": { "itens": { "type": "array", "items": { "$ref": "#/components/schemas/ArmazemDto" } }, "proximoCursor": { "type": [ "null", "string" ] } } }, "PaginaResultadoOfCatalogoItemDto": { "required": [ "itens", "proximoCursor" ], "type": "object", "properties": { "itens": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogoItemDto" } }, "proximoCursor": { "type": [ "null", "string" ] } } }, "PaginaResultadoOfClienteResumoDto": { "required": [ "itens", "proximoCursor" ], "type": "object", "properties": { "itens": { "type": "array", "items": { "$ref": "#/components/schemas/ClienteResumoDto" } }, "proximoCursor": { "type": [ "null", "string" ] } } }, "PaginaResultadoOfContaAPagarDto": { "required": [ "itens", "proximoCursor" ], "type": "object", "properties": { "itens": { "type": "array", "items": { "$ref": "#/components/schemas/ContaAPagarDto" } }, "proximoCursor": { "type": [ "null", "string" ] } } }, "PaginaResultadoOfContaAReceberDto": { "required": [ "itens", "proximoCursor" ], "type": "object", "properties": { "itens": { "type": "array", "items": { "$ref": "#/components/schemas/ContaAReceberDto" } }, "proximoCursor": { "type": [ "null", "string" ] } } }, "PaginaResultadoOfDocumentoDto": { "required": [ "itens", "proximoCursor" ], "type": "object", "properties": { "itens": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentoDto" } }, "proximoCursor": { "type": [ "null", "string" ] } } }, "PaginaResultadoOfDocumentoEmitidoDto": { "required": [ "itens", "proximoCursor" ], "type": "object", "properties": { "itens": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentoEmitidoDto" } }, "proximoCursor": { "type": [ "null", "string" ] } } }, "PaginaResultadoOfEntradaEstoqueResumoDto": { "required": [ "itens", "proximoCursor" ], "type": "object", "properties": { "itens": { "type": "array", "items": { "$ref": "#/components/schemas/EntradaEstoqueResumoDto" } }, "proximoCursor": { "type": [ "null", "string" ] } } }, "PaginaResultadoOfFornecedorResumoDto": { "required": [ "itens", "proximoCursor" ], "type": "object", "properties": { "itens": { "type": "array", "items": { "$ref": "#/components/schemas/FornecedorResumoDto" } }, "proximoCursor": { "type": [ "null", "string" ] } } }, "PaginaResultadoOfLoteDto": { "required": [ "itens", "proximoCursor" ], "type": "object", "properties": { "itens": { "type": "array", "items": { "$ref": "#/components/schemas/LoteDto" } }, "proximoCursor": { "type": [ "null", "string" ] } } }, "PaginaResultadoOfMovimentoClienteDto": { "required": [ "itens", "proximoCursor" ], "type": "object", "properties": { "itens": { "type": "array", "items": { "$ref": "#/components/schemas/MovimentoClienteDto" } }, "proximoCursor": { "type": [ "null", "string" ] } } }, "PaginaResultadoOfPedidoReservaStockActivoDto": { "required": [ "itens", "proximoCursor" ], "type": "object", "properties": { "itens": { "type": "array", "items": { "$ref": "#/components/schemas/PedidoReservaStockActivoDto" } }, "proximoCursor": { "type": [ "null", "string" ] } } }, "PaginaResultadoOfProdutoBaixoEstoqueDto": { "required": [ "itens", "proximoCursor" ], "type": "object", "properties": { "itens": { "type": "array", "items": { "$ref": "#/components/schemas/ProdutoBaixoEstoqueDto" } }, "proximoCursor": { "type": [ "null", "string" ] } } }, "PaginaResultadoOfProdutoResumoDto": { "required": [ "itens", "proximoCursor" ], "type": "object", "properties": { "itens": { "type": "array", "items": { "$ref": "#/components/schemas/ProdutoResumoDto" } }, "proximoCursor": { "type": [ "null", "string" ] } } }, "PaginaResultadoOfProdutoVendaDto": { "required": [ "itens", "proximoCursor" ], "type": "object", "properties": { "itens": { "type": "array", "items": { "$ref": "#/components/schemas/ProdutoVendaDto" } }, "proximoCursor": { "type": [ "null", "string" ] } } }, "PaginaResultadoOfSaidaManualEstoqueDto": { "required": [ "itens", "proximoCursor" ], "type": "object", "properties": { "itens": { "type": "array", "items": { "$ref": "#/components/schemas/SaidaManualEstoqueDto" } }, "proximoCursor": { "type": [ "null", "string" ] } } }, "PaginaResultadoOfSaldoEstoqueDto": { "required": [ "itens", "proximoCursor" ], "type": "object", "properties": { "itens": { "type": "array", "items": { "$ref": "#/components/schemas/SaldoEstoqueDto" } }, "proximoCursor": { "type": [ "null", "string" ] } } }, "PaginaResultadoOfTransferenciaEstoqueResumoDto": { "required": [ "itens", "proximoCursor" ], "type": "object", "properties": { "itens": { "type": "array", "items": { "$ref": "#/components/schemas/TransferenciaEstoqueResumoDto" } }, "proximoCursor": { "type": [ "null", "string" ] } } }, "ParametroAcordoRequest": { "required": [ "codigo", "dimensao", "valor", "vigenteDesde", "clausula" ], "type": "object", "properties": { "codigo": { "$ref": "#/components/schemas/CodigoParametroLegal" }, "dimensao": { "type": [ "null", "string" ] }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "vigenteDesde": { "type": "string", "format": "date" }, "clausula": { "type": "string" } } }, "ParametrosDePlaneamentoRequest": { "required": [ "politica" ], "type": "object", "properties": { "politica": { "type": "string" }, "prazoDeEntregaDias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 }, "loteMinimo": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "multiplo": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "stockDeSeguranca": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 } } }, "ParentescoDependente": { "enum": [ "Filho", "Conjuge", "Ascendente", "DependenteIncapacitado" ] }, "PatioPedido": { "required": [ "zonaDePatioId", "lugarNoPatio", "chaveCodigo" ], "type": "object", "properties": { "zonaDePatioId": { "type": [ "null", "string" ], "format": "uuid" }, "lugarNoPatio": { "type": [ "null", "string" ] }, "chaveCodigo": { "type": [ "null", "string" ] } } }, "PausaPedido": { "required": [ "motivo" ], "type": "object", "properties": { "motivo": { "type": "string" } } }, "PecaEmFaltaPedido": { "required": [ "emFalta", "previstaPara", "nota" ], "type": "object", "properties": { "emFalta": { "type": "boolean" }, "previstaPara": { "type": [ "null", "string" ], "format": "date" }, "nota": { "type": [ "null", "string" ] } } }, "PecaSugeridaInput": { "required": [ "produtoId", "quantidade" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "PedidoReservaStockActivoDto": { "required": [ "id", "numero", "clienteId", "clienteNome", "criadoEmUtc", "expiraEmUtc", "observacao" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "numero": { "type": "string" }, "clienteId": { "type": "string", "format": "uuid" }, "clienteNome": { "type": "string" }, "criadoEmUtc": { "type": "string", "format": "date-time" }, "expiraEmUtc": { "type": "string", "format": "date-time" }, "observacao": { "type": [ "null", "string" ] }, "linhas": { "type": "array", "items": { "$ref": "#/components/schemas/LinhaReservaStockDto" } } } }, "PedirCancelamentoRequest": { "required": [ "motivo" ], "type": "object", "properties": { "motivo": { "$ref": "#/components/schemas/MotivoDeCancelamento" } } }, "PendenteRelatorioDto": { "required": [ "id", "numero", "data", "clienteId", "clienteNome", "numeroContribuinte", "totalGeral", "pago", "porPagar", "diasEmAberto", "escalao" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "numero": { "type": "string" }, "data": { "type": "string", "format": "date-time" }, "clienteId": { "type": "string", "format": "uuid" }, "clienteNome": { "type": "string" }, "numeroContribuinte": { "type": [ "null", "string" ] }, "totalGeral": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "pago": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "porPagar": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "diasEmAberto": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "escalao": { "type": "string" } } }, "PerfilCapilar": { "required": [ "textura", "densidade", "porosidade", "comprimento", "estado", "corNatural", "corActual", "brancosPct", "couroCabeludo", "queda", "historicoDeQuimica" ], "type": "object", "properties": { "textura": { "type": [ "null", "string" ] }, "densidade": { "type": [ "null", "string" ] }, "porosidade": { "type": [ "null", "string" ] }, "comprimento": { "type": [ "null", "string" ] }, "estado": { "type": [ "null", "string" ] }, "corNatural": { "type": [ "null", "string" ] }, "corActual": { "type": [ "null", "string" ] }, "brancosPct": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "couroCabeludo": { "type": [ "null", "string" ] }, "queda": { "type": [ "null", "string" ] }, "historicoDeQuimica": { "type": [ "null", "string" ] } } }, "PerfilDeNegocio": { "enum": [ "Salao", "Barbearia", "Estetica", "Clinica" ] }, "PerfilDePele": { "required": [ "tipo", "fototipo", "sensibilidade", "manchas", "acne", "rosacea", "cicatrizes", "exposicaoSolar", "produtosEmUso", "tratamentosRecentes" ], "type": "object", "properties": { "tipo": { "type": [ "null", "string" ] }, "fototipo": { "type": [ "null", "string" ] }, "sensibilidade": { "type": [ "null", "string" ] }, "manchas": { "type": [ "null", "string" ] }, "acne": { "type": [ "null", "string" ] }, "rosacea": { "type": [ "null", "string" ] }, "cicatrizes": { "type": [ "null", "string" ] }, "exposicaoSolar": { "type": [ "null", "string" ] }, "produtosEmUso": { "type": [ "null", "string" ] }, "tratamentosRecentes": { "type": [ "null", "string" ] } } }, "PerfilDePestanas": { "required": [ "formato", "curvatura", "espessura", "formaDeSobrancelha" ], "type": "object", "properties": { "formato": { "type": [ "null", "string" ] }, "curvatura": { "type": [ "null", "string" ] }, "espessura": { "type": [ "null", "string" ] }, "formaDeSobrancelha": { "type": [ "null", "string" ] } } }, "PerfilDeUnhas": { "required": [ "tipo", "formato", "comprimento", "historicoDeLesoes", "coresHabituais" ], "type": "object", "properties": { "tipo": { "type": [ "null", "string" ] }, "formato": { "type": [ "null", "string" ] }, "comprimento": { "type": [ "null", "string" ] }, "historicoDeLesoes": { "type": [ "null", "string" ] }, "coresHabituais": { "type": [ "null", "string" ] } } }, "PerguntaFiscalDto": { "required": [ "codigo", "titulo", "ajuda", "opcoes", "valor", "confirmada", "validadoPor", "validadoEmUtc", "porOmissao" ], "type": "object", "properties": { "codigo": { "type": "string" }, "titulo": { "type": "string" }, "ajuda": { "type": "string" }, "opcoes": { "type": "array", "items": { "$ref": "#/components/schemas/OpcaoFiscalDto" } }, "valor": { "type": "string" }, "confirmada": { "type": "boolean" }, "validadoPor": { "type": [ "null", "string" ] }, "validadoEmUtc": { "type": [ "null", "string" ], "format": "date-time" }, "porOmissao": { "type": "boolean" } } }, "PerguntaRh": { "enum": [ "PorteEmpresa", "SemanaDeTrabalho", "ContagemDosDiasDeFerias", "AcordoColectivoTrabalho", "ProporcaoDoMesIncompleto", "CalculoDoValorHora", "InssDedutivelParaIrt", "BaseDosDescontosProgramados", "CanalDeDenuncias" ] }, "PeriodoFluxoDto": { "required": [ "inicio", "fim", "entradas", "saidas", "saldoFinal" ], "type": "object", "properties": { "inicio": { "type": "string", "format": "date" }, "fim": { "type": "string", "format": "date" }, "entradas": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "saidas": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "saldoFinal": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "PeriodosFinanceirosDto": { "required": [ "fechadoAte", "ultimoFechavel", "proximoAFechar", "historico" ], "type": "object", "properties": { "fechadoAte": { "type": [ "null", "string" ], "format": "date" }, "ultimoFechavel": { "type": "string", "format": "date" }, "proximoAFechar": { "type": [ "null", "string" ], "format": "date" }, "historico": { "type": "array", "items": { "$ref": "#/components/schemas/FechoDePeriodoDto" } } } }, "PesoPedido": { "required": [ "kg" ], "type": "object", "properties": { "kg": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "PlanoInput": { "required": [ "frequencia", "diaDeEmissao", "antecipada", "enviarEmail" ], "type": "object", "properties": { "frequencia": { "$ref": "#/components/schemas/FrequenciaDoPlano" }, "diaDeEmissao": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "antecipada": { "type": "boolean" }, "enviarEmail": { "type": "boolean" } } }, "PlanoPedido": { "required": [ "propriedadeId", "data" ], "type": "object", "properties": { "propriedadeId": { "type": [ "null", "string" ], "format": "uuid" }, "data": { "type": [ "null", "string" ], "format": "date" } } }, "PoliticaVendasDto": { "required": [ "permitirPrecoVendaLivre", "descontoMaximoVendaPercentual" ], "type": "object", "properties": { "permitirPrecoVendaLivre": { "type": "boolean" }, "descontoMaximoVendaPercentual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "limiteDescontoOperadorPercentual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "fechoComDiferencaExigeSupervisor": { "type": "boolean", "default": false }, "notaCreditoNoPdvExigeSupervisor": { "type": "boolean", "default": true } } }, "PontoDeControloInput": { "required": [ "nome", "tipo" ], "type": "object", "properties": { "nome": { "type": "string" }, "tipo": { "type": "string" }, "minimo": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "maximo": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "unidade": { "type": [ "null", "string" ] }, "obrigatorio": { "type": "boolean", "default": true } } }, "PontoPrevistoDto": { "required": [ "data", "aReceber", "aPagar", "saldo" ], "type": "object", "properties": { "data": { "type": "string", "format": "date" }, "aReceber": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "aPagar": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "saldo": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "aPagarRecorrente": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "aReceberAvencas": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 } } }, "PrazoPedido": { "required": [ "prometidoParaUtc" ], "type": "object", "properties": { "prometidoParaUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "PrecoInput": { "required": [ "categoriaId", "tipoDeRoupaId", "preco" ], "type": "object", "properties": { "categoriaId": { "type": [ "null", "string" ], "format": "uuid" }, "tipoDeRoupaId": { "type": [ "null", "string" ], "format": "uuid" }, "preco": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "PreferenciasDoCliente": { "required": [ "profissionalHabitualId", "bebida", "prefereSilencio", "musica", "canalDeContacto", "lingua" ], "type": "object", "properties": { "profissionalHabitualId": { "type": [ "null", "string" ], "format": "uuid" }, "bebida": { "type": [ "null", "string" ] }, "prefereSilencio": { "type": [ "null", "boolean" ] }, "musica": { "type": [ "null", "string" ] }, "canalDeContacto": { "type": [ "null", "string" ] }, "lingua": { "type": [ "null", "string" ] } } }, "PrioridadePedida": { "required": [ "prioridade" ], "type": "object", "properties": { "prioridade": { "type": [ "null", "string" ] } } }, "ProblemaCadeiaDto": { "required": [ "gravidade", "codigo", "sequencial", "numero", "documentoId", "descricao" ], "type": "object", "properties": { "gravidade": { "type": "string" }, "codigo": { "type": "string" }, "sequencial": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "numero": { "type": "string" }, "documentoId": { "type": [ "null", "string" ], "format": "uuid" }, "descricao": { "type": "string" } } }, "ProcessarFolhaRequest": { "required": [ "competencia" ], "type": "object", "properties": { "competencia": { "type": "string", "format": "date" }, "funcionarioIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } }, "ProdutoBaixoEstoqueDto": { "required": [ "produtoId", "produtoNome", "codigoBarra", "precoCusto", "precoUnitario", "lojaId", "lojaNome", "estoqueMinimo", "quantidadeTotal", "valor", "reservado", "disponivel" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "produtoNome": { "type": "string" }, "codigoBarra": { "type": [ "null", "string" ] }, "precoCusto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "precoUnitario": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "lojaId": { "type": "string", "format": "uuid" }, "lojaNome": { "type": "string" }, "estoqueMinimo": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "quantidadeTotal": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "reservado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "disponivel": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "paraVenda": { "type": "boolean", "default": true } } }, "ProdutoComposicaoLinhaDto": { "required": [ "id", "produtoAssociadoId", "quantidade", "precoUnitario", "produtoAssociadoNome" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "produtoAssociadoId": { "type": "string", "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "precoUnitario": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "produtoAssociadoNome": { "type": [ "null", "string" ] } } }, "ProdutoDetalheDto": { "required": [ "id", "codigoInterno", "codigoBarra", "nome", "descricao", "tipoProduto", "impostoId", "motivoIsencaoIvaId", "taxaRetencaoId", "categoriaId", "unidadeId", "marcaId", "modeloId", "fabricanteId", "tamanhoId", "fornecedorId", "estocavel", "estoqueMinimo", "controlarValidade", "composto", "informarPrecoNoPdv", "precificacaoAvancada", "variado", "itemCozinha", "mostrarDescricaoNaFactura", "activo", "precoCusto", "lucroPvp1", "pvp1", "lucroPvp2", "pvp2", "lucroPvp3", "pvp3", "lucroPvp4", "pvp4", "paisOrigemId", "origem", "peso", "comprimento", "largura", "altura", "tipoInventarioFiscal", "valorCif", "despesasTransporte", "despesasArmazenagem", "encargosAduaneiros", "despesasBancarias", "encargosGerais" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "codigoInterno": { "type": [ "null", "string" ] }, "codigoBarra": { "type": [ "null", "string" ] }, "nome": { "type": "string" }, "descricao": { "type": [ "null", "string" ] }, "tipoProduto": { "type": "string" }, "impostoId": { "type": "string", "format": "uuid" }, "motivoIsencaoIvaId": { "type": [ "null", "string" ], "format": "uuid" }, "taxaRetencaoId": { "type": [ "null", "string" ], "format": "uuid" }, "categoriaId": { "type": [ "null", "string" ], "format": "uuid" }, "unidadeId": { "type": [ "null", "string" ], "format": "uuid" }, "marcaId": { "type": [ "null", "string" ], "format": "uuid" }, "modeloId": { "type": [ "null", "string" ], "format": "uuid" }, "fabricanteId": { "type": [ "null", "string" ], "format": "uuid" }, "tamanhoId": { "type": [ "null", "string" ], "format": "uuid" }, "fornecedorId": { "type": [ "null", "string" ], "format": "uuid" }, "estocavel": { "type": "boolean" }, "estoqueMinimo": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "controlarValidade": { "type": "boolean" }, "composto": { "type": "boolean" }, "informarPrecoNoPdv": { "type": "boolean" }, "precificacaoAvancada": { "type": "boolean" }, "variado": { "type": "boolean" }, "itemCozinha": { "type": "boolean" }, "mostrarDescricaoNaFactura": { "type": "boolean" }, "activo": { "type": "boolean" }, "precoCusto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "lucroPvp1": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "pvp1": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "lucroPvp2": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "pvp2": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "lucroPvp3": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "pvp3": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "lucroPvp4": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "pvp4": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "paisOrigemId": { "type": [ "null", "string" ], "format": "uuid" }, "origem": { "type": [ "null", "string" ] }, "peso": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "comprimento": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "largura": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "altura": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "tipoInventarioFiscal": { "type": [ "null", "string" ] }, "valorCif": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "despesasTransporte": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "despesasArmazenagem": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "encargosAduaneiros": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "despesasBancarias": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "encargosGerais": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "composicao": { "type": "array", "items": { "$ref": "#/components/schemas/ProdutoComposicaoLinhaDto" } }, "unidadesVenda": { "type": "array", "items": { "$ref": "#/components/schemas/UnidadeVendaDto" } }, "grupoVariacaoId": { "type": [ "null", "string" ], "format": "uuid" }, "grupoVariacaoNome": { "type": [ "null", "string" ] }, "variacao": { "type": [ "null", "string" ] }, "paraVenda": { "type": "boolean" }, "controlarLote": { "type": "boolean" }, "usaLote": { "type": "boolean" } } }, "ProdutoRankingDto": { "required": [ "posicao", "produtoId", "produto", "quantidade", "totalVendas" ], "type": "object", "properties": { "posicao": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "produtoId": { "type": "string", "format": "uuid" }, "produto": { "type": "string" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalVendas": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "ProdutoResumoDto": { "required": [ "id", "codigoInterno", "codigoBarra", "nome", "tipoProduto", "pvp1", "precoCusto", "activo", "grupoVariacaoNome", "variacao", "paraVenda", "alteradoEmUtc" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "codigoInterno": { "type": [ "null", "string" ] }, "codigoBarra": { "type": [ "null", "string" ] }, "nome": { "type": "string" }, "tipoProduto": { "type": "string" }, "pvp1": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "precoCusto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "activo": { "type": "boolean" }, "grupoVariacaoNome": { "type": [ "null", "string" ] }, "variacao": { "type": [ "null", "string" ] }, "paraVenda": { "type": "boolean" }, "alteradoEmUtc": { "type": "string", "format": "date-time" } } }, "ProdutoTransferenciaDto": { "required": [ "id", "codigoInterno", "codigoBarra", "nome", "unidade", "controlarValidade", "disponivel" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "codigoInterno": { "type": [ "null", "string" ] }, "codigoBarra": { "type": [ "null", "string" ] }, "nome": { "type": "string" }, "unidade": { "type": [ "null", "string" ] }, "controlarValidade": { "type": "boolean" }, "disponivel": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "usaLote": { "type": "boolean", "default": false } } }, "ProdutoVendaDto": { "required": [ "id", "codigoInterno", "codigoBarra", "nome", "tipoProduto", "unidadeDescricao", "pvp1", "pvp2", "pvp3", "pvp4", "impostoId", "impostoPercentual", "motivoIsencaoIvaId", "taxaRetencaoId", "estocavel", "composto", "activo", "saldoNoArmazem", "controlarValidade" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "codigoInterno": { "type": [ "null", "string" ] }, "codigoBarra": { "type": [ "null", "string" ] }, "nome": { "type": "string" }, "tipoProduto": { "type": "string" }, "unidadeDescricao": { "type": [ "null", "string" ] }, "pvp1": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "pvp2": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "pvp3": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "pvp4": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "impostoId": { "type": "string", "format": "uuid" }, "impostoPercentual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "motivoIsencaoIvaId": { "type": [ "null", "string" ], "format": "uuid" }, "taxaRetencaoId": { "type": [ "null", "string" ], "format": "uuid" }, "estocavel": { "type": "boolean" }, "composto": { "type": "boolean" }, "activo": { "type": "boolean" }, "saldoNoArmazem": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "controlarValidade": { "type": "boolean" }, "categoriaId": { "type": [ "null", "string" ], "format": "uuid" }, "usaLote": { "type": "boolean", "default": false }, "unidadesVenda": { "type": "array", "items": { "$ref": "#/components/schemas/UnidadeVendaPdvDto" } }, "grupoVariacaoId": { "type": [ "null", "string" ], "format": "uuid" }, "grupoVariacaoNome": { "type": [ "null", "string" ] }, "variacao": { "type": [ "null", "string" ] } } }, "ProdutoVendidoDto": { "required": [ "produtoId", "produto", "quantidade", "totalVendas", "totalImposto", "totalRetencao", "totalCusto", "lucro" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "produto": { "type": "string" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalVendas": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalImposto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalRetencao": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalCusto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "lucro": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "ProdutoVendidoInput": { "required": [ "produtoId", "quantidade", "precoUnitario", "profissionalId" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "precoUnitario": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "profissionalId": { "type": [ "null", "string" ], "format": "uuid" } } }, "ProfissionalPedido": { "required": [ "nome", "userId", "cor", "aceitaOnline", "comissaoServicoPct", "comissaoProdutoPct", "descricao" ], "type": "object", "properties": { "nome": { "type": "string" }, "userId": { "type": [ "null", "string" ], "format": "uuid" }, "cor": { "type": "string" }, "aceitaOnline": { "type": "boolean" }, "comissaoServicoPct": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "comissaoProdutoPct": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "descricao": { "type": [ "null", "string" ] } } }, "ProgramaDeLavagem": { "enum": [ "Algodao", "Sintetico", "Delicado", "Pesado", "ASeco", "Nenhum" ] }, "ProrrogarReservaStockRequest": { "required": [ "prazoMinutos", "expiraEmUtc" ], "type": "object", "properties": { "prazoMinutos": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "expiraEmUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "ProvinciaDto": { "required": [ "id", "nome" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "nome": { "type": "string" } } }, "ProvisaoRequest": { "required": [ "valor", "justificacao" ], "type": "object", "properties": { "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "justificacao": { "type": "string" } } }, "QrCodeDto": { "required": [ "url", "versao", "lado", "modulos" ], "type": "object", "properties": { "url": { "type": "string" }, "versao": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "lado": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "modulos": { "type": "array", "items": { "type": "string" } } } }, "QualidadePedido": { "required": [ "testDriveKm", "nota" ], "type": "object", "properties": { "testDriveKm": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "nota": { "type": [ "null", "string" ] } } }, "QuarentenaDoArmazemRequest": { "required": [ "emQuarentena" ], "type": "object", "properties": { "emQuarentena": { "type": "boolean" } } }, "QuartoPedido": { "required": [ "quartoId" ], "type": "object", "properties": { "quartoId": { "type": "string", "format": "uuid" } } }, "RascunhoDto": { "required": [ "id", "usuarioId", "tipoDocumentoId", "clienteId", "armazemId", "referenciaExternaId", "descricao", "observacao", "criadoEm", "actualizadoEm", "descontoFinanceiroPercentual", "outrosEncargos", "referenciaCliente", "dataVencimento" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "usuarioId": { "type": "string", "format": "uuid" }, "tipoDocumentoId": { "type": "string", "format": "uuid" }, "clienteId": { "type": "string", "format": "uuid" }, "armazemId": { "type": [ "null", "string" ], "format": "uuid" }, "referenciaExternaId": { "type": [ "null", "string" ], "format": "uuid" }, "descricao": { "type": [ "null", "string" ] }, "observacao": { "type": [ "null", "string" ] }, "criadoEm": { "type": "string", "format": "date-time" }, "actualizadoEm": { "type": "string", "format": "date-time" }, "descontoFinanceiroPercentual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "outrosEncargos": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "referenciaCliente": { "type": [ "null", "string" ] }, "dataVencimento": { "type": [ "null", "string" ], "format": "date" }, "itens": { "type": "array", "items": { "$ref": "#/components/schemas/RascunhoItemDto" } }, "pagamentos": { "type": "array", "items": { "$ref": "#/components/schemas/RascunhoPagamentoDto" } } } }, "RascunhoItemDto": { "required": [ "id", "produtoId", "produtoNome", "quantidade", "precoUnitario", "descontoPercentual" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "produtoId": { "type": "string", "format": "uuid" }, "produtoNome": { "type": "string" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "precoUnitario": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "descontoPercentual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "RascunhoPagamentoDto": { "required": [ "id", "metodoPagamentoId", "valor", "numeroOperacaoBancaria", "dataOperacaoBancaria" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "metodoPagamentoId": { "type": "string", "format": "uuid" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "numeroOperacaoBancaria": { "type": [ "null", "string" ] }, "dataOperacaoBancaria": { "type": [ "null", "string" ], "format": "date-time" } } }, "RascunhoResumoDto": { "required": [ "id", "usuarioId", "tipoDocumentoId", "siglaDocumento", "clienteId", "clienteNome", "descricao", "numeroLinhas", "totalEstimado", "criadoEm", "actualizadoEm" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "usuarioId": { "type": "string", "format": "uuid" }, "tipoDocumentoId": { "type": "string", "format": "uuid" }, "siglaDocumento": { "type": "string" }, "clienteId": { "type": "string", "format": "uuid" }, "clienteNome": { "type": "string" }, "descricao": { "type": [ "null", "string" ] }, "numeroLinhas": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "totalEstimado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "criadoEm": { "type": "string", "format": "date-time" }, "actualizadoEm": { "type": "string", "format": "date-time" } } }, "ReabrirPeriodoRequest": { "required": [ "ate", "motivo" ], "type": "object", "properties": { "ate": { "type": [ "null", "string" ], "format": "date" }, "motivo": { "type": "string" } } }, "ReagendamentoPedido": { "required": [ "servicos" ], "type": "object", "properties": { "servicos": { "type": "array", "items": { "$ref": "#/components/schemas/ServicoPedido" } } } }, "RebookPedido": { "required": [ "servicoId", "data" ], "type": "object", "properties": { "servicoId": { "type": "string", "format": "uuid" }, "data": { "type": [ "null", "string" ], "format": "date" } } }, "ReceberOrdemCommand": { "required": [ "lojaId", "clienteId", "contactoNome", "contactoTelefone", "canal", "urgenciaId", "observacoes", "itens" ], "type": "object", "properties": { "lojaId": { "type": [ "null", "string" ], "format": "uuid" }, "clienteId": { "type": [ "null", "string" ], "format": "uuid" }, "contactoNome": { "type": [ "null", "string" ] }, "contactoTelefone": { "type": [ "null", "string" ] }, "canal": { "$ref": "#/components/schemas/CanalDaOrdem" }, "urgenciaId": { "type": [ "null", "string" ], "format": "uuid" }, "observacoes": { "type": [ "null", "string" ] }, "itens": { "type": "array", "items": { "$ref": "#/components/schemas/ItemPedido" } } } }, "ReceberViaturaCommand": { "required": [ "viaturaId", "clienteId", "lojaId", "kmEntrada", "justificacaoDoKm", "combustivel", "objectos", "chaveCodigo", "pedidoDoCliente", "danos", "decisorNome", "decisorContacto", "prometidoParaUtc", "marcacaoId", "zonaDePatioId", "lugarNoPatio" ], "type": "object", "properties": { "viaturaId": { "type": "string", "format": "uuid" }, "clienteId": { "type": [ "null", "string" ], "format": "uuid" }, "lojaId": { "type": [ "null", "string" ], "format": "uuid" }, "kmEntrada": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "justificacaoDoKm": { "type": [ "null", "string" ] }, "combustivel": { "type": "string" }, "objectos": { "type": [ "null", "string" ] }, "chaveCodigo": { "type": [ "null", "string" ] }, "pedidoDoCliente": { "type": "string" }, "danos": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DanoPedido" } }, "decisorNome": { "type": [ "null", "string" ] }, "decisorContacto": { "type": [ "null", "string" ] }, "prometidoParaUtc": { "type": [ "null", "string" ], "format": "date-time" }, "marcacaoId": { "type": [ "null", "string" ], "format": "uuid" }, "zonaDePatioId": { "type": [ "null", "string" ], "format": "uuid" }, "lugarNoPatio": { "type": [ "null", "string" ] } } }, "ReclamacaoPedido": { "required": [ "pedidoDoCliente", "kmEntrada", "justificacaoDoKm", "combustivel", "responsabilidade", "zonaDePatioId", "lugarNoPatio", "prometidoParaUtc" ], "type": "object", "properties": { "pedidoDoCliente": { "type": "string" }, "kmEntrada": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "justificacaoDoKm": { "type": [ "null", "string" ] }, "combustivel": { "type": "string" }, "responsabilidade": { "type": [ "null", "string" ] }, "zonaDePatioId": { "type": [ "null", "string" ], "format": "uuid" }, "lugarNoPatio": { "type": [ "null", "string" ] }, "prometidoParaUtc": { "type": [ "null", "string" ], "format": "date-time" } } }, "RecusarReservaEstoqueRequest": { "required": [ "motivo" ], "type": "object", "properties": { "motivo": { "type": [ "null", "string" ] } } }, "ReembolsarCreditoRequest": { "required": [ "metodoPagamentoId", "valor" ], "type": "object", "properties": { "metodoPagamentoId": { "type": "string", "format": "uuid" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "data": { "type": [ "null", "string" ], "format": "date-time" }, "referencia": { "type": [ "null", "string" ] } } }, "ReferenciaPedido": { "required": [ "referencia" ], "type": "object", "properties": { "referencia": { "type": "string" } } }, "RegimeFiscalDto": { "required": [ "id", "descricao", "cobrarIva", "taxaSobreFacturacao" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "descricao": { "type": "string" }, "cobrarIva": { "type": "boolean" }, "taxaSobreFacturacao": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "RegimeRemuneratorio": { "enum": [ "FixoMensal", "PorTempos", "Misto" ] }, "RegistarAcidenteTrabalhoCommand": { "required": [ "funcionarioId", "dataHora", "local", "gravidade", "diasAusencia", "descricao" ], "type": "object", "properties": { "funcionarioId": { "type": "string", "format": "uuid" }, "dataHora": { "type": "string", "format": "date-time" }, "local": { "type": "string" }, "gravidade": { "$ref": "#/components/schemas/GravidadeAcidente" }, "diasAusencia": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "descricao": { "type": "string" } } }, "RegistarAusenciaCommand": { "required": [ "funcionarioId", "tipo", "dataInicio", "dataFim", "horas", "justificativo", "observacao" ], "type": "object", "properties": { "funcionarioId": { "type": "string", "format": "uuid" }, "tipo": { "$ref": "#/components/schemas/TipoAusencia" }, "dataInicio": { "type": "string", "format": "date" }, "dataFim": { "type": "string", "format": "date" }, "horas": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "justificativo": { "type": [ "null", "string" ] }, "observacao": { "type": [ "null", "string" ] } } }, "RegistarCessacaoCommand": { "required": [ "funcionarioId", "dataCessacao", "motivo", "observacao" ], "type": "object", "properties": { "funcionarioId": { "type": "string", "format": "uuid" }, "dataCessacao": { "type": "string", "format": "date" }, "motivo": { "$ref": "#/components/schemas/MotivoCessacao" }, "observacao": { "type": [ "null", "string" ] } } }, "RegistarDescontoProgramadoCommand": { "required": [ "funcionarioId", "tipo", "descricao", "valorTotal", "modo", "numeroPrestacoes", "percentagem", "primeiroMes", "dataConcessao", "entidade", "referencia", "observacao" ], "type": "object", "properties": { "funcionarioId": { "type": "string", "format": "uuid" }, "tipo": { "$ref": "#/components/schemas/TipoDescontoProgramado" }, "descricao": { "type": "string" }, "valorTotal": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "modo": { "$ref": "#/components/schemas/ModoDesconto" }, "numeroPrestacoes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "percentagem": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "primeiroMes": { "type": "string", "format": "date" }, "dataConcessao": { "type": [ "null", "string" ], "format": "date" }, "entidade": { "type": [ "null", "string" ] }, "referencia": { "type": [ "null", "string" ] }, "observacao": { "type": [ "null", "string" ] } } }, "RegistarDireitoFeriasCommand": { "required": [ "funcionarioId", "ano", "origem", "dias", "motivo" ], "type": "object", "properties": { "funcionarioId": { "type": "string", "format": "uuid" }, "ano": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "origem": { "$ref": "#/components/schemas/OrigemDireitoFerias" }, "dias": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "motivo": { "type": "string" } } }, "RegistarEntradaManualEstoqueCommand": { "required": [ "produtoId", "armazemId", "loteId", "quantidade", "observacao" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "armazemId": { "type": [ "null", "string" ], "format": "uuid" }, "loteId": { "type": [ "null", "string" ], "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "observacao": { "type": [ "null", "string" ] } } }, "RegistarExameMedicoCommand": { "required": [ "funcionarioId", "tipo", "data", "proximoExame", "resultado", "medico", "restricoes", "observacoes", "referenciaCertificado" ], "type": "object", "properties": { "funcionarioId": { "type": "string", "format": "uuid" }, "tipo": { "$ref": "#/components/schemas/TipoExameMedico" }, "data": { "type": "string", "format": "date" }, "proximoExame": { "type": [ "null", "string" ], "format": "date" }, "resultado": { "$ref": "#/components/schemas/ResultadoExameMedico" }, "medico": { "type": [ "null", "string" ] }, "restricoes": { "type": [ "null", "string" ] }, "observacoes": { "type": [ "null", "string" ] }, "referenciaCertificado": { "type": [ "null", "string" ] } } }, "RegistarInspeccaoCommand": { "required": [ "planoId", "loteId", "ordemId", "entradaId", "medicoes" ], "type": "object", "properties": { "planoId": { "type": "string", "format": "uuid" }, "loteId": { "type": [ "null", "string" ], "format": "uuid" }, "ordemId": { "type": [ "null", "string" ], "format": "uuid" }, "entradaId": { "type": [ "null", "string" ], "format": "uuid" }, "medicoes": { "type": "array", "items": { "$ref": "#/components/schemas/MedicaoInput" } }, "observacao": { "type": [ "null", "string" ] }, "instrumentoId": { "type": [ "null", "string" ], "format": "uuid" } } }, "RegistarLancamentoVariavelCommand": { "required": [ "funcionarioId", "rubricaId", "competencia", "quantidade", "valorUnitario", "descricao", "observacao" ], "type": "object", "properties": { "funcionarioId": { "type": "string", "format": "uuid" }, "rubricaId": { "type": "string", "format": "uuid" }, "competencia": { "type": "string", "format": "date" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorUnitario": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "descricao": { "type": [ "null", "string" ] }, "observacao": { "type": [ "null", "string" ] } } }, "RegistarMovimentoRequest": { "required": [ "data", "valor", "tipo", "documento" ], "type": "object", "properties": { "data": { "type": "string", "format": "date-time" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "tipo": { "$ref": "#/components/schemas/TipoMovimentoCliente" }, "documento": { "type": [ "null", "string" ] } } }, "RegistarNotaCreditoRequest": { "required": [ "numero", "data", "baseTributavel", "ivaSuportado", "valor", "motivo" ], "type": "object", "properties": { "numero": { "type": "string" }, "data": { "type": "string", "format": "date-time" }, "baseTributavel": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "ivaSuportado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "motivo": { "type": "string" } } }, "RegistarPagamentoRequest": { "required": [ "metodoPagamentoId", "valor" ], "type": "object", "properties": { "metodoPagamentoId": { "type": "string", "format": "uuid" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "juros": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "desconto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "numeroOperacaoBancaria": { "type": [ "null", "string" ] }, "dataOperacaoBancaria": { "type": [ "null", "string" ], "format": "date-time" }, "dataPagamento": { "type": [ "null", "string" ], "format": "date-time" } } }, "RegistarReceitaAvulsaCommand": { "required": [ "contaFinanceiraId", "categoriaFinanceiraId", "valor", "descricao" ], "type": "object", "properties": { "contaFinanceiraId": { "type": "string", "format": "uuid" }, "categoriaFinanceiraId": { "type": "string", "format": "uuid" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "descricao": { "type": "string" }, "centroCustoId": { "type": [ "null", "string" ], "format": "uuid" }, "data": { "type": [ "null", "string" ], "format": "date-time" }, "pagador": { "type": [ "null", "string" ] }, "referencia": { "type": [ "null", "string" ] } } }, "RegistarSaidaManualEstoqueCommand": { "required": [ "produtoId", "armazemId", "loteId", "quantidade", "motivo" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "armazemId": { "type": "string", "format": "uuid" }, "loteId": { "type": [ "null", "string" ], "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "motivo": { "type": "string" } } }, "RegistarTrabalhoSuplementarCommand": { "required": [ "funcionarioId", "data", "horas", "horasNocturnas", "motivo", "observacao" ], "type": "object", "properties": { "funcionarioId": { "type": "string", "format": "uuid" }, "data": { "type": "string", "format": "date" }, "horas": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "horasNocturnas": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "motivo": { "type": "string" }, "observacao": { "type": [ "null", "string" ] } } }, "RegistarViaturaCommand": { "required": [ "matricula", "vin", "proprietarioId", "dados", "km" ], "type": "object", "properties": { "matricula": { "type": "string" }, "vin": { "type": [ "null", "string" ] }, "proprietarioId": { "type": "string", "format": "uuid" }, "dados": { "$ref": "#/components/schemas/DadosDaViaturaPedido" }, "km": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "RegistoPedido": { "required": [ "servicoDaMarcacaoId", "tipo", "componentes", "oxidanteVolume", "oxidanteMl", "tempoDePausaMin", "tecnica", "zonas", "parametros", "resultado", "fazerDiferente" ], "type": "object", "properties": { "servicoDaMarcacaoId": { "type": [ "null", "string" ], "format": "uuid" }, "tipo": { "type": "string" }, "componentes": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/ComponenteInput" } }, "oxidanteVolume": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "oxidanteMl": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "tempoDePausaMin": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "tecnica": { "type": [ "null", "string" ] }, "zonas": { "type": [ "null", "string" ] }, "parametros": { "type": [ "null", "string" ] }, "resultado": { "type": [ "null", "string" ] }, "fazerDiferente": { "type": [ "null", "string" ] } } }, "RejeitarTransferenciaEstoqueRequest": { "required": [ "motivo" ], "type": "object", "properties": { "motivo": { "type": [ "null", "string" ] } } }, "RemoverTarifasDoDiaCommand": { "required": [ "planoId", "tipoDeQuartoId", "de", "ate" ], "type": "object", "properties": { "planoId": { "type": "string", "format": "uuid" }, "tipoDeQuartoId": { "type": [ "null", "string" ], "format": "uuid" }, "de": { "type": "string", "format": "date" }, "ate": { "type": "string", "format": "date" } } }, "RenovacaoDoContrato": { "enum": [ "Nenhuma", "Tacita", "Manual" ] }, "RenovarPedido": { "required": [ "mesesAdicionais", "termos" ], "type": "object", "properties": { "mesesAdicionais": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "termos": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/TermosInput" } ] } } }, "RepetirPedido": { "required": [ "servicoDaMarcacaoId" ], "type": "object", "properties": { "servicoDaMarcacaoId": { "type": [ "null", "string" ], "format": "uuid" } } }, "ReprovacaoPedido": { "required": [ "trabalhoIds", "motivo" ], "type": "object", "properties": { "trabalhoIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "motivo": { "type": [ "null", "string" ] } } }, "ReprovarPedido": { "required": [ "itemId", "codigo", "destino", "motivo" ], "type": "object", "properties": { "itemId": { "type": [ "null", "string" ], "format": "uuid" }, "codigo": { "type": [ "null", "string" ] }, "destino": { "$ref": "#/components/schemas/FaseDaPeca" }, "motivo": { "type": [ "null", "string" ] } } }, "RescindirPedido": { "required": [ "motivo", "dataDeEfeito", "penalidade" ], "type": "object", "properties": { "motivo": { "type": "string" }, "dataDeEfeito": { "type": "string", "format": "date" }, "penalidade": { "type": [ "null", "string" ] } } }, "ReservaDeMesaRequest": { "required": [ "mesaId", "nome", "telefone", "pessoas", "inicio" ], "type": "object", "properties": { "mesaId": { "type": [ "null", "string" ], "format": "uuid" }, "nome": { "type": "string" }, "telefone": { "type": [ "null", "string" ] }, "pessoas": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "inicio": { "type": "string", "format": "date-time" }, "duracaoMin": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 90 }, "nota": { "type": [ "null", "string" ] } } }, "ReservaEstoqueDto": { "required": [ "id", "produtoId", "produtoNome", "armazemOrigemId", "armazemOrigemDescricao", "lojaOrigemId", "lojaOrigemNome", "armazemDestinoId", "armazemDestinoDescricao", "lojaDestinoId", "lojaDestinoNome", "quantidade", "estado", "usuarioSolicitanteId", "usuarioConfirmadorId", "criadaEmUtc", "expiraEmUtc", "resolvidaEmUtc", "observacao", "motivoRecusa", "transferenciaEstoqueId" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "produtoId": { "type": "string", "format": "uuid" }, "produtoNome": { "type": "string" }, "armazemOrigemId": { "type": "string", "format": "uuid" }, "armazemOrigemDescricao": { "type": "string" }, "lojaOrigemId": { "type": "string", "format": "uuid" }, "lojaOrigemNome": { "type": "string" }, "armazemDestinoId": { "type": "string", "format": "uuid" }, "armazemDestinoDescricao": { "type": "string" }, "lojaDestinoId": { "type": "string", "format": "uuid" }, "lojaDestinoNome": { "type": "string" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "estado": { "type": "string" }, "usuarioSolicitanteId": { "type": "string", "format": "uuid" }, "usuarioConfirmadorId": { "type": [ "null", "string" ], "format": "uuid" }, "criadaEmUtc": { "type": "string", "format": "date-time" }, "expiraEmUtc": { "type": "string", "format": "date-time" }, "resolvidaEmUtc": { "type": [ "null", "string" ], "format": "date-time" }, "observacao": { "type": [ "null", "string" ] }, "motivoRecusa": { "type": [ "null", "string" ] }, "transferenciaEstoqueId": { "type": [ "null", "string" ], "format": "uuid" }, "clienteId": { "type": [ "null", "string" ], "format": "uuid" }, "clienteNome": { "type": [ "null", "string" ] }, "clienteTelefone": { "type": [ "null", "string" ] } } }, "ResolucaoDoIncidente": { "enum": [ "Reprocessar", "Reparar", "Indemnizar", "SemRazao" ] }, "ResolucaoPedida": { "required": [ "resolucao" ], "type": "object", "properties": { "resolucao": { "type": [ "null", "string" ] } } }, "ResolverPedido": { "required": [ "resolucao", "detalhe", "valorDaIndemnizacao", "custoInterno", "destinoDoReprocessamento" ], "type": "object", "properties": { "resolucao": { "$ref": "#/components/schemas/ResolucaoDoIncidente" }, "detalhe": { "type": [ "null", "string" ] }, "valorDaIndemnizacao": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "custoInterno": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "destinoDoReprocessamento": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/FaseDaPeca" } ] } } }, "ResponsabilidadePedido": { "required": [ "responsabilidade" ], "type": "object", "properties": { "responsabilidade": { "type": "string" } } }, "RespostaPedido": { "required": [ "condicao", "sim" ], "type": "object", "properties": { "condicao": { "type": "string" }, "sim": { "type": "boolean" } } }, "RespostaRhRequest": { "required": [ "valor", "confirmada", "validadoPor" ], "type": "object", "properties": { "valor": { "type": "string" }, "confirmada": { "type": "boolean" }, "validadoPor": { "type": [ "null", "string" ] } } }, "ResultadoDenuncia": { "enum": [ "Procedente", "ParcialmenteProcedente", "Improcedente", "SemElementosSuficientes" ] }, "ResultadoExameMedico": { "enum": [ "Apto", "AptoComRestricoes", "Inapto" ] }, "ResultadoLancamentoDespesasDto": { "required": [ "lancadas", "falhadas", "falhas", "restantes" ], "type": "object", "properties": { "lancadas": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "falhadas": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "falhas": { "type": "array", "items": { "$ref": "#/components/schemas/FalhaLancamentoDto" } }, "restantes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "ResultadoPedido": { "required": [ "resultado", "nota" ], "type": "object", "properties": { "resultado": { "type": "string" }, "nota": { "type": [ "null", "string" ] } } }, "ResumoContasAPagarDto": { "required": [ "emAberto", "valorEmAberto", "valorVencido", "valorAVencerEm7Dias", "valorVencidoAte30Dias", "valorVencido31a60Dias", "valorVencidoMais60Dias" ], "type": "object", "properties": { "emAberto": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "valorEmAberto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorVencido": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorAVencerEm7Dias": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorVencidoAte30Dias": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorVencido31a60Dias": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorVencidoMais60Dias": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "ResumoContasAReceberDto": { "required": [ "emAberto", "valorEmAberto", "valorVencido", "valorAVencerEm7Dias", "valorVencidoAte30Dias", "valorVencido31a60Dias", "valorVencidoMais60Dias" ], "type": "object", "properties": { "emAberto": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "valorEmAberto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorVencido": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorAVencerEm7Dias": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorVencidoAte30Dias": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorVencido31a60Dias": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorVencidoMais60Dias": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "ResumoDespesasMesDto": { "required": [ "quantidade", "total", "pago", "porPagar" ], "type": "object", "properties": { "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "pago": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "porPagar": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "ResumoDespesasRecorrentesDto": { "required": [ "activas", "custoMensalEquivalente", "pendentes" ], "type": "object", "properties": { "activas": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "custoMensalEquivalente": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "pendentes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "ResumoFacturacaoDto": { "required": [ "hoje", "estaSemana", "esteMes", "esteAno" ], "type": "object", "properties": { "hoje": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "estaSemana": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "esteMes": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "esteAno": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "ResumoImpostoDto": { "required": [ "taxa", "incidencia", "imposto", "motivoIsencao" ], "type": "object", "properties": { "taxa": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "incidencia": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "imposto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "motivoIsencao": { "type": [ "null", "string" ] } } }, "ResumoIvaDto": { "required": [ "taxa", "motivoIsencao", "incidencia", "imposto" ], "type": "object", "properties": { "taxa": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "motivoIsencao": { "type": [ "null", "string" ] }, "incidencia": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "imposto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "ResumoReservasActivasDto": { "required": [ "pedidos", "reservas", "aExpirarEmBreve" ], "type": "object", "properties": { "pedidos": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "reservas": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "aExpirarEmBreve": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "ResumoSaftComprasDto": { "required": [ "nifContribuinte", "periodo", "linhas", "fornecedores", "totalValor", "totalIva", "totalIvaDedutivel", "perguntasPorConfirmar", "avisos" ], "type": "object", "properties": { "nifContribuinte": { "type": "string" }, "periodo": { "type": "string" }, "linhas": { "type": "array", "items": { "$ref": "#/components/schemas/LinhaSaftComprasDto" } }, "fornecedores": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "totalValor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalIva": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "totalIvaDedutivel": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "perguntasPorConfirmar": { "type": "array", "items": { "type": "string" } }, "avisos": { "type": "array", "items": { "type": "string" } } } }, "ResumoSaftInventarioDto": { "required": [ "anoFiscal", "dataReferencia", "nif", "semOperacoes", "linhas", "totalValor", "avisos" ], "type": "object", "properties": { "anoFiscal": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "dataReferencia": { "type": "string", "format": "date" }, "nif": { "type": "string" }, "semOperacoes": { "type": "boolean" }, "linhas": { "type": "array", "items": { "$ref": "#/components/schemas/LinhaSaftInventarioDto" } }, "totalValor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "avisos": { "type": "array", "items": { "type": "string" } } } }, "RetirarEstoqueFifoCommand": { "required": [ "produtoId", "armazemId", "quantidade", "documento" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "armazemId": { "type": "string", "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "documento": { "type": [ "null", "string" ] } } }, "RevisaoDePreco": { "enum": [ "Nenhuma", "PercentualFixo", "Negociada" ] }, "RiscoLitigio": { "enum": [ "Remoto", "Possivel", "Provavel", null ] }, "RiscoLitigioRequest": { "required": [ "nivel", "justificacao" ], "type": "object", "properties": { "nivel": { "$ref": "#/components/schemas/RiscoLitigio" }, "justificacao": { "type": "string" } } }, "RodapeDaMarcaDto": { "required": [ "titulo", "mensagem", "site", "email", "telefone", "pilares" ], "type": "object", "properties": { "titulo": { "type": "string" }, "mensagem": { "type": "string" }, "site": { "type": "string" }, "email": { "type": "string" }, "telefone": { "type": "string" }, "pilares": { "type": "array", "items": { "type": "string" } }, "comLogotipo": { "type": "boolean", "default": false } } }, "RotasDto": { "required": [ "alojamento", "refeicoes", "extras", "taxas" ], "type": "object", "properties": { "alojamento": { "type": "string" }, "refeicoes": { "type": "string" }, "extras": { "type": "string" }, "taxas": { "type": "string" } } }, "RubricaFluxoDto": { "required": [ "nome", "entradas", "saidas", "liquido" ], "type": "object", "properties": { "nome": { "type": "string" }, "entradas": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "saidas": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "liquido": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "SaidaConcluidaInput": { "required": [ "produtoId" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "lote": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/LoteDoAcabadoInput" } ] } } }, "SaidaDaFichaInput": { "required": [ "produtoId", "tipo", "quantidade" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "tipo": { "type": "string" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valorUnitarioReferencia": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "SaidaManualEstoqueDto": { "required": [ "id", "numero", "data", "produtoId", "produtoNome", "armazemId", "armazemDescricao", "loteId", "loteDescricao", "quantidade", "motivo" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "numero": { "type": "string" }, "data": { "type": "string", "format": "date-time" }, "produtoId": { "type": "string", "format": "uuid" }, "produtoNome": { "type": "string" }, "armazemId": { "type": "string", "format": "uuid" }, "armazemDescricao": { "type": "string" }, "loteId": { "type": [ "null", "string" ], "format": "uuid" }, "loteDescricao": { "type": [ "null", "string" ] }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "motivo": { "type": "string" }, "identidade": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/IdentidadeDeDocumentoDto" } ] } } }, "SaldoEstoqueDto": { "required": [ "id", "produtoId", "produtoNome", "codigoBarra", "precoCusto", "precoUnitario", "armazemId", "armazemDescricao", "loteId", "loteDescricao", "loteValidade", "quantidade", "valor", "criadoEmUtc", "reservado", "disponivel" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "produtoId": { "type": "string", "format": "uuid" }, "produtoNome": { "type": "string" }, "codigoBarra": { "type": [ "null", "string" ] }, "precoCusto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "precoUnitario": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "armazemId": { "type": "string", "format": "uuid" }, "armazemDescricao": { "type": "string" }, "loteId": { "type": [ "null", "string" ], "format": "uuid" }, "loteDescricao": { "type": [ "null", "string" ] }, "loteValidade": { "type": [ "null", "string" ], "format": "date-time" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "criadoEmUtc": { "type": "string", "format": "date-time" }, "reservado": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "disponivel": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "SaldoInicialRequest": { "required": [ "saldoInicial", "data" ], "type": "object", "properties": { "saldoInicial": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "data": { "type": "string", "format": "date-time" } } }, "SaldoPorProdutoDto": { "required": [ "produtoId", "quantidade" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "SalvarRascunhoCommand": { "required": [ "id", "tipoDocumentoId", "clienteId", "armazemId", "referenciaExternaId", "descricao", "observacao", "itens", "pagamentos" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ], "format": "uuid" }, "tipoDocumentoId": { "type": "string", "format": "uuid" }, "clienteId": { "type": "string", "format": "uuid" }, "armazemId": { "type": [ "null", "string" ], "format": "uuid" }, "referenciaExternaId": { "type": [ "null", "string" ], "format": "uuid" }, "descricao": { "type": [ "null", "string" ] }, "observacao": { "type": [ "null", "string" ] }, "itens": { "type": "array", "items": { "$ref": "#/components/schemas/ItemDocumentoInput" } }, "pagamentos": { "type": "array", "items": { "$ref": "#/components/schemas/PagamentoDocumentoInput" } }, "transporte": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DadosTransporte" } ] }, "lojaId": { "type": [ "null", "string" ], "format": "uuid" }, "descontoFinanceiroPercentual": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "outrosEncargos": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "referenciaCliente": { "type": [ "null", "string" ] }, "dataVencimento": { "type": [ "null", "string" ], "format": "date" } } }, "SancaoDisciplinar": { "enum": [ "AdvertenciaVerbal", "CensuraEscrita", "Suspensao", "DespedimentoComJustaCausa" ] }, "SancaoDisciplinarRequest": { "required": [ "sancao", "data", "descricao", "diasSuspensao", "justificacaoForaDePrazo" ], "type": "object", "properties": { "sancao": { "$ref": "#/components/schemas/SancaoDisciplinar" }, "data": { "type": "string", "format": "date" }, "descricao": { "type": "string" }, "diasSuspensao": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "justificacaoForaDePrazo": { "type": [ "null", "string" ] } } }, "SegmentoInput": { "required": [ "tipo", "minutos" ], "type": "object", "properties": { "tipo": { "$ref": "#/components/schemas/TipoDeSegmento" }, "minutos": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "SentarReservaDeMesaRequest": { "type": "object", "properties": { "comandaId": { "type": [ "null", "string" ], "format": "uuid" } } }, "SentidoDoContrato": { "enum": [ "Cliente", "Fornecedor", null ] }, "SepararMesaRequest": { "required": [ "mesaId" ], "type": "object", "properties": { "mesaId": { "type": "string", "format": "uuid" } } }, "SerieDocumentoDto": { "required": [ "lojaId", "lojaNome", "tipoDocumentoId", "tipoDocumentoSigla", "tipoDocumentoDescricao", "serieConfigurada", "serieEfectiva" ], "type": "object", "properties": { "lojaId": { "type": "string", "format": "uuid" }, "lojaNome": { "type": "string" }, "tipoDocumentoId": { "type": "string", "format": "uuid" }, "tipoDocumentoSigla": { "type": "string" }, "tipoDocumentoDescricao": { "type": "string" }, "serieConfigurada": { "type": [ "null", "string" ] }, "serieEfectiva": { "type": "string" } } }, "SeriePedido": { "required": [ "clienteId", "servicos", "frequencia", "ocorrencias" ], "type": "object", "properties": { "clienteId": { "type": "string", "format": "uuid" }, "servicos": { "type": "array", "items": { "$ref": "#/components/schemas/ServicoPedido" } }, "frequencia": { "$ref": "#/components/schemas/FrequenciaDaSerie" }, "ocorrencias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "origem": { "$ref": "#/components/schemas/OrigemDaMarcacao" }, "nota": { "type": [ "null", "string" ] } } }, "ServicoPedido": { "required": [ "servicoId", "profissionalId", "inicio" ], "type": "object", "properties": { "servicoId": { "type": "string", "format": "uuid" }, "profissionalId": { "type": [ "null", "string" ], "format": "uuid" }, "inicio": { "type": "string", "format": "date-time" } } }, "ServicoPedidoParaVerificar": { "required": [ "servicoId", "inicio" ], "type": "object", "properties": { "servicoId": { "type": "string", "format": "uuid" }, "inicio": { "type": "string", "format": "date-time" } } }, "ServicoProfissionalInput": { "required": [ "profissionalId", "duracaoActivaMin", "preco" ], "type": "object", "properties": { "profissionalId": { "type": "string", "format": "uuid" }, "duracaoActivaMin": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "preco": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "SimularPromocoesQuery": { "required": [ "linhas" ], "type": "object", "properties": { "linhas": { "type": "array", "items": { "$ref": "#/components/schemas/LinhaSimulacao" } }, "clienteId": { "type": [ "null", "string" ], "format": "uuid" }, "lojaId": { "type": [ "null", "string" ], "format": "uuid" }, "metodosPagamento": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } }, "agora": { "type": [ "null", "string" ], "format": "date-time" }, "promocaoEmTeste": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DadosPromocao" } ] }, "substituiPromocaoId": { "type": [ "null", "string" ], "format": "uuid" } } }, "SituacaoContasAPagar": { "enum": [ "EmAberto", "Vencidas", "Pagas", "Todas" ] }, "SituacaoContasAReceber": { "enum": [ "EmAberto", "Vencidas", "Pagas", "Todas" ] }, "SituacaoPromocao": { "enum": [ "Rascunho", "Agendada", "Activa", "Pausada", "Terminada", null ] }, "SolicitarReservaEstoqueCommand": { "required": [ "produtoId", "armazemOrigemId", "armazemDestinoId", "quantidade", "observacao" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "armazemOrigemId": { "type": "string", "format": "uuid" }, "armazemDestinoId": { "type": "string", "format": "uuid" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "observacao": { "type": [ "null", "string" ] }, "lojaDestinoId": { "type": [ "null", "string" ], "format": "uuid" }, "clienteId": { "type": [ "null", "string" ], "format": "uuid" } } }, "TaxaRetencaoDto": { "required": [ "id", "descricao", "taxa", "normaAplicavel" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "descricao": { "type": "string" }, "taxa": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "normaAplicavel": { "type": [ "null", "string" ] } } }, "TecnicoPedido": { "required": [ "tecnicoUserId" ], "type": "object", "properties": { "tecnicoUserId": { "type": [ "null", "string" ], "format": "uuid" } } }, "TempoPadraoInput": { "required": [ "categoria", "minutos" ], "type": "object", "properties": { "categoria": { "type": "string" }, "minutos": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "TerminarAcordoRequest": { "required": [ "data", "motivo" ], "type": "object", "properties": { "data": { "type": "string", "format": "date" }, "motivo": { "type": "string" } } }, "TermoPedido": { "required": [ "aceitePor" ], "type": "object", "properties": { "aceitePor": { "type": "string" } } }, "TermosInput": { "required": [ "duracaoEmMeses", "preAvisoDias", "renovacao", "renovacaoMeses", "limiteDeRenovacoes", "revisao", "percentagemDeRevisao", "prazoPagamentoDias", "condicoes", "linhas" ], "type": "object", "properties": { "duracaoEmMeses": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "preAvisoDias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "renovacao": { "$ref": "#/components/schemas/RenovacaoDoContrato" }, "renovacaoMeses": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "limiteDeRenovacoes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "revisao": { "$ref": "#/components/schemas/RevisaoDePreco" }, "percentagemDeRevisao": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "prazoPagamentoDias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "condicoes": { "type": [ "null", "string" ] }, "linhas": { "type": "array", "items": { "$ref": "#/components/schemas/LinhaInput" } } } }, "TestePedido": { "required": [ "classe", "produto", "realizadoEmUtc", "profissionalId" ], "type": "object", "properties": { "classe": { "type": "string" }, "produto": { "type": [ "null", "string" ] }, "realizadoEmUtc": { "type": [ "null", "string" ], "format": "date-time" }, "profissionalId": { "type": [ "null", "string" ], "format": "uuid" } } }, "TextoRequest": { "required": [ "texto" ], "type": "object", "properties": { "texto": { "type": "string" } } }, "TipoActualizacaoAcidente": { "enum": [ "ComunicacaoIgt", "ComunicacaoInss", "DiasDeAusencia", "Nota" ] }, "TipoAusencia": { "enum": [ "FaltaJustificada", "FaltaInjustificada", "Doenca", "Maternidade", "Paternidade", "Casamento", "Luto", "LicencaSemVencimento", "AcidenteDeTrabalho", "TrabalhadorEstudante", "Outra", null ] }, "TipoCatalogoProduto": { "enum": [ "Categoria", "Unidade", "Marca", "Modelo", "Fabricante", "Tamanho" ] }, "TipoCategoriaFinanceira": { "enum": [ "Receita", "Despesa", null ] }, "TipoContratoTrabalho": { "enum": [ "Indeterminado", "TermoCerto", "TermoIncerto", "Estagio" ] }, "TipoDeContrato": { "enum": [ "ServicosPeriodicos", "Subscricao", "Aluguer", "ProjectoPorMarcos", "Consumo", "ManutencaoComSla", "Fornecimento", "Outro" ] }, "TipoDeDocumentoDoContrato": { "enum": [ "Proposta", "ContratoAssinado", "Adenda", "AnexoTecnico", "Comprovativo", "Outro" ] }, "TipoDeExcepcao": { "enum": [ "Feriado", "Ferias", "Folga", "Baixa", "Formacao", "Fechado", "Pausa", "HorarioEspecial" ] }, "TipoDeIncidente": { "enum": [ "Perdida", "Trocada", "Danificada", "NodoaNaoSaiu", "Atraso", "ObjectoEstranho", "Outro" ] }, "TipoDeItem": { "enum": [ "Peca", "Saco" ] }, "TipoDeMaquina": { "enum": [ "Lavar", "Secar", "LavarASeco", "Calandra", "Prensa", "Tunel" ] }, "TipoDeRecurso": { "enum": [ "Cadeira", "Sala", "Equipamento", "Outro" ] }, "TipoDescontoProgramado": { "enum": [ "Adiantamento", "Emprestimo", "Penhora", "Outro", null ] }, "TipoDeSegmento": { "enum": [ "Activo", "Pausa", "Recurso" ] }, "TipoDocumentoDto": { "required": [ "id", "descricao", "categoria", "naturezaDocumento", "movimentaEstoque", "tipoMovimentoDocumento", "contaCorrente", "siglaDocumento", "tipoLancamentoCliente", "categoriaSaft", "requerAssinatura" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "descricao": { "type": "string" }, "categoria": { "type": "string" }, "naturezaDocumento": { "type": "string" }, "movimentaEstoque": { "type": "boolean" }, "tipoMovimentoDocumento": { "type": "string" }, "contaCorrente": { "type": "boolean" }, "siglaDocumento": { "type": "string" }, "tipoLancamentoCliente": { "type": [ "null", "string" ] }, "categoriaSaft": { "type": "string" }, "requerAssinatura": { "type": "boolean" } } }, "TipoDocumentoEntradaEstoque": { "enum": [ "FacturaRecibo", "Factura" ] }, "TipoDocumentoFornecedor": { "enum": [ "FT", "FR", "GF", "FG", "AC", "AR", "TV", "TS", "RE", "NL", "TE", "ND", null ] }, "TipoDocumentoIdentificacao": { "enum": [ "BilheteIdentidade", "Passaporte", "CartaoResidencia" ] }, "TipoEventoDesconto": { "enum": [ "Suspensao", "Retoma" ] }, "TipoEventoLitigio": { "enum": [ "Sessao", "MudancaDeForo", "Documento", "Acordo", "Decisao", "Outro" ] }, "TipoExameMedico": { "enum": [ "Admissao", "Periodico", "Demissao", "RegressoAoTrabalho" ] }, "TipoFaseDisciplinar": { "enum": [ "Ocorrencia", "NotaDeCulpa", "ConvocatoriaAudicao", "AudicaoPrevia", "RespostaDoTrabalhador", "ParecerSindical", "RelatorioFinal", "Diligencia", "SancaoAplicada", "Arquivamento" ] }, "TipoFeriado": { "enum": [ "Nacional", "Municipal", "Empresa", "Tolerancia" ] }, "TipoInventarioFiscal": { "enum": [ "Mercadoria", "MateriaPrima", "ProdutoAcabado", "Subproduto", "TrabalhoEmCurso", "ActivoBiologico", null ] }, "TipoLinhaCessacao": { "enum": [ "FeriasNaoGozadas", "SubsidioFeriasProporcional", "SubsidioNatalProporcional", "Indemnizacao", "SaldoDescontoProgramado", "Manual" ] }, "TipoMarcacaoPonto": { "enum": [ "Desconhecido", "Entrada", "Saida" ] }, "TipoMovimentoCliente": { "enum": [ "Debito", "Credito" ] }, "TipoMovimentoDesconto": { "enum": [ "Folha", "AbatimentoManual", "Estorno" ] }, "TipoProduto": { "enum": [ "Produto", "Servico" ] }, "TipoPromocao": { "enum": [ "LeveXPagueY", "PercentagemDesconto", "DescontoValor", "PrecoEspecial", "PrecoPorQuantidade", "Conjunto", "OfertaArtigo", "DescontoCompraTotal", "PrecoCliente" ] }, "TipoSubsidioExtraordinario": { "enum": [ "Natal", "Ferias" ] }, "TotalMapaDto": { "required": [ "rotulo", "valor" ], "type": "object", "properties": { "rotulo": { "type": "string" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "tipo": { "type": "string", "default": "moeda" } } }, "TrabalhoDeOperacaoPedido": { "required": [ "operacaoId", "urgencia", "notas", "comPecas" ], "type": "object", "properties": { "operacaoId": { "type": "string", "format": "uuid" }, "urgencia": { "type": [ "null", "string" ] }, "notas": { "type": [ "null", "string" ] }, "comPecas": { "type": "boolean" } } }, "TrabalhoPedido": { "required": [ "nome", "notas", "urgencia", "operacaoId", "garantiaDias", "garantiaKm", "linhas" ], "type": "object", "properties": { "nome": { "type": "string" }, "notas": { "type": [ "null", "string" ] }, "urgencia": { "type": [ "null", "string" ] }, "operacaoId": { "type": [ "null", "string" ], "format": "uuid" }, "garantiaDias": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "garantiaKm": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "linhas": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/LinhaPedido" } } } }, "TransferenciaEstoqueDetalheDto": { "required": [ "id", "numero", "data", "armazemOrigemId", "armazemOrigemDescricao", "armazemDestinoId", "armazemDestinoDescricao", "autorizadoPor", "observacao", "total", "lojaOrigemId", "lojaOrigemNome", "lojaDestinoId", "lojaDestinoNome", "estado", "dataResolucao", "motivoRejeicao" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "numero": { "type": "string" }, "data": { "type": "string", "format": "date-time" }, "armazemOrigemId": { "type": "string", "format": "uuid" }, "armazemOrigemDescricao": { "type": "string" }, "armazemDestinoId": { "type": "string", "format": "uuid" }, "armazemDestinoDescricao": { "type": "string" }, "autorizadoPor": { "type": "string" }, "observacao": { "type": [ "null", "string" ] }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "lojaOrigemId": { "type": "string", "format": "uuid" }, "lojaOrigemNome": { "type": "string" }, "lojaDestinoId": { "type": "string", "format": "uuid" }, "lojaDestinoNome": { "type": "string" }, "estado": { "type": "string" }, "dataResolucao": { "type": [ "null", "string" ], "format": "date-time" }, "motivoRejeicao": { "type": [ "null", "string" ] }, "itens": { "type": "array", "items": { "$ref": "#/components/schemas/TransferenciaEstoqueItemDto" } }, "identidade": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/IdentidadeDeDocumentoDto" } ] } } }, "TransferenciaEstoqueItemDto": { "required": [ "produtoId", "produtoNome", "loteId", "loteDescricao", "quantidade", "precoUnitario" ], "type": "object", "properties": { "produtoId": { "type": "string", "format": "uuid" }, "produtoNome": { "type": "string" }, "loteId": { "type": [ "null", "string" ], "format": "uuid" }, "loteDescricao": { "type": [ "null", "string" ] }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "precoUnitario": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "TransferenciaEstoqueResumoDto": { "required": [ "id", "numero", "data", "armazemOrigemDescricao", "armazemDestinoDescricao", "autorizadoPor", "total", "lojaOrigemId", "lojaOrigemNome", "lojaDestinoId", "lojaDestinoNome", "estado", "numeroProdutos", "dataResolucao", "motivoRejeicao" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "numero": { "type": "string" }, "data": { "type": "string", "format": "date-time" }, "armazemOrigemDescricao": { "type": "string" }, "armazemDestinoDescricao": { "type": "string" }, "autorizadoPor": { "type": "string" }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "lojaOrigemId": { "type": "string", "format": "uuid" }, "lojaOrigemNome": { "type": "string" }, "lojaDestinoId": { "type": "string", "format": "uuid" }, "lojaDestinoNome": { "type": "string" }, "estado": { "type": "string" }, "numeroProdutos": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "dataResolucao": { "type": [ "null", "string" ], "format": "date-time" }, "motivoRejeicao": { "type": [ "null", "string" ] } } }, "TransferenciaPedido": { "required": [ "novoProprietarioId" ], "type": "object", "properties": { "novoProprietarioId": { "type": "string", "format": "uuid" } } }, "TransferirComandaRequest": { "required": [ "mesaDestinoId" ], "type": "object", "properties": { "mesaDestinoId": { "type": "string", "format": "uuid" } } }, "TransferirEntreContasCommand": { "required": [ "contaOrigemId", "contaDestinoId", "valor" ], "type": "object", "properties": { "contaOrigemId": { "type": "string", "format": "uuid" }, "contaDestinoId": { "type": "string", "format": "uuid" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "descricao": { "type": [ "null", "string" ] } } }, "TrocaPedida": { "required": [ "novoQuartoId", "manterPreco" ], "type": "object", "properties": { "novoQuartoId": { "type": "string", "format": "uuid" }, "manterPreco": { "type": [ "null", "boolean" ] } } }, "TrocarGarcomRequest": { "required": [ "novoGarcomUserId" ], "type": "object", "properties": { "novoGarcomUserId": { "type": "string", "format": "uuid" } } }, "UnidadeDeVenda": { "enum": [ "Peca", "Quilo" ] }, "UnidadesAbrangidas": { "enum": [ "Ambas", "SoBase", "SoAlternativas" ] }, "UnidadeVendaDto": { "required": [ "id", "unidadeId", "nome", "factor", "pvp1", "pvp2", "pvp3", "pvp4" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "unidadeId": { "type": "string", "format": "uuid" }, "nome": { "type": "string" }, "factor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "pvp1": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "pvp2": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "pvp3": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "pvp4": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" } } }, "UnidadeVendaPdvDto": { "required": [ "id", "nome", "factor", "pvp1", "pvp2", "pvp3", "pvp4" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "nome": { "type": "string" }, "factor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "pvp1": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "pvp2": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "pvp3": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "pvp4": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "UpdateArmazemRequest": { "required": [ "descricao", "localizacao" ], "type": "object", "properties": { "descricao": { "type": "string" }, "localizacao": { "type": "string" } } }, "UpdateClienteRequest": { "required": [ "nome", "endereco", "numeroContribuinte", "isConsumidorFinal", "email", "telefone", "telemovel", "fax", "website", "municipioId", "taxaRetencaoId", "enviarAlertas", "enviarDocumentos", "observacao", "especial", "pvpPreferido", "condicaoPagamentoId", "desconto", "limiteCredito" ], "type": "object", "properties": { "nome": { "type": "string" }, "endereco": { "type": "string" }, "numeroContribuinte": { "type": [ "null", "string" ] }, "isConsumidorFinal": { "type": "boolean" }, "email": { "type": [ "null", "string" ] }, "telefone": { "type": [ "null", "string" ] }, "telemovel": { "type": [ "null", "string" ] }, "fax": { "type": [ "null", "string" ] }, "website": { "type": [ "null", "string" ] }, "municipioId": { "type": [ "null", "string" ], "format": "uuid" }, "taxaRetencaoId": { "type": [ "null", "string" ], "format": "uuid" }, "enviarAlertas": { "type": "boolean" }, "enviarDocumentos": { "type": "boolean" }, "observacao": { "type": [ "null", "string" ] }, "especial": { "type": "boolean" }, "pvpPreferido": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NivelPreco" } ] }, "condicaoPagamentoId": { "type": [ "null", "string" ], "format": "uuid" }, "desconto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "limiteCredito": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "pessoaSingular": { "type": "boolean", "default": false } } }, "UpdateFornecedorRequest": { "required": [ "nome", "numeroContribuinte", "telefone", "municipioId", "email", "endereco", "contacto", "website", "fax", "codigoPostal", "observacao" ], "type": "object", "properties": { "nome": { "type": "string" }, "numeroContribuinte": { "type": "string" }, "telefone": { "type": "string" }, "municipioId": { "type": [ "null", "string" ], "format": "uuid" }, "email": { "type": [ "null", "string" ] }, "endereco": { "type": [ "null", "string" ] }, "contacto": { "type": [ "null", "string" ] }, "website": { "type": [ "null", "string" ] }, "fax": { "type": [ "null", "string" ] }, "codigoPostal": { "type": [ "null", "string" ] }, "observacao": { "type": [ "null", "string" ] }, "nifEmAngola": { "type": [ "null", "boolean" ] }, "pais": { "type": [ "null", "string" ] }, "cidade": { "type": [ "null", "string" ] } } }, "UpdateLojaRequest": { "required": [ "nome", "endereco" ], "type": "object", "properties": { "nome": { "type": "string" }, "endereco": { "type": [ "null", "string" ] }, "limiteAlertaSaldoGaveta": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "toleranciaQuebraFechoCaixa": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double", "default": 0 }, "fechamentoCegoActivo": { "type": "boolean", "default": true }, "municipioId": { "type": [ "null", "string" ], "format": "uuid" } } }, "UpdateLoteRequest": { "required": [ "descricao" ], "type": "object", "properties": { "descricao": { "type": "string" }, "validade": { "type": [ "null", "string" ], "format": "date-time" } } }, "UpdateProdutoRequest": { "required": [ "nome", "impostoId", "motivoIsencaoIvaId", "informarPrecoNoPdv", "precoCusto", "valorCIF", "despesasTransporte", "despesasArmazenagem", "encargosAduaneiros", "despesasBancarias", "encargosGerais", "margemPvp1", "margemPvp2", "margemPvp3", "margemPvp4", "codigoInterno", "codigoBarra", "descricao", "categoriaId", "unidadeId", "marcaId", "modeloId", "fabricanteId", "tamanhoId", "fornecedorId", "taxaRetencaoId", "estocavel", "estoqueMinimo", "controlarValidade", "variado", "itemCozinha", "mostrarDescricaoNaFactura", "paisOrigemId", "origem", "peso", "comprimento", "largura", "altura" ], "type": "object", "properties": { "nome": { "type": "string" }, "impostoId": { "type": "string", "format": "uuid" }, "motivoIsencaoIvaId": { "type": [ "null", "string" ], "format": "uuid" }, "informarPrecoNoPdv": { "type": "boolean" }, "precoCusto": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "valorCIF": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "despesasTransporte": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "despesasArmazenagem": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "encargosAduaneiros": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "despesasBancarias": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "encargosGerais": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "margemPvp1": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "margemPvp2": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "margemPvp3": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "margemPvp4": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "codigoInterno": { "type": [ "null", "string" ] }, "codigoBarra": { "type": [ "null", "string" ] }, "descricao": { "type": [ "null", "string" ] }, "categoriaId": { "type": [ "null", "string" ], "format": "uuid" }, "unidadeId": { "type": [ "null", "string" ], "format": "uuid" }, "marcaId": { "type": [ "null", "string" ], "format": "uuid" }, "modeloId": { "type": [ "null", "string" ], "format": "uuid" }, "fabricanteId": { "type": [ "null", "string" ], "format": "uuid" }, "tamanhoId": { "type": [ "null", "string" ], "format": "uuid" }, "fornecedorId": { "type": [ "null", "string" ], "format": "uuid" }, "taxaRetencaoId": { "type": [ "null", "string" ], "format": "uuid" }, "estocavel": { "type": "boolean" }, "estoqueMinimo": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "controlarValidade": { "type": "boolean" }, "variado": { "type": "boolean" }, "itemCozinha": { "type": "boolean" }, "mostrarDescricaoNaFactura": { "type": "boolean" }, "paisOrigemId": { "type": [ "null", "string" ], "format": "uuid" }, "origem": { "type": [ "null", "string" ] }, "peso": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "comprimento": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "largura": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "altura": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "null", "number", "string" ], "format": "double" }, "precificacaoAvancada": { "type": "boolean", "default": false }, "tipoInventarioFiscal": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/TipoInventarioFiscal" } ] }, "paraVenda": { "type": [ "null", "boolean" ] }, "controlarLote": { "type": [ "null", "boolean" ] } } }, "UtilizacaoCreditoDto": { "required": [ "id", "tipo", "valor", "data", "contaAPagarId", "contaAPagarNumero", "receitaAvulsaId", "estornoDaUtilizacaoId", "estornada", "motivo", "registadaEmUtc" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "tipo": { "type": "string" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "data": { "type": "string", "format": "date-time" }, "contaAPagarId": { "type": [ "null", "string" ], "format": "uuid" }, "contaAPagarNumero": { "type": [ "null", "string" ] }, "receitaAvulsaId": { "type": [ "null", "string" ], "format": "uuid" }, "estornoDaUtilizacaoId": { "type": [ "null", "string" ], "format": "uuid" }, "estornada": { "type": "boolean" }, "motivo": { "type": [ "null", "string" ] }, "registadaEmUtc": { "type": "string", "format": "date-time" } } }, "ValoresFiscaisCategoriaRequest": { "required": [ "naturezaCompra" ], "type": "object", "properties": { "naturezaCompra": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/NaturezaCompraFiscal" } ] } } }, "VendaItemDto": { "required": [ "documentoId", "data", "siglaDocumento", "numero", "clienteNome", "quantidade", "precoUnitario", "total" ], "type": "object", "properties": { "documentoId": { "type": "string", "format": "uuid" }, "data": { "type": "string", "format": "date-time" }, "siglaDocumento": { "type": "string" }, "numero": { "type": "string" }, "clienteNome": { "type": [ "null", "string" ] }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "precoUnitario": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "VendaMensalDto": { "required": [ "mes", "produtoId", "produto", "quantidade", "valor" ], "type": "object", "properties": { "mes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "produtoId": { "type": "string", "format": "uuid" }, "produto": { "type": "string" }, "quantidade": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "valor": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?$", "type": [ "number", "string" ], "format": "double" } } }, "VerificacaoCadeiaDto": { "required": [ "lojaId", "tipoDocumentoId", "sigla", "ano", "totalDocumentos", "assinaturasVerificadas", "assinaturasNaoVerificaveis", "integra", "problemas", "problemasTruncados" ], "type": "object", "properties": { "lojaId": { "type": "string", "format": "uuid" }, "tipoDocumentoId": { "type": "string", "format": "uuid" }, "sigla": { "type": "string" }, "ano": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "totalDocumentos": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "assinaturasVerificadas": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "assinaturasNaoVerificaveis": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "integra": { "type": "boolean" }, "problemas": { "type": "array", "items": { "$ref": "#/components/schemas/ProblemaCadeiaDto" } }, "problemasTruncados": { "type": "boolean" } } }, "VerificarPedidoQuery": { "required": [ "clienteId", "servicos" ], "type": "object", "properties": { "clienteId": { "type": "string", "format": "uuid" }, "servicos": { "type": "array", "items": { "$ref": "#/components/schemas/ServicoPedidoParaVerificar" } } } }, "ViaturaPedido": { "required": [ "matricula", "vin", "dados" ], "type": "object", "properties": { "matricula": { "type": "string" }, "vin": { "type": [ "null", "string" ] }, "dados": { "$ref": "#/components/schemas/DadosDaViaturaPedido" } } } }, "securitySchemes": { "ChaveApi": { "type": "apiKey", "description": "A chave criada em Definições › Chaves de API. Trate-a como uma palavra-passe.", "name": "X-Api-Key", "in": "header" } } }, "tags": [ { "name": "RH - Rubricas" }, { "name": "RH - Assiduidade" }, { "name": "RH - Auditoria" }, { "name": "RH - Parâmetros legais" }, { "name": "SAF-T" }, { "name": "AnySoftSaaSWeb.Api" }, { "name": "Produtos" }, { "name": "Promoções" }, { "name": "Clientes" }, { "name": "Fornecedores" }, { "name": "RH - Estrutura" }, { "name": "RH - Trabalhadores" }, { "name": "RH - Configuração" }, { "name": "RH - Calendário" }, { "name": "RH - Férias" }, { "name": "RH - Trabalho suplementar" }, { "name": "RH - Ponto" }, { "name": "RH - Subsídios de férias e de Natal" }, { "name": "RH - Lançamentos variáveis" }, { "name": "RH - Descontos" }, { "name": "RH - Folha de salários" }, { "name": "RH - Cessações" }, { "name": "RH - Disciplinar" }, { "name": "RH - Contencioso" }, { "name": "RH - HST" }, { "name": "RH - Activos" }, { "name": "RH - Avaliações" }, { "name": "RH - Acordos colectivos" }, { "name": "RH - Diuturnidades" }, { "name": "RH - Denúncias" }, { "name": "Estoque - Armazéns" }, { "name": "Estoque - Lotes" }, { "name": "Estoque - Saldos" }, { "name": "Estoque - Entradas" }, { "name": "Estoque - Saídas Manuais" }, { "name": "Estoque - Entradas Manuais" }, { "name": "Estoque - Transferências" }, { "name": "Estoque - Reservas Inter-Lojas" }, { "name": "Estoque - Reservas a Clientes" }, { "name": "Diversos - Métodos de Pagamento" }, { "name": "Diversos - Moedas" }, { "name": "Diversos - Tributos" }, { "name": "Diversos - Geografia" }, { "name": "Catálogos" }, { "name": "Documentos - Tipos" }, { "name": "Documentos - Séries" }, { "name": "Documentos" }, { "name": "Documentos - Condições de pagamento" }, { "name": "Relatórios" }, { "name": "Visão 360°" }, { "name": "Pesquisa" }, { "name": "Estoque - Encomendas" }, { "name": "Empresa" }, { "name": "Caixa" }, { "name": "Caixa - Terminais" }, { "name": "Lojas" }, { "name": "Eventos" }, { "name": "Avenças" }, { "name": "Financeiro - Contas a Pagar" }, { "name": "Financeiro - Contas a Receber" }, { "name": "Financeiro - Fluxo de Caixa" }, { "name": "Financeiro - Despesas Recorrentes" }, { "name": "Financeiro - Mapa de Fornecedores" }, { "name": "Financeiro - Categorias" }, { "name": "Financeiro - Centros de Custo" }, { "name": "Financeiro - Créditos de Fornecedores" }, { "name": "Financeiro - Conciliação Bancária" }, { "name": "Financeiro - Fecho de Período" }, { "name": "Financeiro - Contas" }, { "name": "Financeiro - Transferências" }, { "name": "Financeiro - Receitas avulsas" }, { "name": "Financeiro - Lançamentos" }, { "name": "FacturacaoElectronica" }, { "name": "Produção" }, { "name": "Restauração" }, { "name": "Contratos" }, { "name": "Marcações" }, { "name": "Lavandaria" }, { "name": "Beleza" }, { "name": "Oficina" }, { "name": "Hospedagem" } ] }