API

Abaixo vemos um exemplo de como os filtros são passados na URL de todos os serviço:

?type={json|xml}&idCliente={Id do Cliente}&page={Página Atual}&pageSize={Tamanho da Página}

Erros

Caso algum filtro esteja com o nome incorreto, ou com valores inválidos, o usuário verá uma mensagem de aviso sobre o que está fora do padrão, essas mensagens são:

Informações Adicionais

Para fins informativos são retornados no cabeçalho da requisição algumas informações

Clientes

Exemplo:

{{url}}/clientes?type=json

Parâmetros

Retorno dos dados

                      
                <cliente>
                    <idcliente>210</idcliente>
                    <desccliente>PortalFacil_Demo</desccliente>
                    </cliente>
                    <cliente>
                    <idcliente>220</idcliente>
                    <desccliente>PortalFacil_Ilheus</desccliente>
                    </cliente>
                    <cliente>
                    <idcliente>205</idcliente>
                    <desccliente>PortalFacil_CamTaubateNew</desccliente>
                    </cliente>
                    <cliente>
                    <idcliente>178</idcliente>
                    <desccliente>PortalFacil_Uba</desccliente>
                </cliente>
              
             

                    
                [  
                    {  
                       "IdCliente":"210",
                       "DescCliente":"PortalFacil_Demo"
                    },
                    {  
                       "IdCliente":"220",
                       "DescCliente":"PortalFacil_Ilheus"
                    },
                    {  
                       "IdCliente":"205",
                       "DescCliente":"PortalFacil_CamTaubateNew"
                    },
                    {  
                       "IdCliente":"178",
                       "DescCliente":"PortalFacil_Uba"
                    }
                ]
             
             

Contratos

Exemplo:

{{url}}/contratos?type=json&idCliente={{id}}&page=1&pageSize=100&dtInicio=01/01/{{anocorte}}&dtFim=31/12/{{anocorte}}

Parâmetros

Em Contratos temos alguns outros filtros que também podem ser passados na URL que são:

Retorno dos dados

Após acessarmos temos o retorno dos dados dos contratos que são:

                  
<Contrato>
	<NumContrato>3014</NumContrato>
	<NumProcesso>PRC0000314</NumProcesso>
	<DescFornecedor>CASTRO & FILHOS LTDA</DescFornecedor>
	<NumCpfCnpjFornecedor>21.549.670/0001-31</NumCpfCnpjFornecedor>
	<DescObjeto>
	AQUISICAO DE GENEROS ALIMENTICIOS NAO PERECIVEIS, DESTINADOS A MANUTENCAO DAS ATIVIDADES REALIZADAS PELAS OFICINAS DO CREAS, CRAS E ALIMENTACAO DOS A- BRIGADOS DA CASA DA JUVENTUDE.
	</DescObjeto>
	<VlContrato>20076.05</VlContrato>
	<DtInicio>12/02/{{anocorte - 1}}</DtInicio>
	<DtFim>31/12/{{anocorte - 1}}</DtFim>
	<DtAssinatura>12/02/{{anocorte - 1}}</DtAssinatura>
	<DtPublicacao>17/03/{{anocorte - 1}}</DtPublicacao>
	<NumAnoLicitacao>10/{{anocorte - 1}}</NumAnoLicitacao>
	<TpLicitacao>Pregão</TpLicitacao>
	<Aditivos>
		<AditivoContrato>
		<DescObservacao/>
		<DtAditivo>16/09/{{anocorte - 1}}</DtAditivo>
		<DtAssinaturaAditivo>19/08/{{anocorte - 1}}</DtAssinaturaAditivo>
		<NumAditivo>10532</NumAditivo>
		<VlAditivo>360.00</VlAditivo>
		<DescObservacao></DescObservacao>
		</AditivoContrato>
	</Aditivos>
</Contrato>
                  
             

                
{  
	"NumContrato":"3014",
	"NumProcesso":"PRC0000314",
	"DescFornecedor":"CASTRO & FILHOS LTDA",
	"NumCpfCnpjFornecedor":"21.549.670/0001-31",
	"DescObjeto":"AQUISICAO DE GENEROS ALIMENTICIOS NAO PERECIVEIS,  DESTINADOS A MANUTENCAO DAS ATIVIDADES REALIZADAS  PELAS OFICINAS DO CREAS, CRAS E ALIMENTACAO DOS A- BRIGADOS DA CASA DA JUVENTUDE.",
	"VlContrato":"20076.05",
	"DtInicio":"12/02/{{anocorte - 1}}",
	"DtFim":"31/12/{{anocorte - 1}}",
	"DtAssinatura":"12/02/{{anocorte - 1}}",
	"DtPublicacao":"17/03/{{anocorte - 1}}",
	"NumAnoLicitacao":"10/{{anocorte - 1}}",
	"TpLicitacao":"Pregão",
	"Aditivos":
        [  
	    {  
		    "NumAditivo":"10532",
		    "DtAditivo":"16/09/{{anocorte - 1}}",
		    "DtAssinaturaAditivo":"19/08/{{anocorte - 1}}",
		    "VlAditivo":"360.00",
		    "DescObservacao":""
	    }
	 ]
}
                
             

Receitas

Exemplo:

{{url}}/receitas?type=json&idCliente={{id}}&page=1&pageSize=100&numano={{anocorte}}

Parâmetros

Em Receitas temos alguns outros filtros que também podem ser passados na URL que são:

Retorno dos dados

Após acessarmos temos o retorno dos dados das receitas que são:

                  
<Receita>
	<NumExercicio>{{anocorte}}</NumExercicio>
	<NumReceita>1.0.0.0.00.00.00</NumReceita>
	<DescReceita>Receitas Correntes</DescReceita>
	<VlPrevisto>227106050.00</VlPrevisto>
	<VlRealizado>111449189.34</VlRealizado>
</Receita>
              
             

                
{  
	"NumExercicio":"{{anocorte}}",
	"NumReceita":"1.0.0.0.00.00.00",
	"DescReceita":"Receitas Correntes",
	"VlPrevisto":"227106050.00",
	"VlRealizado":"111449189.34"
}
                
             

Servidores

Exemplo:

{{url}}/servidores?type=json&idCliente={{id}}&page=1&pageSize=100&dtcompetencia=01/{{anocorte}}

Parâmetros

Em Servidores temos alguns outros filtros que também podem ser passados na URL que são:

Retorno dos dados

Após acessarmos temos o retorno dos dados das servidores que são:

                  
<Servidor>
	<NumMatricula>5659</NumMatricula>
	<DescServidor>ABEL JOÂO PEDRO</DescServidor>
	<DescUnidade>FUNDO MUNICIPAL DE SAUDE<DescUnidade>
	<DescCargo>TECNICO DE NIVEL SUPERIOR I</DescCargo>
	<DescFuncao>TECNICO DE NIVEL SUPERIOR I</DescFuncao>
	<DtCompetencia>01/{{anocorte}}</DtCompetencia>
	<VlBase>3378.68</VlBase>
	<VlProvento>3878.68</VlProvento>
	<VlDesconto>2348.56</VlDesconto>
	<VlLiquido>1530.12</VlLiquido>
</Servidor>
              
             

                
{  
	"NumMatricula":"5659",
	"DescServidor":"ABEL JOÂO PEDRO",
	"DescUnidade":"FUNDO MUNICIPAL DE SAUDE",
	"DescCargo":"TECNICO DE NIVEL SUPERIOR I",
	"DescFuncao":"TECNICO DE NIVEL SUPERIOR I",
	"DtCompetencia":"01/{{anocorte}}",
	"VlBase":"3378.68",
	"VlProvento":"3878.68",
	"VlDesconto":"2348.56",
	"VlLiquido":"1530.12"
}
                
             

Despesas

Exemplo:

{{url}}/despesas?type=json&idCliente={{id}}&page=1&pageSize=100&numano={{anocorte}}

Parâmetros

Em Despesas temos alguns outros filtros que também podem ser passados na URL que são:

Retorno dos dados

Após acessarmos temos o retorno dos dados das despesas que são:

                  
<Despesa>
	<NumExercicio>{{anocorte}}</NumExercicio>
	<NumDespesa>3.0.00.00.00</NumDespesa>
	<DescDespesa>Despesas Correntes</DescDespesa>
	<NumProjeto>2.359</NumProjeto>
	<DescProjeto>REMUNERACAO PROF.MAGIS CRECHES,EDC.INFANTIL-FUN60%</DescProjeto>
	<VlEmpenhado>257662296.18</VlEmpenhado>
	<VlLiquidado>207257173.03</VlLiquidado>
	<VlPago>102835257.67</VlPago>
</Despesa>
              
             

                
{  
	"NumExercicio":"{{anocorte}}",
	"NumDespesa":"3.0.00.00.00",
	"DescDespesa":"Despesas Correntes",
	"NumProjeto":"2.359",
	"DescProjeto":"REMUNERACAO PROF.MAGIS CRECHES,EDC.INFANTIL-FUN60%",
	"VlEmpenhado":"257662296.18",
	"VlLiquidado":"207257173.03",
	"VlPago":"102835257.67"
}
                
             

Empenhos

Exemplo:

{{url}}/empenhos?type=json&idCliente={{id}}&page=1&pageSize=100&dtInicio=01/01/{{anocorte}}&dtFim=31/12/{{anocorte}}

Parâmetros

Em Empenhos temos alguns outros filtros que também podem ser passados na URL que são:

Retorno dos dados

Após acessarmos temos o retorno dos dados das empenhos que são:

                    
                        <Empenho>
                        <NumEmpenho>01273</NumEmpenho>
                        <TpEmpenho>ORDINÁRIO</TpEmpenho>
                        <DtEmpenho>29/01/{{anocorte}}</DtEmpenho>
                        <VlEmpenho>19131.43</VlEmpenho>
                        <NumDespesa>3.1.90.01.02</NumDespesa>
                        <DescDespesa>
                        Aposentadorias Custeadas com Recursos Ordinários do Tesouro
                        </DescDespesa>
                        <NumCpfCnpjFornecedor>18.128.207/0001-01</NumCpfCnpjFornecedor>
                        <DescFornecedor>PREFEITURA MUNICIPAL DE UBA</DescFornecedor>
                        <NumUnidade>02002003</NumUnidade>
                        <DescUnidade>DIVISAO DE GESTAO DE PESSOAS</DescUnidade>
                        <NumLicitacao>10</NumLicitacao>
                        <TpLicitacao>Pregão</TpLicitacao>
                        <DtLicitacao>{{anocorte}}</DtLicitacao>
                        <NumProcesso>1020{{anocorte}}</NumProcesso>
                        <NumFuncao>04</NumFuncao>
                        <DescFuncao>ADMINISTRACAO</DescFuncao>
                        <NumSubFuncao>122</NumSubFuncao>
                        <DescSubFuncao>ADMINISTRACAO GERAL</DescSubFuncao>
                        <NumPrograma>0001</NumPrograma>
                        <DescPrograma>APOIO ADMINSTRATIVO</DescPrograma>
                        <NumDestinacao>100</NumDestinacao>
                        <DescDestinacao>RECURSOS ORDINARIOS</DescDestinacao>
                        <DescEmpenho>
                        DESP.VIAGEM NOS TERMOS DA LEI 5264/11 E DECRETO 7253 DE 01/04/13, COMPREENDENDO REFEICOES E OUTROS QUANDO EM IDA A DIVERSAS CIDADES A SERVICO DO GABINETE DO PREFEITO, NO EXERCICIO DE 2018. CARGO: AUDITOR DO CONTROLE INTERNO.
                        </DescEmpenho>
                        <NumProjeto>141</NumProjeto>
                        <DescProjeto>MANUTENÇÃO DAS ATIVIDADES DO HOSPITAL</DescProjeto>
                        <DescLicitacao>10/{{anocorte}} - Pregão</DescLicitacao>
                        </Empenho>
                    
             

                    
                        {
                        "NumEmpenho":"01273",
                        "TpEmpenho":"ORDINÁRIO",
                        "DtEmpenho":"29/01/{{anocorte}}",
                        "VlEmpenho":"19131.43",
                        "NumDespesa":"3.1.90.01.02",
                        "DescDespesa":"Aposentadorias Custeadas com Recursos Ordinários do Tesouro",
                        "NumCpfCnpjFornecedor":"18.128.207/0001-01",
                        "DescFornecedor":"PREFEITURA MUNICIPAL DE UBA",
                        "NumUnidade":"02002003",
                        "DescUnidade":"DIVISAO DE GESTAO DE PESSOAS",
                        "NumLicitacao":"10",
                        "TpLicitacao":"Pregão",
                        "DtLicitacao":"{{anocorte}}",
                        "NumProcesso":"1020{{anocorte}}",
                        "NumFuncao":"04",
                        "DescFuncao":"ADMINISTRACAO",
                        "NumSubFuncao":"122",
                        "DescSubFuncao":"ADMINISTRACAO GERAL",
                        "NumPrograma":"0001",
                        "DescPrograma":"APOIO ADMINSTRATIVO",
                        "NumDestinacao":"100",
                        "DescDestinacao":"RECURSOS ORDINARIOS",
                        "DescEmpenho":"DESP.VIAGEM  NOS  TERMOS  DA LEI 5264/11 E DECRETO 7253 DE 01/04/13, COMPREENDENDO REFEICOES E OUTROS QUANDO  EM  IDA  A  DIVERSAS  CIDADES A SERVICO DO GABINETE DO PREFEITO, NO EXERCICIO DE 2018. CARGO: AUDITOR DO CONTROLE INTERNO.",
                        "NumProjeto":"141",
                        "DescProjeto":"MANUTENÇÃO DAS ATIVIDADES DO HOSPITAL",
                        "DescLicitacao":"10/{{anocorte}} - Pregão"
                        }
                    
             

Liquidações

Exemplo:

{{url}}/liquidacoes?type=json&idCliente={{id}}&page=1&pageSize=100&dtInicio=01/01/{{anocorte}}&dtFim=31/12/{{anocorte}}

Parâmetros

Em Liquidações temos alguns outros filtros que também podem ser passados na URL que são:

Retorno dos dados

Após acessarmos temos o retorno dos dados das liquidações que são:

                  
<Liquidacao>
	<NumLiquidacao>00004</NumLiquidacao>
	<NumEmpenho>00004</NumEmpenho>
	<DescUnidade>GABINETE DO PREFEITO</DescUnidade>
	<NumUnidade>02001001</NumUnidade>
	<DescDespesa>Diárias de Prefeito</DescDespesa>
	<NumDespesa>3.3.90.14.03</NumDespesa>
	<DescFornecedor>EDVALDO BAIAO ALBINO</DescFornecedor>
	<NumCpfCnpjFornecedor>371.875.116-04</NumCpfCnpjFornecedor>
	<DtLiquidacao>02/01/{{anocorte}}</DtLiquidacao>
	<VlLiquidado>390.00</VlLiquidado>
	<DescLiquidacao>
	PARCELA ALIMENTACAO E HOSPEDAGEM PARA SR PREFEITO IR A BELO HORIZONTE PARTICIPAR DE REUNIOES PARA TRATAR DE ASSUNTOS DO INTERESSE DO MUNICIPIO. RELATORIO NO 122827.
	</DescLiquidacao>
</Liquidacao>
              
             

                
{  
	"NumLiquidacao":"00004",
	"NumEmpenho":"00004",
	"DescUnidade":"GABINETE DO PREFEITO",
	"NumUnidade":"02001001",
	"DescDespesa":"Diárias de Prefeito",
	"NumDespesa":"3.3.90.14.03",
	"DescFornecedor":"EDVALDO BAIAO ALBINO",
	"NumCpfCnpjFornecedor":"371.875.116-04",
	"DtLiquidacao":"02/01/{{anocorte}}",
	"VlLiquidado":"390.00",
	"DescLiquidacao":"PARCELA  ALIMENTACAO E HOSPEDAGEM PARA SR PREFEITO IR  A  BELO  HORIZONTE PARTICIPAR DE REUNIOES PARA TRATAR  DE  ASSUNTOS  DO  INTERESSE  DO MUNICIPIO. RELATORIO NO 122827."
}
                
             

Pagamentos

Exemplo:

{{url}}/api/pagamentos?type=json&idCliente={{id}}&page=1&pageSize=100&dtInicio=01/01/{{anocorte}}&dtFim=31/12/{{anocorte}}

Parâmetros

Em Pagamentos temos alguns outros filtros que também podem ser passados na URL que são:

Retorno dos dados

Após acessarmos temos o retorno dos dados das pagamentos que são:

                  
<Pagamento>
	<NumPagamento>00498</NumPagamento>
	<NumEmpenho>00498</NumEmpenho>
	<DescUnidade>GABINETE DO PREFEITO</DescUnidade>
	<NumUnidade>02001001</NumUnidade>
	<DescDespesa>Diárias de demais servidores</DescDespesa>
	<NumDespesa>3.3.90.14.05</NumDespesa>
	<DescFornecedor>FRANCISCO MARINO DE AZEVEDO</DescFornecedor>
	<NumCpfCnpjFornecedor>045.027.366-00</NumCpfCnpjFornecedor>
	<DtPagamento>06/01/{{anocorte}}</DtPagamento>
	<VlPagamento>1500.00</VlPagamento>
	<DescPagamento>
	ADIANTAMENTO DE NUMERARIOS PARA COBRIR DESPESAS RE FERENTES A DIARIAS DE VIAGENS DE SERVIDOR PUBLICO A SERVICO DO MUNICIPIO CONFORME LEI MUNICIPAL 2613 E 170795, ALTERADAS PELAS LEIS 288599, 2926
	</DescPagamento>
</Pagamento>
              
             

                
{  
	"NumPagamento":"00498",
	"NumEmpenho":"00498",
	"DescUnidade":"GABINETE DO PREFEITO",
	"NumUnidade":"02001001",
	"DescDespesa":"Diárias de demais servidores",
	"NumDespesa":"3.3.90.14.05",
	"DescFornecedor":"FRANCISCO MARINO DE AZEVEDO",
	"NumCpfCnpjFornecedor":"045.027.366-00",
	"DtPagamento":"06/01/{{anocorte}}",
	"VlPagamento":"1500.00",
	"DescPagamento":"ADIANTAMENTO DE NUMERARIOS PARA COBRIR DESPESAS RE FERENTES  A DIARIAS DE VIAGENS DE SERVIDOR PUBLICO A SERVICO DO MUNICIPIO CONFORME LEI MUNICIPAL 2613 E 170795, ALTERADAS PELAS LEIS 288599, 2926"
}
                
             

Extra Orçamentária

Exemplo:

{{url}}/extraorcamentarias?type=json&idCliente={{id}}&page=1&pageSize=100&dtInicio=01/01/{{anocorte}}&dtFim=31/12/{{anocorte}}

Parâmetros

Retorno dos dados

Após acessarmos temos o retorno dos dados de Extra Orçamentária que são:

                  
<Extra>
	<NumOrdem>{{anocorte}}009666001</NumOrdem>
	<NumExtra>0202000010001</NumExtra>
	<DtMovimento>19/05/{{anocorte}}</DtMovimento>
	<DescConta>INSS - PRODUTOR RURAL</DescConta>
	<DescFornecedor>FERNANDO DE ALMEIDA</DescFornecedor>
	<TpExtra>P</Tipo>
	<VlExtra>1.01</Valor>
</Extra>
              
             

                
{  
	"NumOrdem":"{{anocorte}}009666001",
	"NumExtra":"0202000010001",
	"DtMovimento":"19/05/{{anocorte}}",
	"DescConta":"INSS - PRODUTOR RURAL",
	"DescFornecedor":"FERNANDO DE ALMEIDA",
	"TpExtra":"P",
	"VlExtra":"1.01"
}
                
             

Restos a Pagar

Exemplo:

{{url}}/restos?type=json&idCliente={{id}}&page=1&pageSize=100&numano={{anocorte - 1}}

Parâmetros

Em Restos a Pagar temos alguns outros filtros que também podem ser passados na URL que são:

Retorno dos dados

Após acessarmos temos o retorno dos dados dos restos a pagar que são:

                  
<RestoPagar>
	<NumEmpenho>00012</NumEmpenho>
	<TpEmpenho>ESTIMATIVO</TpEmpenho>
	<DtEmpenho>02/01/{{anocorte - 1}}</DtEmpenho>
	<VlEmpenho>8000.00</VlEmpenho>
	<NumDespesa>3.3.90.30.04</NumDespesa>
	<DescDespesa>Gás Engarrafado</DescDespesa>
	<NumCpfCnpjFornecedor>71.441.661/0001-09</NumCpfCnpjFornecedor>
	<DescFornecedor>E.C.NASCIMENTO & CIA. LTDA.</DescFornecedor>
	<NumUnidade>02002002</NumUnidade>
	<DescUnidade>DIVISAO DE PATRIMONIO E ADMINISTRACAO DE MATERIAIS</DescUnidade>
	<VlInscrito>400.00</VlrInscrito>
	<VlPago>400.00</VlrPago>
	<VlCancelado>0.00</VlrCancelado>
</RestoPagar>
              
             

                
{  
   "NumEmpenho":"00012",
   "TpEmpenho":"ESTIMATIVO",
   "DtEmpenho":"02/01/{{anocorte - 1}}",
   "VlEmpenho":"8000.00",
   "NumDespesa":"3.3.90.30.04",
   "DescDespesa":"Gás Engarrafado",
   "NumCpfCnpjFornecedor":"71.441.661/0001-09",
   "DescFornecedor":"E.C.NASCIMENTO & CIA. LTDA.",
   "NumUnidade":"02002002",
   "DescUnidade":"DIVISAO DE PATRIMONIO E ADMINISTRACAO DE MATERIAIS",
   "VlInscrito":"400.00",
   "VlPago":"400.00",
   "VlCancelado":"0.00"
}
                
             

Licitações

Exemplo:

{{url}}/licitacoes?type=json&idCliente={{id}}&page=1&pageSize=100

Parâmetros

Em Licitações temos alguns outros filtros que também podem ser passados na URL que são:

Retorno dos dados

Após acessarmos temos o retorno dos dados das licitações que são:

                    
                        <Licitacao>
                        <NumLicitacao>190</NumLicitacao>
                        <NumAno>{{anocorte - 1}}</NumAno>
                        <NmUnidade>Divisão de Compras e Licitações</NmUnidade>
                        <NmLicitacaoModalidade>Pregão Eletrônico</NmLicitacaoModalidade>
                        <NumProcessoAdm>150</NumProcessoAdm>
                        <DtPublicacao>29/11/{{anocorte - 1}}</DtPublicacao>
                        <DtHabilitacao>13/12/{{anocorte - 1}}</DtHabilitacao>
                        <HrHabilitacao>08:00</HrHabilitacao>
                        <DtLimite>13/12/{{anocorte - 1}}</DtLimite>
                        <DmStatus>Homologada</DmStatus>
                        <DescObjeto>
                        Aquisição de materiais permanentes destinados a abertura e funcionamento de Abrigo para adolescente de 12 à 18 anos.
                        </DescObjeto>
                        <NuValorEstimado>529430.97</NuValorEstimado>
                        <Categorias>
                        <CategoriaLicitacao>
                        <NmLicitacaoCategoria>Equipamentos e suprimentos de informatica</NmLicitacaoCategoria>
                        </CategoriaLicitacao>
                        <CategoriaLicitacao>
                        <NmLicitacaoCategoria>Mobiliário</NmLicitacaoCategoria>
                        </CategoriaLicitacao>
                        </Categorias>
                        </Licitacao>
                    
             

                    
                        [
                        {
                        "NumLicitacao":"190",
                        "NumAno":"{{anocorte - 1}}",
                        "NmUnidade":"Divisão de Compras e Licitações",
                        "NmLicitacaoModalidade":"Pregão Eletrônico",
                        "NumProcessoAdm":"150",
                        "DtPublicacao":"29/11/{{anocorte - 1}}",
                        "DtHabilitacao":"13/12/{{anocorte - 1}}",
                        "HrHabilitacao":"08:00",
                        "DtLimite":"13/12/{{anocorte - 1}}",
                        "DmStatus":"Homologada",
                        "DescObjeto":"Aquisição de materiais permanentes destinados a abertura e funcionamento de Abrigo para adolescente de 12 à 18 anos.",
                        "NuValorEstimado":"529430.97",
                        "Categorias":[
                        {
                        "NmLicitacaoCategoria":"Equipamentos e suprimentos de informatica"
                        },
                        {
                        "NmLicitacaoCategoria":"Mobiliário"
                        }
                        ]
                        }
                        ]