{"basePath":"/","info":{"title":"3Tecnos Siafic api","version":"Beta"},"paths":{"/{cnpj}/arrecadacoes":{"post":{"operationId":"handle","tags":["Tributos"],"description":"Cria uma nova arrecadação","parameters":[{"name":"cnpj","in":"path","type":"string","description":"CNPJ da Unidade Gestora","required":true},{"name":"body","in":"body","required":true,"schema":{"$ref":"#/definitions/CriarArrecadacaoModel"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/OperacaoDeCriarModel"}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"description":"Internal Server Error"}},"produces":["application/json"],"consumes":["application/json"],"security":[{"bearerAuth":[]}]}},"/{cnpj}/arrecadacoes/{arrecadacaoId}/estornos":{"post":{"operationId":"handle","tags":["Tributos"],"description":"Efetua um estorno parcial ou total da arrecadação.","parameters":[{"name":"cnpj","in":"path","type":"string","description":"CNPJ da Unidade Gestora","required":true},{"name":"arrecadacaoId","in":"path","type":"string","description":"Id da transação da arrecadação","required":true},{"name":"body","in":"body","required":true,"schema":{"$ref":"#/definitions/EstornarArrecadacaoModel"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"description":"Internal Server Error"}},"produces":["application/json"],"consumes":["application/json"],"security":[{"bearerAuth":[]}]}},"/{cnpj}/arrecadacoes/{arrecadacaoId}":{"get":{"operationId":"handle","tags":["Tributos"],"description":"Retorna os dados da arrecadação requisitada.","parameters":[{"name":"cnpj","in":"path","type":"string","description":"CNPJ da Unidade Gestora","required":true},{"name":"arrecadacaoId","in":"path","type":"string","description":"Id da transação da arrecadação","required":true}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ObterArrecadacaoModel"}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"description":"Internal Server Error"}},"produces":["application/json"],"consumes":["application/json"],"security":[{"bearerAuth":[]}]}},"/autenticar":{"post":{"operationId":"handle","tags":["Autenticação"],"description":"Autentica um usuário na API","parameters":[{"name":"body","in":"body","required":true,"schema":{"$ref":"#/definitions/AutenticarUsuarioModel"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/TokenModel"}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}},"produces":["application/json"],"consumes":["application/json"]}},"/{cnpj}/aquisicoes":{"post":{"operationId":"handle","tags":["Aquisições"],"description":"Cria uma nova aquisição","parameters":[{"name":"cnpj","in":"path","type":"string","description":"CNPJ da Unidade Gestora","required":true},{"name":"body","in":"body","required":true,"schema":{"$ref":"#/definitions/CriarAquisicaoModel"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/OperacaoDeCriarModel"}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"description":"Internal Server Error"}},"produces":["application/json"],"consumes":["application/json"],"security":[{"bearerAuth":[]}]}},"/{cnpj}/aquisicoes/{aquisicaoId}/baixas":{"post":{"operationId":"handle","tags":["Aquisições"],"description":"Baixar uma aquisição","parameters":[{"name":"cnpj","in":"path","type":"string","description":"CNPJ da Unidade Gestora","required":true},{"name":"aquisicaoId","in":"path","type":"string","description":"Id da transação da aquisição","required":true},{"name":"body","in":"body","required":true,"schema":{"$ref":"#/definitions/BaixarAquisicaoModel"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"description":"Internal Server Error"}},"produces":["application/json"],"consumes":["application/json"],"security":[{"bearerAuth":[]}]}},"/{cnpj}/aquisicoes/{aquisicaoId}":{"get":{"operationId":"handle","tags":["Aquisições"],"description":"Retorna os dados da aquisição requisitada.","parameters":[{"name":"cnpj","in":"path","type":"string","description":"CNPJ da Unidade Gestora","required":true},{"name":"aquisicaoId","in":"path","type":"string","description":"Id da transação da aquisição","required":true}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ObterAquisicaoModel"}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"description":"Internal Server Error"}},"produces":["application/json"],"consumes":["application/json"],"security":[{"bearerAuth":[]}]}},"/{cnpj}/patrimonios":{"post":{"operationId":"handle","tags":["Patrimônios"],"description":"Cria um novo patrimônio","parameters":[{"name":"cnpj","in":"path","type":"string","description":"CNPJ da Unidade Gestora","required":true},{"name":"body","in":"body","required":true,"schema":{"$ref":"#/definitions/CriarPatrimonioModel"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/OperacaoDeCriarModel"}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"description":"Internal Server Error"}},"produces":["application/json"],"consumes":["application/json"],"security":[{"bearerAuth":[]}]}},"/{cnpj}/patrimonios/{patrimonioId}/baixas":{"post":{"operationId":"handle","tags":["Patrimônios"],"description":"Baixar um patrimônio","parameters":[{"name":"cnpj","in":"path","type":"string","description":"CNPJ da Unidade Gestora","required":true},{"name":"patrimonioId","in":"path","type":"string","description":"Id da transação do patrimônio","required":true},{"name":"body","in":"body","required":true,"schema":{"$ref":"#/definitions/BaixarPatrimonioModel"}}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"description":"Internal Server Error"}},"produces":["application/json"],"consumes":["application/json"],"security":[{"bearerAuth":[]}]}},"/{cnpj}/patrimonios/{patrimonioId}":{"get":{"operationId":"handle","tags":["Patrimônios"],"description":"Retorna os dados do patrimônio requisitado.","parameters":[{"name":"cnpj","in":"path","type":"string","description":"CNPJ da Unidade Gestora","required":true},{"name":"patrimonioId","in":"path","type":"string","description":"Id da transação do patrimônio","required":true}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ObterPatrimonioModel"}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"description":"Internal Server Error"}},"produces":["application/json"],"consumes":["application/json"],"security":[{"bearerAuth":[]}]}},"/{cnpj}/folhas-de-pagamento":{"post":{"operationId":"handle","tags":["Folhas de Pagamentos"],"description":"Cria uma nova folha de pagamento","parameters":[{"name":"cnpj","in":"path","type":"string","description":"CNPJ da Unidade Gestora","required":true},{"name":"body","in":"body","required":true,"schema":{"$ref":"#/definitions/CriarFolhaDePagamentoModel"}}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/OperacaoDeCriarModel"}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"description":"Internal Server Error"}},"produces":["application/json"],"consumes":["application/json"],"security":[{"bearerAuth":[]}]}},"/{cnpj}/folhas-de-pagamento/{folhaDePagamentoId}":{"get":{"operationId":"handle","tags":["Folhas de Pagamentos"],"description":"Retorna os dados da folha de pagamento requisitada.","parameters":[{"name":"cnpj","in":"path","type":"string","description":"CNPJ da Unidade Gestora","required":true},{"name":"folhaDePagamentoId","in":"path","type":"string","description":"Id da transação da folha de pagamento","required":true}],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ObterFolhaDePagamentoModel"}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"500":{"description":"Internal Server Error"}},"produces":["application/json"],"consumes":["application/json"],"security":[{"bearerAuth":[]}]}}},"tags":[{"name":"Tributos"},{"name":"Autenticação"},{"name":"Aquisições"},{"name":"Patrimônios"},{"name":"Folhas de Pagamentos"}],"schemes":["https"],"produces":["application/json"],"consumes":["application/json"],"definitions":{"AutenticarUsuarioModel":{"type":"object","properties":{"userName":{"type":"string","description":"O CNPJ(sem pontos e traços) da empresa responsável pelo sistema é utilizado como userName.","example":"09568632000120"},"password":{"type":"string","description":"Senha forte da empresa de sistema.","example":"P@ssw0rd"}},"required":["userName","password"],"description":"Inicia uma autenticação com a API"},"TokenModel":{"type":"object","properties":{"tokenType":{"type":"string","description":"Tipo do Token","example":"Bearer"},"accessToken":{"type":"string","description":"Token de acesso","example":""},"expiresIn":{"type":"number","description":"O período de expiração do resultado da autenticação em segundos.","example":3600}},"required":["tokenType","accessToken","expiresIn"],"description":"Token de acesso"},"OperacaoDeCriarModel":{"type":"object","properties":{"id":{"type":"string","description":"Id da transação. Utilizado para identificar a operação e consultar via GET","example":"vxDgP6qPJVpDyvsMpdmyl"},"createdAt":{"type":"string","description":"Data e Hora da Operação. Formato Date ISO string","example":"2022-10-05T20:26:29.021Z"}},"required":["id","createdAt"],"description":"Retorno da Operação"},"EmpenhoModel":{"type":"object","properties":{"ano":{"type":"number","description":"Ano do empenho","example":2022},"numero":{"type":"number","description":"Número do empenho","example":100}},"required":["ano","numero"],"description":"Informações do empenho"},"FornecedorModel":{"type":"object","properties":{"cpf":{"type":"string","description":"CPF do fornecedor. Informar quando o fornecedor for pessoa física.","example":"47727534005"},"cnpj":{"type":"string","description":"CNPJ do fornecedor. Informar quando o fornecedor for pessoa jurídica.","example":"61438309000152"},"nome":{"type":"string","description":"Nome ou Razão Social do fornecedor","example":"3Tecnos"}},"required":["nome"],"description":"Informações do fornecedor. É obrigatório informar o CPF ou CNPJ (unicamente) do fornecedor."},"NotaFiscalModel":{"type":"object","properties":{"uf":{"type":"string","description":"UF da nota fiscal","example":"SE"},"numero":{"type":"string","description":"Número da nota fiscal","example":"123"},"numeroDeSerie":{"type":"string","description":"Número de série da nota fiscal","example":"001"},"dataDeEmissao":{"type":"string","description":"Data de emissão da nota fiscal","example":"2022-01-02T09:26:54.866Z"},"dataDeValidade":{"type":"string","description":"Data de validade da nota fiscal","example":"2022-01-02T09:26:54.866Z"},"chaveDeAcesso":{"type":"string","description":"Chave de acesso da nota fiscal. Deve ser informado o número de 44 dígitos presentes no DANFE (Documento Auxiliar de Nota Fiscal Eletrônica).","example":"28201000000000229938550010000001231000203457"}},"required":["uf","numero","numeroDeSerie","dataDeEmissao","dataDeValidade","chaveDeAcesso"],"description":"Informações da nota fiscal"},"GrupoModel":{"type":"object","properties":{"grupos":{"type":"object","description":"Grupos"}},"required":[],"description":"Informações do grupo"},"ObterArrecadacaoModel":{"type":"object","properties":{"createdAt":{"type":"date","description":"Data e hora em que persistiu no SIAFIC. Formato JSON object","example":"2022-01-02T09:26:54.866Z"},"estornos":{"type":"array","description":"Lista de estornos da arrecadação","example":[{"valor":50,"data":"2022-01-02T09:27:54.866Z"}]},"valor":{"type":"number","description":"Valor arrecadado","example":100},"descricao":{"type":"string","description":"Descrição da Arrecadação","example":"Pagamento de IPTU"},"dadosBancarios":{"description":"Dados Bancários da Agência e Conta recebedora do Tributo","$ref":"#/definitions/DadosBancariosModel"},"data":{"type":"date","description":"Data e hora em que aconteceu a arrecadação no sistema estruturante de Tributos. Formato JSON object","example":"2022-01-02T09:26:54.866Z"},"tipoDoLancamento":{"type":"number","description":"Tipo Do Lançamento. Os tipos válidos são: 1 - Receita, 2 - Juros e Multa, 3 - Receita Divida Ativa, 4 - Juros e Multa Divida Ativa, 5 - Multa, 6 - Multa Divida Ativa","example":"1"}},"required":["createdAt","estornos","valor","descricao","data","tipoDoLancamento"],"description":"Dados de Entrada de uma nova Arrecadação"},"CriarArrecadacaoModel":{"type":"object","properties":{"tributoExterno":{"description":"Informações do tributo externo","$ref":"#/definitions/TributoExternoModel"},"valor":{"type":"number","description":"Valor arrecadado","example":100},"descricao":{"type":"string","description":"Descrição da Arrecadação","example":"Pagamento de IPTU"},"dadosBancarios":{"description":"Dados Bancários da Agência e Conta recebedora do Tributo","$ref":"#/definitions/DadosBancariosModel"},"data":{"type":"date","description":"Data e hora em que aconteceu a arrecadação no sistema estruturante de Tributos. Formato JSON object","example":"2022-01-02T09:26:54.866Z"},"tipoDoLancamento":{"type":"number","description":"Tipo Do Lançamento. Os tipos válidos são: 1 - Receita, 2 - Juros e Multa, 3 - Receita Divida Ativa, 4 - Juros e Multa Divida Ativa, 5 - Multa, 6 - Multa Divida Ativa","example":1}},"required":["valor","descricao","data","tipoDoLancamento"],"description":"Dados de Entrada de uma nova Arrecadação"},"DadosBancariosModel":{"type":"object","properties":{"codigoDoBanco":{"type":"string","description":"Código do Banco(Instituição Financeira). O código do banco possui 3 dígitos.","example":"001"},"codigoDaAgencia":{"type":"string","description":"Código da Agência.","example":"0001"},"contaCorrente":{"type":"string","description":"Código da Conta Corrente.","example":"99999"}},"required":["codigoDoBanco","codigoDaAgencia","contaCorrente"],"description":"Dados Bancários da Agência e Conta recebedora do Tributo"},"EstornarArrecadacaoModel":{"type":"object","properties":{"estorno":{"description":"Objeto de Estorno.","$ref":"#/definitions/EstornoModel"}},"required":["estorno"],"description":"Efetua um estorno parcial ou total da arrecadação"},"EstornoModel":{"type":"object","properties":{"valor":{"type":"number","description":"Valor estornado.","example":"100"},"data":{"type":"date","description":"Data do estorno.","example":"2022-10-06T10:00:00.000Z"}},"required":["valor","data"],"description":"Estorno"},"TributoExternoModel":{"type":"object","properties":{"codigo":{"type":"string","description":"Identificador único do Tributo no sistema estruturante de Tributos","example":"2"},"nome":{"type":"string","description":"Descrição do Tributo no sistema estruturante de Tributos","example":"IPTU"}},"required":["codigo","nome"],"description":"Informações do tributo externo"},"CriarAquisicaoModel":{"type":"object","properties":{"tipoDeEntrada":{"type":"number","description":"Tipo de entrada da aquisição. O números válidos são: 1 - Compra, 2 - Inventário, 3 - Doação, 4 - Dação em pagamento, 5 - Adjudicação, 6 - Consórcio","example":1},"data":{"type":"date","description":"Data e hora em que aconteceu a aquisição no sistema estruturante de Tributos. Formato ISO string","example":"2022-01-02T09:26:54.866Z"},"valor":{"type":"number","description":"Valor da aquisição","example":100},"descricao":{"type":"string","description":"Descrição da aquisição","example":"Compra de materiais"},"codigoDoGrupo":{"type":"string","description":"Código do grupo. Consultar códigos disponíveis em: https://siafic-teste.3tecnos.com.br/api-docs/swagger/grupos/","example":"3072"},"fornecedor":{"description":"Informações do fornecedor","$ref":"#/definitions/FornecedorModel"},"empenho":{"description":"Informações do empenho","$ref":"#/definitions/EmpenhoModel"},"notaFiscal":{"description":"Informações da nota fiscal","$ref":"#/definitions/NotaFiscalModel"}},"required":["tipoDeEntrada","data","valor","descricao","codigoDoGrupo"],"description":"Dados de Entrada de uma nova Aquisição.\n    * Quando o tipo de entrada for \"1 - Compra\", os dados do fornecedor, empenho e nota fiscal são obrigatórios.\n    * Quando o tipo de entrada for \"4 - Dação em pagamento\" ou \"5 - Adjudicação\", os dados do fornecedor são obrigatórios.\n  "},"BaixarAquisicaoModel":{"type":"object","properties":{"tipoDeBaixa":{"type":"number","description":"Tipo de baixa. O números válidos são: 1 - Consumo, 2 - Perdas/Regularização, 3 - Demais Motivos","example":1},"data":{"type":"date","description":"Data e hora em que aconteceu a baixa no sistema estruturante de Tributos. Formato ISO string","example":"2022-01-02T09:26:54.866Z"},"valor":{"type":"number","description":"Valor da baixa","example":100},"descricao":{"type":"string","description":"Descrição da baixa","example":"Consumo de materiais"}},"required":["tipoDeBaixa","data","valor","descricao"],"description":"Dados para baixa de uma Aquisição."},"ObterAquisicaoModel":{"type":"object","properties":{"id":{"type":"string","description":"Id da transação. Utilizado para identificar a operação e consultar via GET","example":"vxDgP6qPJVpDyvsMpdmyl"},"createdAt":{"type":"date","description":"Data e hora em que persistiu no SIAFIC. Formato JSON object","example":"2022-01-02T09:26:54.866Z"},"baixas":{"type":"array","description":"Lista de baixas da aquisição","example":[{"data":"2022-01-02T09:26:54.866Z","tipoDeBaixa":1,"valor":100,"descricao":"Consumo de materiais"}]},"tipoDeEntrada":{"type":"number","description":"Tipo de entrada da aquisição. O números válidos são: 1 - Compra, 2 - Inventário, 3 - Doação, 4 - Dação em pagamento, 5 - Adjudicação, 6 - Consórcio","example":1},"data":{"type":"string","description":"Data e hora em que aconteceu a aquisição no sistema estruturante de Tributos. Formato ISO string","example":"2022-01-02T09:26:54.866Z"},"valor":{"type":"number","description":"Valor da aquisição","example":100},"descricao":{"type":"string","description":"Descrição da aquisição","example":"Compra de materiais"},"codigoDoGrupo":{"type":"string","description":"Código do grupo de depreciação","example":"3072"},"fornecedor":{"description":"Informações do fornecedor","$ref":"#/definitions/FornecedorModel"},"empenho":{"description":"Informações do empenho","$ref":"#/definitions/EmpenhoModel"},"notaFiscal":{"description":"Informações da nota fiscal","$ref":"#/definitions/NotaFiscalModel"}},"required":["id","createdAt","baixas","tipoDeEntrada","data","valor","descricao","codigoDoGrupo"],"description":"Dados de Entrada de uma nova Aquisição"},"CriarPatrimonioModel":{"type":"object","properties":{"tipoDeEntrada":{"type":"number","description":"Tipo de entrada do patrimônio. O números válidos são: 1 - Compra, 2 - Inventário, 3 - Doação, 4 - Dação em pagamento, 5 - Adjudicação, 6 - Consórcio, 7 - Transferência","example":1},"data":{"type":"date","description":"Data e hora em que aconteceu o patrimônio no sistema estruturante de Tributos. Formato ISO string","example":"2022-01-02T09:26:54.866Z"},"valor":{"type":"number","description":"Valor do patrimônio","example":100},"descricao":{"type":"string","description":"Descrição do patrimônio","example":"Compra de bens"},"codigoDoGrupo":{"type":"string","description":"Código do grupo de depreciação. Consultar códigos disponíveis em: https://siafic-teste.3tecnos.com.br/api-docs/swagger/grupos/","example":"5199"},"fornecedor":{"description":"Informações do fornecedor","$ref":"#/definitions/FornecedorModel"},"empenho":{"description":"Informações do empenho","$ref":"#/definitions/EmpenhoModel"},"notaFiscal":{"description":"Informações da nota fiscal","$ref":"#/definitions/NotaFiscalModel"}},"required":["tipoDeEntrada","data","valor","descricao","codigoDoGrupo"],"description":"Dados de Entrada de um novo Patrimônio.\n    * Quando o tipo de entrada for \"1 - Compra\", os dados do fornecedor, empenho e nota fiscal são obrigatórios.\n    * Quando o tipo de entrada for \"4 - Dação em pagamento\" ou \"5 - Adjudicação\", os dados do fornecedor são obrigatórios.\n  "},"BaixarPatrimonioModel":{"type":"object","properties":{"tipoDeBaixa":{"type":"number","description":"Tipo de baixa. O números válidos são: 1 - Inservível, 2 - Alienação, 3 - Doação","example":1},"tipoDeLancamento":{"type":"number","description":"Tipo de lançamento. O números válidos são: 1 - Baixa Patrimonial, 2 - Depreciação, 3 - Amortização, 4 - Exaustão, 5 - Transferência","example":1},"data":{"type":"date","description":"Data e hora em que aconteceu a baixa no sistema estruturante de Tributos. Formato ISO string","example":"2022-01-02T09:26:54.866Z"},"valor":{"type":"number","description":"Valor da baixa","example":100},"descricao":{"type":"string","description":"Descrição da baixa","example":"Inutilização por uso"}},"required":["tipoDeLancamento","data","valor","descricao"],"description":"Dados para baixa de um Patrimônio.\n    * Tipo de baixa é obrigatório quando o tipo de lançamento for '1 - Baixa Patrimonial'"},"ObterPatrimonioModel":{"type":"object","properties":{"id":{"type":"string","description":"Id da transação. Utilizado para identificar a operação e consultar via GET","example":"vxDgP6qPJVpDyvsMpdmyl"},"createdAt":{"type":"date","description":"Data e hora em que persistiu no SIAFIC. Formato JSON object","example":"2022-01-02T09:26:54.866Z"},"baixas":{"type":"array","description":"Lista de baixas do patrimônio","example":[{"data":"2022-01-02T09:26:54.866Z","tipoDeBaixa":1,"valor":100,"descricao":"Inutilização por uso"}]},"tipoDeEntrada":{"type":"number","description":"Tipo de entrada do patrimônio. O números válidos são: 1 - Compra, 2 - Inventário, 3 - Doação, 4 - Dação em pagamento, 5 - Adjudicação, 6 - Consórcio, 7 - Transferência","example":1},"data":{"type":"string","description":"Data e hora em que aconteceu o patrimônio no sistema estruturante de Tributos. Formato ISO string","example":"2022-01-02T09:26:54.866Z"},"valor":{"type":"number","description":"Valor do patrimônio","example":100},"descricao":{"type":"string","description":"Descrição do patrimônio","example":"Compra de bens"},"codigoDoGrupo":{"type":"string","description":"Código do grupo de depreciação","example":"5199"},"fornecedor":{"description":"Informações do fornecedor","$ref":"#/definitions/FornecedorModel"},"empenho":{"description":"Informações do empenho","$ref":"#/definitions/EmpenhoModel"},"notaFiscal":{"description":"Informações da nota fiscal","$ref":"#/definitions/NotaFiscalModel"}},"required":["id","createdAt","baixas","tipoDeEntrada","data","valor","descricao","codigoDoGrupo"],"description":"Dados de Entrada de um novo Patrimônio"},"CriarFolhaDePagamentoModel":{"type":"object","properties":{"ano":{"type":"number","description":"Ano da Folha de Pagamento","example":2022},"funcionario":{"description":"Ano da Folha de Pagamento","$ref":"#/definitions/FuncionarioModel"},"tipoDaFolha":{"description":"Tipo da Folha de Pagamento","$ref":"#/definitions/TipoDaFolhaModel"},"regime":{"description":"Regime da Folha de Pagamento","$ref":"#/definitions/RegimeModel"},"eventos":{"type":"array","description":"Lista de eventos da Folha de Pagamento","items":{"$ref":"#/definitions/EventoModel"}}},"required":["ano"],"description":"Dados de Entrada de uma nova Folha de Pagamento."},"EnderecoModel":{"type":"object","properties":{"logradouro":{"type":"string","description":"Logradouro do endereço do funcionário","example":"Rua Pedro Álvares Cabral"},"numero":{"type":"string","description":"Número do endereço do funcionário","example":"123"},"bairro":{"type":"string","description":"Bairro do endereço do funcionário","example":"Santa Maria"},"cep":{"type":"string","description":"CEP do endereço do funcionário","example":"49044170"},"municipio":{"description":"CEP do endereço do funcionário","$ref":"#/definitions/MunicipioModel"}},"required":["logradouro","numero","bairro","cep"],"description":"Endereco do Funcionário"},"EventoModel":{"type":"object","properties":{"numero":{"type":"number","description":"Número do Evento da Folha de Pagamento","example":102},"nome":{"type":"string","description":"Nome do Evento da Folha de Pagamento","example":"Vencimentos"},"tipoDoEvento":{"type":"string","description":"Tipo do Evento da Folha de Pagamento. Informar: P - Provento, D - Desconto","example":"P"},"valor":{"type":"number","description":"Valor do Evento da Folha de Pagamento","example":100}},"required":["numero","nome","tipoDoEvento","valor"],"description":"Evento da Folha de Pagamento"},"FuncionarioModel":{"type":"object","properties":{"cpf":{"type":"string","description":"CPF do funcionário","example":"87515276509"},"nome":{"type":"string","description":"Nome do Funcionário","example":"Kamilly Paiva Rabelo"},"sexo":{"type":"string","description":"Sexo do Funcionário. Informe M ou F.","example":"F"},"categoriaDoTrabalhador":{"type":"number","description":"Categoria do trabalhador da tabela do E-Social. Consultar: https://www.gov.br/esocial/pt-br/documentacao-tecnica/manuais/leiautes-esocial-v-1-1-beta/tabelas.html#01","example":101},"endereco":{"description":"Endereço do Funcionário","$ref":"#/definitions/EnderecoModel"}},"required":["cpf","nome","sexo","categoriaDoTrabalhador"],"description":"Informações do funcionário. Obrigatório em situações de contratos que são empenhados unitariamente por funcionário, a exemplo de estagiários. Nos demais casos, não informar."},"MunicipioModel":{"type":"object","properties":{"codigoIBGE":{"type":"number","description":"Código IBGE do município. Consulte: https://www.ibge.gov.br/explica/codigos-dos-municipios.php.","example":2800308},"nome":{"type":"string","description":"Nome do município","example":"Aracaju"},"uf":{"type":"string","description":"UF do município. Apenas a sigla.","example":"SE"}},"required":["codigoIBGE","nome","uf"],"description":"Município do Funcionário"},"ObterFolhaDePagamentoModel":{"type":"object","properties":{"id":{"type":"string","description":"Id da transação. Utilizado para identificar a operação e consultar via GET","example":"ksZNFXi_GD4JbSjbrhLI2"},"createdAt":{"type":"string","description":"Data e hora em que persistiu no SIAFIC. Formato JSON object","example":"2022-12-30T14:46:24.397Z"},"ano":{"type":"number","description":"Ano da Folha de Pagamento","example":2022},"funcionario":{"description":"Ano da Folha de Pagamento","$ref":"#/definitions/FuncionarioModel"},"tipoDaFolha":{"description":"Tipo da Folha de Pagamento","$ref":"#/definitions/TipoDaFolhaModel"},"regime":{"description":"Regime da Folha de Pagamento","$ref":"#/definitions/RegimeModel"},"eventos":{"type":"array","description":"Lista de eventos da Folha de Pagamento","items":{"$ref":"#/definitions/EventoModel"}}},"required":["id","createdAt","ano"],"description":"Dados de Entrada de uma nova Folha de Pagamento."},"RegimeModel":{"type":"object","properties":{"numero":{"type":"number","description":"Número do Regime da Folha de Pagamento","example":1},"nome":{"type":"string","description":"Nome do Regime da Folha de Pagamento","example":"Agente Político"}},"required":["numero","nome"],"description":"Regime da Folha de Pagamento"},"TipoDaFolhaModel":{"type":"object","properties":{"numero":{"type":"number","description":"Número do Tipo da Folha de Pagamento","example":1},"nome":{"type":"string","description":"Nome do Tipo da Folha de Pagamento","example":"Geral"}},"required":["numero","nome"],"description":"Tipo da Folha de Pagamento"}},"swagger":"2.0","securityDefinitions":{"bearerAuth":{"type":"apiKey","in":"header","name":"Authorization"}}}