swagger: "2.0" info: description: "Documentação técnica de webservices ReST disponibilizados na Plataforma de Serviços de Interoperabilidade para testes." version: "1.0" title: "PSI Swagger" contact: name: "plataformaservicos@seg-social.pt" basePath: "/ptss/rest" tags: - name: "Valores Comunicados" - name: "Valores Apurados" - name: "Pedidos de Comunicação de Valores" - name: "Ficheiros" - name: "Avisos" schemes: - "https" paths: /eeaoc/valores-comunicados/entidade-empregadora/{niss-ee}: get: tags: - "Valores Comunicados" summary: "EEAO-O016" operationId: "consultarValoresComunicadosPorProcessar" consumes: - "application/json" produces: - "application/json" parameters: - name: "niss-ee" in: "path" description: "Número de identificação na Segurança Social da entidade empregadora a verificar valores comunicados a processar" required: true type: "integer" format: "int64" x-example: 29999999999 - name: "estado" in: "query" description: "Indicar o estado EM_PROCESSAMENTO para obter os comprovativos dos valores que estão ainda em processamento." required: false type: "string" x-example: "EM_PROCESSAMENTO" responses: 200: description: "Operação efetuada com sucesso. São devolvidas as listas de comprovativos dos valores comunicados que foram enviados e estão em processamento ou que já foram processados, mas não integrados devido a alguma falha de consistência, estrutura ou exigibilidade." examples: application/json: semAlertas: - comprovativoEntrega: "0bf8ad2a-679c-429c-be3a-f72083012468" comAlertas: - comprovativoEntrega: "0bf8ad2a-679c-429c-be3a-f72083012468" schema: $ref: "#/definitions/valores-comunicados-por-processar" 400: description: "Pedido inválido" examples: application/json: code: 400 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 403: description: "Operação não permitida" examples: application/json: code: 403 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 500: description: "Erro interno do servidor" examples: application/json: code: 500 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" /eeaoc/valores-remuneracao/entidade-empregadora/{niss-ee}: post: tags: - "Valores Comunicados" summary: "EEAO-O005" operationId: "envioValoresRemuneracao" consumes: - "application/json" produces: - "application/json" parameters: - name: "niss-ee" in: "path" description: "Número de identificação na Segurança Social da entidade empregadora a comunicar" required: true type: "integer" format: "int64" x-example: 29999999999 - in: "body" name: "body" required: false schema: $ref: "#/definitions/valores-comunicados-input" responses: 201: description: "Operação efetuada com sucesso" examples: application/json: comprovativoEntrega: "fe755ea3-a0f9-40f1-9479-ea7b1a63fa78" schema: $ref: "#/definitions/EnviarValoresRemuneracaoDTO" 400: description: "Pedido inválido" examples: application/json: code: 400 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 403: description: "Operação não permitida" examples: application/json: code: 403 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 500: description: "Erro interno do servidor" examples: application/json: code: 500 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" /eeaoc/valores-comunicados/entidade-empregadora/{niss-ee}/comprovativo/{comprovativo}: get: tags: - "Valores Comunicados" summary: "EEAO-O007" operationId: "consultarValoresComunicados" consumes: - "application/json" produces: - "application/json" parameters: - name: "niss-ee" in: "path" description: "Número de identificação na Segurança Social da entidade empregadora a comunicar" required: true type: "integer" format: "int64" x-example: 29999999999 - name: "comprovativo" in: "path" description: "Identifica o comprovativo obtido aquando da comunicação dos valores por parte das entidades" required: true type: "string" x-example: "fe755ea3-a0f9-40f1-9479-ea7b1a63fa78" responses: 200: description: "Operação efetuada com sucesso. É devolvida a lista de valores comunicados ou devolve uma lista vazia quando não foram encontrados valores para o comprovativo de entrega pesquisado. " examples: application/json: dataComunicacao: "25/07/2024" nissEE: 20000073142 nissEntrega: 20000073212 valores: - anoMes: "202403" dias: 15.5 estado: "Substituído" naturezaRemuneracao: "P" nissTrabalhador: 10140899349 tipoQualificacao: "MOE" valor: 931.32 schema: $ref: "#/definitions/valores-comunicados-output" 400: description: "Pedido inválido" examples: application/json: code: 400 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 403: description: "Operação não permitida" examples: application/json: code: 403 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 500: description: "Erro interno do servidor" examples: application/json: code: 500 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" /eeaoc/valores-comunicados/entidade-empregadora/{niss-ee}/comprovativo: get: tags: - "Valores Comunicados" summary: "EEAO-O006" operationId: "consultarComprovativosEntrega" consumes: - "application/json" produces: - "application/json" parameters: - name: "niss-ee" in: "path" description: "Número de identificação na Segurança Social da entidade empregadora\ \ a comunicar" required: true type: "integer" format: "int64" x-example: 29999999999 - name: "periodo-inicial" in: "query" description: "Identifica o período inicial de comunicação a pesquisar" required: false type: "string" format: "yyyy-MM-dd" x-example: "2026-01-01" - name: "periodo-final" in: "query" description: "Identifica o período final de comunicação a pesquisar" required: false type: "string" format: "yyyy-MM-dd" x-example: "2026-01-02" - name: "identificacao-comunicacao" in: "query" description: "Código identificativo que é obtido aquando da comunicação dos valores por parte da entidade." required: false type: "string" x-example: "fe755ea3-a0f9-40f1-9479-ea7b1a63fa78" responses: 200: description: "Operação efetuada com sucesso" examples: application/json: - identificacaoComunicacao: "dcc5b8da-8cc9-4954-b413-7c912d99b7f5" identificacaoComunicacaoPDF: "33675a14-2af7-4bbf-952e-12a341c5fd21" nissEE: 20000073112 nissEntrega: 20000073112 dataComunicacao: "02/08/2024" numeroRegistos: 12 totalValor: 7203.69 schema: $ref: "#/definitions/ValoresComunicadosComprovativoResponseDTO" 400: description: "Pedido inválido" examples: application/json: code: 400 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 403: description: "Operação não permitida" examples: application/json: code: 403 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 500: description: "Erro interno do servidor" examples: application/json: code: 500 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" /eeaoc/valores-comunicados/entidade-empregadora/{niss-ee}/alertas: get: tags: - "Valores Comunicados" summary: "EEAO-O017" operationId: "alertas" consumes: - "application/json" produces: - "application/json" parameters: - name: "niss-ee" in: "path" description: "Número de identificação na Segurança Social da entidade empregadora a comunicar" required: true type: "integer" format: "int64" x-example: 29999999999 - name: "comprovativo" in: "query" description: "Identifica o comprovativo obtido aquando da comunicação dos valores por parte das entidades" required: false type: "string" - name: "niss-trabalhador" in: "query" description: "Número de identificação na Segurança Social do trabalhador a comunicar" required: false type: "integer" format: "int64" x-example: 19999999999 - name: "ano-mes-inicio" in: "query" description: "Identifica o ano-mês de inicio do período para o qual a EE pretende realizar a consulta" required: false type: "string" format: "yyyyMM" x-example: "202601" - name: "ano-mes-fim" in: "query" description: "Identifica o ano-mês de fim do período para o qual a EE pretende realizar a consulta" required: false type: "string" format: "yyyyMM" x-example: "202602" responses: 200: description: "Operação efetuada com sucesso" examples: application/json: - resumoAlerta: "O número de dias comunicado excede o número de dias de trabalho permitido para a natureza indicada." descricaoAlerta: "O número de dias comunicado excede o número de dias de trabalho permitido para a natureza indicada." valorComunicado: nissEE: 20000073112 nissEntrega: 20000073112 dataComunicacao: "2024-09-09" comprovativoEntrega: "d517ad6a-27bf-4fc2-9aed-240cc6277c26" nissTrabalhador: 10987654321 anoMes: "202406" tipoQualificacao: "TCO" naturezaRemuneracao: "P" dias: 32 valor: 1234.56 schema: $ref: "#/definitions/valores-comunicados-alertas-output" 400: description: "Pedido inválido" examples: application/json: code: 400 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 403: description: "Operação não permitida" examples: application/json: code: 403 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 500: description: "Erro interno do servidor" examples: application/json: code: 500 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" /eeaoc/valores-apurados/entidade-empregadora/{niss-ee}/ano-mes/{ano-mes}/trabalhador/{niss-trabalhador}: get: tags: - "Valores Apurados" summary: "EEAO-O029" operationId: "consultarValoresApuradosTrabalhador" consumes: - "application/json" produces: - "application/json" parameters: - name: "niss-ee" in: "path" description: "Número de identificação na Segurança Social da entidade empregadora a verificar valores apurados" required: true type: "integer" format: "int64" x-example: 20000000001 - name: "ano-mes" in: "path" description: "Identifica o ano-mês para o qual se pretende obter os valores" required: true type: "string" x-example: 202412 - name: "niss-trabalhador" in: "path" description: "Número de identificação na Segurança Social do trabalhador para o qual se pretende obter os valores" required: true type: "integer" x-example: 10000000001 format: "int64" responses: 200: description: "Operação efetuada com sucesso" examples: application/json: anoMes: "202509" nissTrabalhador: 10000000001 totalRemuneracao: 1520 totalContribuicao: 528.20 totalReducao: 0 totalObrigacao: 528.20 remuneracoes: - dataInicio: "2022-01-01" dataFim: null natureza: "P" remuneracao: 1520 diasTrabalho: 30 origem: "Seguranca_Social" diasInatividade: 0 inatividades: [] contribuicoes: - dataInicio: "2022-01-01" dataFim: null enquadramento: "Regime geral" valorCotizacao: 167.20 taxaCotizacao: 11 valorComplementarCotizacao: 0 taxaComplementarCotizacao: 0 valorContribuicao: 361.0 taxaContribuicao: 23.75 valorComplementarContribuicao: 0 taxaComplementarContribuicao: 0 obrigacao: 528.20 detalhesContribuicao: - natureza: P enquadramento: "Regime geral" motivo: "MENSAL" tipo: "Contribuicao" valor: 361.0 valoresDataLimitePagamento: valor: 361.0 dataLimitePagamento: "2025-11-25" - natureza: P enquadramento: "Regime geral" motivo: "MENSAL" tipo: "Cotizacao" valor: 167.20 valoresDataLimitePagamento: valor: 167.20 dataLimitePagamento: "2025-11-25" schema: $ref: "#/definitions/ValoresApuradosDetalheTrabalhadorDTO" 400: description: "Pedido inválido" examples: application/json: code: 400 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 403: description: "Operação não permitida" examples: application/json: code: 403 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 500: description: "Erro interno do servidor" examples: application/json: code: 500 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" /eeaoc/valores-apurados/entidade-empregadora/{niss-ee}/anual/{ano}: get: tags: - "Valores Apurados" summary: "EEAO-O027" operationId: "consultarValoresApuradosAnual" consumes: - "application/json" produces: - "application/json" parameters: - name: "niss-ee" in: "path" description: "Número de identificação na Segurança Social da entidade empregadora para a qual se pretende consultar os valores" required: true type: "integer" format: "int64" x-example: 20000000001 - name: "ano" in: "path" description: "Identifica o ano para o qual se pretendem consultar os valores" required: true type: "string" x-example: "2026" responses: 200: description: "Operação efetuada com sucesso" examples: application/json: dataAdesao: "2025-03-03" nissTrabalhador: 10000000001 obrigacoesContributivas: anoMes: "202401" totalTrabalhadores: 1 remuneracao: 1515 obrigacao: 526.46 estado: "APURADO" schema: $ref: "#/definitions/ConsultarValoresApuradosAnualDTO" 400: description: "Pedido inválido" examples: application/json: code: 400 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 403: description: "Operação não permitida" examples: application/json: code: 403 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 500: description: "Erro interno do servidor" examples: application/json: code: 500 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" /eeaoc/valores-apurados/entidade-empregadora/{niss-ee}/mensal/ano-mes/{ano-mes}: get: tags: - "Valores Apurados" summary: "EEAO-O028" operationId: "consultarValoresApuradosMensal" consumes: - "application/json" produces: - "application/json" parameters: - name: "niss-ee" in: "path" description: "Número de identificação na Segurança Social da entidade empregadora para a qual se pretende consultar os valores" required: true type: "integer" format: "int64" x-example: 20000000001 - name: "ano-mes" in: "path" description: "Identifica o ano-mês para o qual se pretendem obter os valores" required: true type: "string" x-example: 202512 responses: 200: description: "Operação efetuada com sucesso" examples: application/json: anoMes: "202401" totalTrabalhadores: 1 totalRemuneracao: 1515 totalContribuicao: 526.46 totalReducao: 0 obrigacao: 526.46 remuneracoes: - natureza: "P" remuneracao: 1515 contribuicoes: - enquadramento: "Regime geral" contribuicao: 526.46 reducoes: [] schema: $ref: "#/definitions/ConsultaValoresApuradosMensalDTO" 400: description: "Pedido inválido" examples: application/json: code: 400 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 403: description: "Operação não permitida" examples: application/json: code: 403 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 500: description: "Erro interno do servidor" examples: application/json: code: 500 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" /eeaoc/avisos/{niss-ee}: get: tags: - "Avisos" summary: "EEAO-O083" operationId: "consultarAvisos" consumes: - "application/json" produces: - "application/json" parameters: - name: "niss-ee" in: "path" description: "Número de identificação na Segurança Social da entidade empregadora a verificar avisos" required: true type: "integer" format: "int64" x-example: 29999999999 responses: 200: description: "Operação efetuada com sucesso" examples: application/json: resumoAviso: "Pedido de comunicação de valores em Audiência Prévia" descricaoAviso: "O seu pedido de comunicação de valores foi analisado e encontra-se em Audiência Prévia" schema: $ref: "#/definitions/ConsultaAvisosDTO" 400: description: "Pedido inválido" examples: application/json: code: 400 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 403: description: "Operação não permitida" examples: application/json: code: 403 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 500: description: "Erro interno do servidor" examples: application/json: code: 500 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" /eeaoc/obrigacao-contributiva/entidade-empregadora/{niss-ee}/confirmar: post: tags: - "Valores Apurados" summary: "EEAO-O066" operationId: "ConfirmarValoresApuradosMensal" consumes: - "application/json" produces: - "application/json" parameters: - name: "niss-ee" in: "path" description: "Número de identificação na Segurança Social da entidade empregadora." required: true type: "integer" format: "int64" x-example: 29999999999 responses: 200: description: "Operação efetuada com sucesso" examples: application/json: mensagem: "Confirmação efetuada com sucesso" schema: $ref: "#/definitions/ConfirmacaoObrigacaoContributivaDTO" 400: description: "Pedido inválido" examples: application/json: code: 400 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 403: description: "Operação não permitida" examples: application/json: code: 403 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 500: description: "Erro interno do servidor" examples: application/json: code: 500 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" /eeaoc/entidade-empregadora/{niss-ee}/ano-mes/{ano-mes}/trabalhador: get: tags: - "Valores Apurados" summary: "EEAO-O033" operationId: "consultarObrigacaoContributivaPorTrabalhador" consumes: - "application/json" produces: - "application/json" parameters: - name: "niss-ee" in: "path" description: "Número de identificação na Segurança Social da entidade empregadora para a qual se pretende obter a lista de trabalhadores." required: true type: "integer" format: "int64" x-example: 29999999999 - name: "ano-mes" in: "path" description: "Ano-mês para o qual se pretende obter a lista de trabalhadores." required: true type: "string" x-example: "202503" - name: "num-pagina" in: "query" description: "Número da página da lista de trabalhadores que se pretende obter (inicia em 0)." required: true type: "string" x-example: "0" - name: "tam-pagina" in: "query" description: "Tamanho da página da lista de trabalhadores, ou seja, número de registos por página que se pretende obter (no máximo 50)." required: true type: "string" x-example: "50" responses: 200: description: "Operação efetuada com sucesso" examples: application/json: - nissTrabalhador: 11910857679 diasTrabalho: 30 remuneracao: 1000 obrigacao: 228.75 schema: $ref: "#/definitions/TrabalhadorObrigacaoContributivaMensalDTO" 400: description: "Pedido inválido" examples: application/json: code: 400 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 403: description: "Operação não permitida" examples: application/json: code: 403 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 500: description: "Erro interno do servidor" examples: application/json: code: 500 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" /eeaoc/ficheiros/entidade-empregadora/{niss-ee}/download/{identificador-ficheiro}/{contexto}: get: tags: - "Ficheiros" summary: "EEAO-O082" operationId: "efetuarDownloadFicheiro" consumes: - "application/json" produces: - "application/json" parameters: - name: "niss-ee" in: "path" description: "Número de Identificação na Segurança Social da entidade empregadora" required: true type: "integer" format: "int64" x-example: 29999999999 - name: "identificador-ficheiro" in: "path" description: "Código identificativo do ficheiro a realizar o download" required: true type: "string" x-example: "33675a14-2af7-4bbf-952e-12a341c5fd21" - name: "contexto" in: "path" description: "Contexto do download do ficheiro" required: true type: "string" x-example: "PEDIDO_FORA_PRAZO" responses: 200: description: "Operação efetuada com sucesso" examples: application/json: ficheiro: "dXRpbGl6YWRvcnRlc3RlOnNlbmhhYWNlc3N" mensagem: "Ficheiro descarregado com sucesso" schema: $ref: "#/definitions/DownloadFicheiroDTO" 400: description: "Registo inválido" examples: application/json: code: 400 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 403: description: "Operação não permitida" examples: application/json: code: 403 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 500: description: "Erro interno do servidor" examples: application/json: code: 500 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" /eeaoc/ficheiros/entidade-empregadora/{niss-ee}/upload: post: tags: - "Ficheiros" summary: "EEAO-O078" operationId: "efetuarUploadFicheiro" consumes: - "application/json" produces: - "application/json" parameters: - name: "niss-ee" in: "path" description: "Número de identificação na Segurança Social da entidade empregadora a comunicar" required: true type: "integer" format: "int64" x-example: 29999999999 - in: "body" name: "body" required: false schema: $ref: "#/definitions/UploadFicheiroRequestDTO" responses: 201: description: "Operação efetuada com sucesso" examples: application/json: identificadorFicheiro: "Código identificativo do ficheiro carregado" mensagem: "Ficheiro carregado com sucesso" schema: $ref: "#/definitions/UploadFicheiroDTO" 400: description: "Registo inválido" examples: application/json: code: 400 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 403: description: "Operação não permitida" examples: application/json: code: 403 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 500: description: "Erro interno do servidor" examples: application/json: code: 500 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" /eeaoc/pedido/entidade-empregadora/{niss-ee}: get: tags: - "Pedidos de Comunicação de Valores" summary: "EEAO-O075" operationId: "consultarPedidos" consumes: - "application/json" produces: - "application/json" parameters: - name: "niss-ee" in: "path" description: "Número de Identificação na Segurança Social da Entidade Empregadora." required: true type: "integer" format: "int64" x-example: 29999999999 - name: "num-pagina" in: "query" description: "Número da página da lista de resultados (inicia em 0)." required: true type: "integer" format: "int32" x-example: 0 - name: "tam-pagina" in: "query" description: "Tamanho da página da lista de resultados, ou seja, número de\ \ registos por página que se pretende obter (no máximo 50). " required: true type: "integer" format: "int32" x-example: 50 - name: "data-inicial" in: "query" description: "Data de início do período temporal a pesquisar os pedidos." required: false type: "string" format: "yyyy-MM-dd" x-example: "2026-01-01" - name: "data-final" in: "query" description: "Data de fim do período temporal a pesquisar os pedidos." required: false type: "string" format: "yyyy-MM-dd" x-example: "2026-01-01" - name: "codigo-motivo" in: "query" description: "Código que identifica o motivo do pedido." required: false type: "string" x-example: "SENTENCAS_JUDICIAIS" - name: "estado" in: "query" description: "Estado do pedido." required: false type: "string" x-example: "EM_ANALISE" enum: - "POR_SUBMETER" - "EM_ANALISE" - "EM_AUDIENCIA_PREVIA" - "AUDIENCIA_RESPONDIDA" - "APROVADO" - "NAO_APROVADO" - "ANULADO" - name: "numero-pedido" in: "query" description: "Número do pedido." required: false type: "number" x-example: 2.34567890122025E20 responses: 200: description: "Pedido sucesso" examples: application/json: - dataSubmissao: "2025-03-26" motivo: "Sentenças judiciais" numero: 200000731122025040000 estado: "SUBMETIDO" schema: $ref: "#/definitions/PedidosDTO" 400: description: "Registo inválido" examples: application/json: code: 400 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 403: description: "Operação não permitida" examples: application/json: code: 403 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 500: description: "Erro interno do servidor" examples: application/json: code: 500 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" post: tags: - "Pedidos de Comunicação de Valores" summary: "EEAO-O063" operationId: "criarPedido" consumes: - "application/json" produces: - "application/json" parameters: - name: "niss-ee" in: "path" description: "Número de identificação na Segurança Social da entidade empregadora." required: true type: "integer" format: "int64" x-example: 29999999999 - in: "body" name: "body" required: false schema: $ref: "#/definitions/GestaoPedidoRequestDTO" responses: 201: description: "Pedido sucesso" examples: application/json: mensagem: "Pedido criado com sucesso" numeroPedido: "234567890122025010001" dataExpiracao: "2025-03-01" schema: $ref: "#/definitions/CriarPedidoResponseDTO" 400: description: "Registo inválido" examples: application/json: code: 400 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 403: description: "Operação não permitida" examples: application/json: code: 403 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 500: description: "Erro interno do servidor" examples: application/json: code: 500 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" /eeaoc/pedido/{numero-pedido}: get: tags: - "Pedidos de Comunicação de Valores" summary: "EEAO-O076" operationId: "consultarDetalhePedido" consumes: - "application/json" produces: - "application/json" parameters: - name: "numero-pedido" in: "path" description: "Número do pedido." required: true type: "number" x-example: 200000031132025080002 responses: 200: description: "Pedido sucesso" examples: application/json: - dataSubmissao: "null" estado: "ANULADO" dataEstado: "2025-09-29" dataLimiteEstado: null nomeMotivo: "Sentenças judiciais" descricaoGeralMotivo: "Remunerações a declarar com efeitos retroativos na sequência de sentenças judiciais (Tribunal de Trabalho)" listaInformacoesNecessarias: - nomeCampo: "Explicação do pedido" valorCampo: "Remuneração com efeitos retroativos na sequência de uma sentença judicial." - nomeCampo: "Número do processo judicial" valorCampo: "78521968" listaDocumentos: - nomeDocumentoAnexado: "sentenca.pdf" identificadorFicheiro: "33675a14-2af7-4bbf-952e-12a341c5fa81" listaRegistosHistorico: - dataEstado: "2025-09-29" estado: "ANULADO" - dataEstado: "2025-09-25" estado: "POR_SUBMETER" schema: $ref: "#/definitions/ConsultarDetalhePedidoDTO" 400: description: "Registo inválido" examples: application/json: code: 400 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 403: description: "Operação não permitida" examples: application/json: code: 403 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 500: description: "Erro interno do servidor" examples: application/json: code: 500 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" put: tags: - "Pedidos de Comunicação de Valores" summary: "EEAO-O074" operationId: "atualizarPedido" consumes: - "application/json" produces: - "application/json" parameters: - name: "numero-pedido" in: "path" description: "Número do pedido." required: true type: "number" x-example: 2.34567890122025E20 - in: "body" name: "body" required: false schema: $ref: "#/definitions/GestaoPedidoUpdateRequestServiceDTO" responses: 200: description: "Pedido sucesso" examples: application/json: mensagem: "Pedido atualizado com sucesso" schema: $ref: "#/definitions/AtualizarPedidoResponseDTO" 400: description: "Registo inválido" examples: application/json: code: 400 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 403: description: "Operação não permitida" examples: application/json: code: 403 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 500: description: "Erro interno do servidor" examples: application/json: code: 500 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" /eeaoc/pedido/anular-valor-remuneracao/{niss-ee}/{numero-pedido}: put: tags: - "Pedidos de Comunicação de Valores" summary: "EEAO-O077" operationId: "anularValorRemuneracaoPedido" consumes: - "application/json" produces: - "application/json" parameters: - name: "niss-ee" in: "path" description: "Número de identificação na Segurança Social da entidade empregadora." required: true type: "integer" format: "int64" x-example: 29999999999 - name: "numero-pedido" in: "path" description: "Número do pedido." required: true type: "number" x-example: 2.34567890122025E20 - in: "body" name: "body" required: false schema: $ref: "#/definitions/AnularValorRemuneracaoPedidoRequestDTO" responses: 200: description: "Pedido sucesso" examples: application/json: mensagem: "Pedido atualizado com sucesso" schema: $ref: "#/definitions/AtualizarPedidoResponseDTO" 400: description: "Registo inválido" examples: application/json: code: 400 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 403: description: "Operação não permitida" examples: application/json: code: 403 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 500: description: "Erro interno do servidor" examples: application/json: code: 500 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" /eeaoc/pedido/entidade-empregadora/{niss-ee}/motivos: get: tags: - "Pedidos de Comunicação de Valores" summary: "EEAO-O062" operationId: "consultarListaMotivos" consumes: - "application/json" produces: - "application/json" parameters: - name: "niss-ee" in: "path" description: "Número de identificação na Segurança Social da entidade empregadora\ \ para consultar a lista de Motivos" required: true type: "integer" format: "int64" x-example: 29999999999 responses: 200: description: "Operação efetuada com sucesso" examples: application/json: - codigoMotivo: "SENTENCAS_JUDICIAIS" nomeMotivo: "Sentenças judiciais" descricaoGeralMotivo: "Remunerações a declarar com efeitos retroativos\ \ na sequência de sentenças judiciais (Tribunal de Trabalho)" descricaoFicheirosMotivo: "Deverá anexar o acórdão da sentença judicial" numDocumentosAnexar: 2 campos: - codigoCampo: "NUM_PROCESSO_JUDICIAL" nomeCampo: "Número do Processo Judicial" obrigatorio: "SIM" tipoCampo: "Varchar(25)" listaTrabalhadoresAnoMesesNaturezas: - nissTrabalhador: 19999999999 anoMes: "202601" natureza: "P" schema: $ref: "#/definitions/ConsultaListaMotivosDTO" 400: description: "Registo inválido" examples: application/json: code: 400 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 403: description: "Operação não permitida" examples: application/json: code: 403 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" 500: description: "Erro interno do servidor" examples: application/json: code: 500 message: "Mensagem de erro." schema: $ref: "#/definitions/RetornoValidacaoDTO" definitions: ConsultaListaMotivosTrabalhadoresDTO: type: "object" properties: nissTrabalhador: type: "integer" format: "int64" example: 19999999999 description: "NISS do trabalhador." anoMes: type: "string" example: "202601" description: "Ano-mês de referência." natureza: type: "string" example: "P" description: "Código da natureza da remuneração." ConsultaListaMotivosCamposDTO: type: "object" required: - "codigoCampo" - "nomeCampo" - "obrigatorio" - "tipoCampo" properties: codigoCampo: type: "string" example: "NUM_PROCESSO_JUDICIAL" description: "Código que identifica o campo do motivo." nomeCampo: type: "string" example: "Número do Processo Judicial" description: "Nome do campo." obrigatorio: type: "string" example: "SIM" description: "Indica se o campo deve ser obrigatório ou opcional." tipoCampo: type: "string" example: "Varchar(25)" description: "Tipo de dados do campo." ConsultaListaMotivosDTO: type: "object" required: - "campos" - "codigoMotivo" - "descricaoGeralMotivo" - "nomeMotivo" - "numDocumentosAnexar" properties: codigoMotivo: type: "string" example: "SENTENCAS_JUDICIAIS" description: "Código que identifica o motivo." nomeMotivo: type: "string" example: "Sentenças judiciais" description: "Nome do motivo." descricaoGeralMotivo: type: "string" example: "Remunerações a declarar com efeitos retroativos na sequência de\ \ sentenças judiciais (Tribunal de Trabalho)" description: "Descrição geral do motivo." descricaoFicheirosMotivo: type: "string" example: "Deverá anexar o acórdão da sentença judicial" description: "Descrição dos ficheiros a anexar para o motivo." numDocumentosAnexar: type: "integer" format: "int32" example: 2 description: "Quantidade de ficheiros obrigatórios a anexar." campos: type: "array" description: "Lista de campos definidos para o motivo e suas características" items: $ref: "#/definitions/ConsultaListaMotivosCamposDTO" listaTrabalhadoresAnoMesesNaturezas: type: "array" description: "Lista de trabalhadores, anos-meses e naturezas (opcional e só definido para motivos específicos)" items: $ref: "#/definitions/ConsultaListaMotivosTrabalhadoresDTO" ConsultarDetalhePedidoHistoricoDTO: type: "object" properties: dataEstado: type: "string" example: "2025-01-20" description: "Data do estado." estado: type: "string" example: "Em análise" description: "Estado do pedido." ConsultarDetalhePedidoDocumentoDTO: type: "object" properties: nomeDocumentoAnexado: type: "string" example: "recibo_de_vencimento.pdf" description: "Nome do documento anexado." identificadorFicheiro: type: "string" example: "33675a14-2af7-4bbf-952e-12a341c5fd21" description: "Código identificativo do ficheiro (documento) anexado que pode\ \ ser usado para efetuar o download." ConsultarDetalhePedidoCamposDTO: type: "object" properties: nomeCampo: type: "string" example: "Número do Processo Judicial" description: "Nome do campo." valorCampo: type: "string" example: "123456" description: "Valor do campo." CriarPedidoResponseDTO: type: "object" properties: numeroPedido: type: "string" example: "299999999992025010001" description: "número do pedido criado." dataExpiracao: type: "string" example: "2025-03-01" description: "data de expiração do pedido (data após a qual o pedido será\ \ desconsiderado do sistema )." AnularValorRemuneracaoPedidoRequestDTO: type: "object" required: - "anoMes" - "naturezaRemuneracao" - "nissTrabalhador" - "tipoQualificacao" properties: nissEntrega: type: "integer" format: "int64" example: 29999999999 description: "Número de identificação na Segurança Social da entidade que representa a entidade empregadora." nissTrabalhador: type: "integer" format: "int64" example: 19999999999 description: "Número de identificação na Segurança Social do trabalhador do valor comunicado a anular." anoMes: type: "string" example: "202503" description: "Identifica o ano-mês do valor comunicado a anular." tipoQualificacao: type: "string" example: "TCO" description: "Identifica o tipo de qualificação do trabalhador do valor comunicado a anular." enum: - "MOE" - "TCO" - "ARM" - "DPEE" naturezaRemuneracao: type: "string" example: "P" description: "Identifica o tipo de natureza de remuneração do valor comunicado a anular." enum: - "A" - "B" - "C" - "D" - "F" - "H" - "M" - "N" - "O" - "P" - "R" - "S" - "T" - "X" - "2" - "I" valor: type: "number" format: "double" example: 100.50 description: "Valor de remuneração do valor comunicado a anular" AtualizarPedidoResponseDTO: type: "object" properties: mensagem: type: "string" example: "mensagem de retorno" description: "Mensagem de retorno para o serviço." GestaoPedidoCampoMotivoDTO: type: "object" properties: codigoCampo: type: "string" example: "NUM_PROCESSO_JUDICIAL" description: "Código do campo. Os códigos de todos os campos definidos para\ \ o motivo podem ser obtidos invocando o serviço ConsultaListaMotivos." valorCampo: type: "string" example: "123456789" description: "Valor do campo. O valor deverá ser enviado em formato string,\ \ mas corresponder ao tipo de dados definido para o campo de acordo com\ \ a configuração do motivo (ser convertível nesse tipo de dados)." GestaoPedidoUpdateRequestServiceDTO: type: "object" properties: nissEntrega: type: "integer" format: "int64" example: 29999999999 description: "Número de identificação na Segurança Social da entidade que representa a entidade empregadora. " estadoPedido: type: "string" example: "ANULADO" description: "Estado do pedido (deverá ser indicado apenas caso se pretenda submeter ou eliminar o pedido)" enum: - "ANULADO" - "SUBMETIDO" camposMotivo: type: "array" items: $ref: "#/definitions/GestaoPedidoCampoMotivoDTO" ConsultarDetalhePedidoDTO: type: "object" required: - "dataEstado" - "dataSubmissao" - "descricaoGeralMotivo" - "estado" - "nomeMotivo" properties: dataSubmissao: type: "string" example: "2022-06-06" description: "Data de submissão do pedido." estado: type: "string" example: "SUBMETIDO" description: "Estado do pedido." dataEstado: type: "string" example: "2022-06-06" description: "Data do estado." dataLimiteEstado: type: "string" example: "2022-06-06" description: "Data limite do estado (apenas para estados \"Por submeter\"\ \ e \"Em audiência prévia\")." nomeMotivo: type: "string" example: "Sentenças judiciais" description: "Nome do motivo." descricaoGeralMotivo: type: "string" example: "Remunerações a declarar com efeitos retroativos na sequência de\ \ sentenças judiciais (Tribunal de Trabalho)" description: "Descrição geral do motivo." listaInformacoesNecessarias: type: "array" items: $ref: "#/definitions/ConsultarDetalhePedidoCamposDTO" listaDocumentos: type: "array" items: $ref: "#/definitions/ConsultarDetalhePedidoDocumentoDTO" listaRegistosHistorico: type: "array" items: $ref: "#/definitions/ConsultarDetalhePedidoHistoricoDTO" GestaoPedidoRequestDTO: type: "object" required: - "codigoMotivo" properties: nissEntrega: type: "integer" format: "int64" example: 29999999999 description: "Número de Identificação na Segurança Social da entidade que representa a entidade empregadora. " codigoMotivo: type: "string" example: "SENTENCAS_JUDICIAIS" description: "Código que identifica o motivo. Os códigos de todos os motivos gerais e específicos para a EE podem ser obtidos invocando o serviço ConsultarListaMotivos." numeroPedidoOrigem: type: "number" example: 2.34567890122025E20 description: "Número pedido já existente e concluído ao qual se pretende associar o novo pedido que será criado." PedidosDTO: type: "object" required: - "dataSubmissao" - "estado" - "motivo" - "numero" properties: dataSubmissao: type: "string" example: "2022-06-06" description: "Data de submissão do pedido." motivo: type: "string" example: "Sentenças judiciais" description: "Nome do motivo do pedido." numero: type: "string" example: "200000731122025040000" description: "Número do pedido." estado: type: "string" example: "SUBMETIDO" description: "Estado do pedido." UploadFicheiroDTO: type: "object" properties: identificadorFicheiro: type: "string" example: "33675a14-2af7-4bbf-952e-12a341c5fd21" description: "Código identificativo do ficheiro carregado" mensagem: type: "string" example: "Ficheiro carregado com sucesso" description: "Mensagem indicativa do sucesso do ficheiro carregado" DownloadFicheiroDTO: type: "object" properties: ficheiro: type: "string" example: "dXRpbGl6YWRvcnRlc3RlOnNlbmhhYWNlc3N" description: "Ficheiro que se pretende descarregar" mensagem: type: "string" example: "Ficheiro descarregado com sucesso" description: "Mensagem indicativa do sucesso do ficheiro descarregado" ConsultaAvisosDTO: type: "object" properties: resumoAviso: type: "string" example: "Pedido de comunicação de valores em Audiência Prévia" description: "Mensagem resumo do aviso" descricaoAviso: type: "string" example: "O seu pedido de comunicação de valores foi analisado e encontra-se em Audiência Prévia" description: "Mensagem descritiva do aviso" TrabalhadorObrigacaoContributivaMensalDTO: type: "object" properties: nissTrabalhador: type: "integer" format: "int64" example: 19999999999 description: "Número de identificação na Segurança Social do trabalhador." diasTrabalho: type: "number" example: 30.0 description: "Número de dias de trabalho do trabalhador." remuneracao: type: "number" example: 1123.45 description: "Valor da remuneração do trabalhador." obrigacao: type: "number" example: 41.97 description: "Valor da obrigação contributiva do trabalhador." UploadFicheiroRequestDTO: type: "object" required: - "contexto" - "ficheiro" - "nomeFicheiro" - "numeroPedido" properties: nissEntrega: type: "integer" format: "int64" example: 29999999999 description: "Número de Identificação na Segurança Social da entidade que representa a entidade empregadora." ficheiro: type: "string" example: "dXRpbGl6YWRvcnRlc3RlOnNlbmhhYWNlc3N" description: "Ficheiro a realizar o upload" nomeFicheiro: type: "string" example: "anexo.pdf" description: "Nome do ficheiro a realizar o upload" contexto: type: "string" example: "PEDIDO_FORA_PRAZO" description: "Contexto do upload do ficheiro" numeroPedido: type: "number" example: 23456789012202503 description: "Número do pedido para o qual se pretende realizar o upload do ficheiro" ConfirmacaoObrigacaoContributivaDTO: type: "object" properties: mensagem: type: "string" example: "Confirmação efetuada com sucesso" description: "Mensagem indicativa do resultado da confirmação realizada" ValoresComunicadosComprovativoResponseDTO: type: "object" properties: identificacaoComunicacao: type: "string" description: "Igual ao Comprovativo de Entrega obtido." example: "1ac3844b-40f7-4be8-937a-a9e048dc9a9c" identificacaoComunicacaoPDF: type: "string" description: "Igual ao código que identifica o comprovativo em formato PDF." example: "33675a14-2af7-4bbf-952e-12a341c5fd21" nissEE: type: "integer" format: "int64" description: "Número de identificação da entidade empregadora na Segurança Social." example: 20000073112 nissEntrega: type: "integer" format: "int64" description: "Número de identificação da entidade empregadora que realizou a comunicação dos valores." example: 20000073112 dataComunicacao: type: string description: "Data em que os valores foram comunicados à Segurança Social." example: "26/07/2024" numeroRegistos: type: integer format: "int64" description: "Total de valores enviados na comunicação." example: 1 totalValor: type: number format: "double" description: "Soma de todos os valores enviados na comunicação." example: 1234.40 ConsultaValoresApuradosMensalDTO: type: "object" properties: anoMes: type: "string" example: "202601" description: "Ano e mês de referência da obrigação contributiva da entidade empregadora." totalTrabalhadores: type: "integer" format: "int32" example: 1 description: "Número total de trabalhadores da entidade empregadora para o ano e mês de referência." totalRemuneracao: type: "number" format: "double" example: 123.45 description: "Valor total das remunerações para o ano e mês de referência." totalContribuicao: type: "number" format: "double" example: 123.45 description: "Valor total das contribuições para o ano e mês de referência." totalReducao: type: "number" format: "double" example: 123.45 description: "Valor total das reduções para o ano e mês de referência." obrigacao: type: "number" format: "double" example: 123.45 description: "Valor total da obrigação contributiva para o ano e mês de referência." remuneracoes: type: "array" description: "Lista de remunerações por natureza e período para o ano e mês de referência." items: $ref: "#/definitions/ConsultaValoresApuradosMensalRemuneracoesDTO" contribuicoes: type: "array" description: "Lista de contribuições por enquadramento (regime) para o ano e mês de referência." items: $ref: "#/definitions/ConsultaValoresApuradosMensalContribuicoesDTO" reducoes: type: "array" description: "Lista de reduções por medida para o ano e mês de referência. " items: $ref: "#/definitions/ConsultaValoresApuradosMensalReducoesDTO" ConsultaValoresApuradosMensalRemuneracoesDTO: type: "object" properties: natureza: type: "string" example: "P" description: "Natureza da remuneração." enum: - "A" - "B" - "C" - "D" - "F" - "H" - "M" - "N" - "O" - "P" - "R" - "S" - "T" - "X" - "2" - "I" remuneracao: type: "number" format: "double" example: 123.45 description: "Valor da remuneração para a natureza." ConsultaValoresApuradosMensalContribuicoesDTO: type: "object" properties: enquadramento: type: "string" example: "Regime geral" description: "Enquadramento (regime) da contribuição." contribuicao: type: "number" format: "double" example: 123.45 description: "Valor da contribuição para o enquadramento (regime)." ConsultaValoresApuradosMensalReducoesDTO: type: "object" properties: medida: type: "string" description: "Medida da redução." reducao: type: "number" format: "double" example: 123.45 description: "Valor da redução para a medida." ConsultarValoresApuradosAnualDTO: type: "object" properties: dataAdesao: type: "string" example: "2025-03-01" description: "Data em que a entidade empregadora realizou a adesão ao novo modelo." obrigacoesContributivas: type: "array" items: $ref: "#/definitions/HistoricoMensalDTO" HistoricoMensalDTO: type: "object" properties: anoMes: type: "string" example: "202601" description: "Ano e mês de referência da obrigação contributiva da entidade empregadora." totalTrabalhadores: type: "integer" format: "int32" example: 1 description: "Número total de trabalhadores da entidade empregadora para o ano e mês de referência." remuneracao: type: "number" format: "double" example: 1123.45 description: "Valor total das remunerações para o ano e mês de referência.." obrigacao: type: "number" format: "double" example: 123.45 description: "Valor total da obrigação contributiva para o ano e mês de referência." estado: type: "string" example: "Previsto" description: "Estado da obrigação contributiva da entidade empregadora para o ano e mês de referência." enum: - "PREVISTO" - "APURADO" ValoresApuradosDetalheTrabalhadorDTO: type: "object" properties: anoMes: type: "string" example: "202501" description: "Ano e mês de referência da obrigação contributiva do trabalhador." nissTrabalhador: type: "integer" format: "int64" example: 19999999999 description: "NISS do trabalhador." totalRemuneracao: type: "number" format: "double" example: 123.45 description: "Valor total das remunerações do trabalhador para o ano e mês de referência." totalContribuicao: type: "number" format: "double" example: 123.45 description: "Valor total das contribuições do trabalhador para o ano e mês de referência." totalReducao: type: "number" format: "double" example: 123.45 description: "Valor total das reduções do trabalhador para o ano e mês de referência." totalObrigacao: type: "number" format: "double" example: 123.45 description: "Valor total da obrigação contributiva do trabalhador para o ano e mês de referência." remuneracoes: type: "array" description: "Lista de remunerações do trabalhador por natureza e por período para o ano e mês de referência." items: $ref: "#/definitions/ValoresApuradosDetalheTrabalhadorRemuneracaoDTO" contribuicoes: type: "array" description: "Lista de contribuições do trabalhador por enquadramento (regime) e por período para o ano e mês de referência." items: $ref: "#/definitions/ValoresApuradosDetalheTrabalhadorContribuicaoDTO" detalhesContribuicao: type: "array" description: "Lista de detalhes da contribuição do trabalhador por natureza, enquadramento (regime) e motivo." items: $ref: "#/definitions/ValoresApuradosDetalheTrabalhadorContribuicaoNatDTO" ValoresApuradosDetalheTrabalhadorContribuicaoNatDTO: type: "object" properties: natureza: type: "string" example: "P" description: "Natureza associada ao detalhe de contribuição." enquadramento: type: "string" example: "Regime geral" description: "Regime do contrato de trabalho a que se refere a contribuição." motivo: type: "string" example: "MENSAL" description: "Motivo da contribuição." tipo: type: "string" example: "CONTRIBUICAO" description: "Tipo da contribuição (contribuição ou cotização)." valor: type: "number" format: "double" example: 300.20 description: "Valor total da contribuição para o tipo de contribuição. " valoresDataLimitePagamento: type: "array" description: "Lista de valores por data limite de pagamento (Sub-Lista)." items: $ref: "#/definitions/ValoresApuradosDetalheTrabalhadorDLPDTO" ValoresApuradosDetalheTrabalhadorDLPDTO: type: "object" properties: valor: type: "number" format: "double" example: 300.20 description: "Valor apurado para a data limite de pagamento." dataLimitePagamento: type: "string" format: "date-time" example: "2025-11-10" description: "Data limite de pagamento." ValoresApuradosDetalheTrabalhadorRemuneracaoDTO: type: "object" properties: dataInicio: type: "string" example: "2025-01-01" description: "Data de início do período." dataFim: type: "string" example: "2026-01-01" description: "Data de fim do período." natureza: type: "string" example: "P" description: "Natureza da remuneração." enum: - "A" - "B" - "C" - "D" - "F" - "H" - "M" - "N" - "O" - "P" - "R" - "S" - "T" - "X" - "2" - "I" remuneracao: type: "number" format: "double" example: 1500 description: "Valor da remuneração" diasTrabalho: type: "number" format: "double" example: 30.0 description: "Número de dias de trabalho efetivo" origem: type: "string" example: Seguranca_Social description: "Origem do valor de remuneração." enum: - Seguranca_Social - Entidade_Empregadora diasInatividade: type: "number" format: "double" example: 2 description: "Número de dias de inatividade." inatividades: type: "array" description: "Lista de inatividades do período" items: $ref: "#/definitions/ValoresApuradosDetalheTrabalhadorInatividadesDTO" ValoresApuradosDetalheTrabalhadorInatividadesDTO: type: "object" properties: dataInicio: type: "string" example: "2025-01-02" description: "Data de início da inatividade." dataFim: type: "string" example: "2025-01-20" description: "Data de fim da inatividade." motivo: type: "string" description: "Motivo da inatividade." ValoresApuradosDetalheTrabalhadorContribuicaoDTO: type: "object" properties: dataInicio: type: "string" example: "2025-01-02" description: "Data de início do período." dataFim: type: "string" example: "2026-01-02" description: "Data de fim do período." enquadramento: type: "string" example: Regime Geral description: "Enquadramento (regime) da contribuição." valorCotizacao: type: "number" format: "double" example: 130.24 description: "Valor resultante da aplicação da taxa de cotização sobre a remuneração do trabalhador, correspondente à contribuição mensal do trabalhador para a Segurança Social." taxaCotizacao: type: "number" format: "double" example: 11 description: "Taxa percentual aplicada à remuneração do trabalhador, representando a contribuição obrigatória para a Segurança Social" valorComplementarCotizacao: type: "number" format: "double" example: 50 description: "Valor adicional de contribuição à Segurança Social, além da cotização regular." taxaComplementarCotizacao: type: "number" format: "double" example: 5 description: "Taxa percentual adicional sobre a remuneração do trabalhador, aumentando a contribuição do trabalhador para a Segurança Social." valorContribuicao: type: "number" format: "double" example: 500.30 description: "Valor resultante da aplicação da taxa de contribuição sobre a remuneração do trabalhador, correspondente à contribuição mensal da entidade empregadora para a Segurança Social." taxaContribuicao: type: "number" format: "double" example: 23.75 description: "Taxa percentual aplicada sobre a remuneração do trabalhador, correspondente à parte da contribuição paga pela entidade empregadora para a Segurança Social." valorComplementarContribuicao: type: "number" format: "double" example: 50 description: "Valor adicional pago pela entidade empregadora para complementar a contribuição obrigatória à Segurança Social." taxaComplementarContribuicao: type: "number" format: "double" example: 5 description: "Taxa percentual adicional aplicada sobre a remuneração do trabalhador, aumentando a contribuição da entidade empregadora para a Segurança Social." obrigacao: type: "number" format: "double" example: 500.40 description: "Valor total da obrigação contributiva para a Segurança Social." ConsultaAlertasValorComunicadoDTO: type: "object" properties: nissEE: type: "integer" format: "int64" example: 20000000000 description: "Número de identificação da Entidade Empregadora na Segurança Social." nissEntrega: type: "integer" format: "int64" example: 20000000000 description: "Número de identificação da Entidade Empregadora que realizou a entrega do valor comunicado" dataComunicacao: type: "string" example: "2026-01-01" description: "Data em que o valor foi comunicado à Segurança Social." comprovativoEntrega: type: "string" example: "1ac3844b-40f7-4be8-937a-a9e048dc9a9c" description: "Comprovativo obtido aquando da comunicação do valor." nissTrabalhador: type: "integer" format: "int64" example: 10000000000 description: "NISS do trabalhador vinculado ao valor comunicado." anoMes: type: "string" example: "2025-01" description: "Ano-mês do valor comunicado." tipoQualificacao: type: "string" example: "TCO" description: "Tipo de qualificação do trabalhador no ano-mês comunicado." enum: - "MOE" - "TCO" - "ARM" - "DPEE" naturezaRemuneracao: type: "string" example: "P" description: "Natureza de remuneração do trabalhador no ano-mês comunicado." enum: - "A" - "B" - "C" - "D" - "F" - "H" - "M" - "N" - "O" - "P" - "R" - "S" - "T" - "X" - "2" - "I" dias: type: "number" format: "double" example: 30.0 description: "Número de dias comunicados." valor: type: "number" example: 123.45 description: "Valor comunicado." valores-comunicados-alertas-output: type: "object" properties: resumoAlerta: type: "string" example: "O número de dias comunicado excede o número de dias de trabalho permitido para a natureza indicada" description: "Resumo do alerta parametrizado para o valor comunicado." descricaoAlerta: type: "string" example: "O número de dias comunicado excede o número de dias de trabalho permitido para a natureza indicada" description: "Descrição do alerta parametrizado para o valor comunicado." valorComunicado: $ref: "#/definitions/ConsultaAlertasValorComunicadoDTO" EnviarValoresRemuneracaoDTO: type: "object" properties: comprovativoEntrega: type: "string" example: "710ad8c2-7d69-416f-a9a3-b34ef4042b6c" description: "Código gerado que identifica a comunicação efetuada." valores: type: "object" required: - "anoMes" - "dias" - "naturezaRemuneracao" - "nissTrabalhador" - "tipoQualificacao" - "valor" properties: nissTrabalhador: type: "integer" format: "int64" example: 19999999999 description: "Número de identificação na Segurança Social do trabalhador a comunicar" anoMes: type: "string" example: "202601" description: "Identifica o ano-mês do valor a comunicar" tipoQualificacao: type: "string" example: "MOE" description: "Identifica o tipo de qualificacao do Niss-trabalhador a comunicar" minLength: 1 maxLength: 5 enum: - "MOE" - "TCO" - "ARM" - "DPEE" naturezaRemuneracao: type: "string" example: "B" description: "Identifica o tipo de natureza de remuneração a comunicar" minLength: 1 maxLength: 2 enum: - "A" - "B" - "C" - "D" - "F" - "H" - "M" - "N" - "O" - "P" - "R" - "S" - "T" - "X" - "2" - "I" dias: type: "number" format: "double" example: 15.5 description: "Corresponde ao número de dias do movimento a comunicar" valor: type: "number" format: "double" example: 931.3 description: "Corresponde ao valor a comunicar" numeroPedido: type: "number" example: 234567890102025 description: "Número do pedido de comunicação de valores." valores-comunicados-input: type: "object" required: - "valores" properties: valores: type: "array" description: "Lista de valores a enviar. Máximo 1000 registos." items: xml: name: "valores" $ref: "#/definitions/valores" RetornoValidacaoDTO: type: "object" properties: code: type: "integer" format: "int32" message: type: "string" lista: type: "object" properties: comprovativoEntrega: type: "string" description: "Comprovativo dos valores comunicados." example: "5bc20541-ca39-4c8d-85fa-bc4914a0c1ee" minLength: 56 maxLength: 56 valores-comunicados-por-processar: type: "object" properties: semAlertas: type: "array" description: "Lista de comprovativos entregues sem alertas" example: items: xml: name: "semAlertas" $ref: "#/definitions/lista" comAlertas: type: "array" description: "Lista de comprovativos entregues com alertas" items: xml: name: "comAlertas" $ref: "#/definitions/lista" valor-comunicado: type: "object" required: - "anoMes" - "nissTrabalhador" - "tipoQualificacao" - "naturezaRemuneracao" - "dias" - "valor" - "estado" properties: nissTrabalhador: type: "integer" format: "int64" description: "Número de identificação na Segurança Social do trabalhador comunicado" example: 12345678910 anoMes: type: "string" example: "202403" description: "Identifica o ano/mês do valor comunicado" tipoQualificacao: type: "string" example: "TCO" description: "Identifica o tipo de qualificação do trabalhador comunicado." enum: - "MOE" - "TCO" - "DPEE" - "ARM " naturezaRemuneracao: type: "string" example: "P" description: "Identifica a natureza da remuneração comunicado." enum: - "A" - "B" - "C" - "D" - "F" - "H" - "M" - "N" - "O" - "P" - "R" - "S" - "T" - "X" - "2" - "I" dias: type: "number" format: "double" example: 30.0 description: "Corresponde ao número de dias do movimento comunicado" valor: type: "number" format: "double" example: 100.50 description: "Corresponde ao valor comunicado" estado: type: "string" example: "Integrado" description: "Estado do valor comunicado." enum: - "Com alerta" - "Em processamento" - "Integrado" - "Substituído" valores-comunicados-output: type: "object" required: - "valores" properties: nissEE: type: "integer" format: "int64" description: "Número de Identificação da Entidade Empregadora na Segurança Social." example: 20000073112 nissEntrega: type: "integer" format: "int64" description: "Número de Identificação da Entidade Empregadora que comunicou os valores." example: 20000073112 dataComunicacao: type: "string" description: "Data em que o valor foi comunicado à Segurança Social." example: "2024/08/02" valores: type: "array" description: "Informação acerca dos valores comunicados." items: xml: name: "valores" $ref: "#/definitions/valor-comunicado"