API

IdCliente: Cliente:

A API disponibiliza dados relativos à transparência na gestão pública, conforme exigência da Lei 12.527 de 18 de novembro de 2011, Art. 8º, §3º, Incisos III e IV. Os dados são disponibilizados nos formatos XML e JSON, conforme abaixo:

Descrição Url
Clientes {{url}}/clientes
Contratos {{url}}/contratos
Receitas {{url}}/receitas
Servidores {{url}}/servidores
Despesas {{url}}/despesas
Empenhos {{url}}/empenhos
Liquidações {{url}}/liquidacoes
Pagamentos {{url}}/pagamentos
Extra Orçamentárias {{url}}/extraorcamentarias
Restos a Pagar {{url}}/restos
Em todas as chamadas da API estão presentes os seguintes filtros:

Nome Tipo Descrição
idCliente(obrigatório) inteiro Código de Identificação do Cliente.
type string json ou xml. Tipo de Retorno dos dados. Caso o valor não seja passado ou esteja incorreto o tipo xml será adotado como padrão.
page inteiro página atual.Iniciando em 1.
pagesize inteiro quantidade de registros retornados na páginas (Mínimo 1 ,Máximo 100).

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:

Situação Mensagem
Id Cliente vazio "Erro: Campo(s) obrigatório(s): Id do Cliente (idCliente)".
Id Cliente válido, mas não configurado "Erro: Cliente não configurado (idCliente)".
Id Cliente inválido (Letra, Números negativos, etc.) "Erro: Cliente inválido (idCliente)".
Página vazia "Erro: Campo(s) obrigatório(s): Página (page)".
Página não existe "Erro: Página inválida (page). Valor mínimo: 1".
Página inválida (Letra, Números negativos, etc.) "Erro: Página inválida (page). Valor mínimo: 1".
Tamanho da página vazia "Erro: Campo(s) obrigatório(s): Tamanho Página (pageSize)".
Tamanho da página inválida (Letra, Números negativos, etc.) "Erro: Paginação inválida (pageSize).
Valor mínimo: 1 Registro - Valor máximo: 100 Registros".
Ano não informado "Erro: Campo(s) obrigatório(s): Ano (numAno)".
Ano inválido "Erro: Ano inválido (numAno)".
Datas não informadas "Erro: Campo(s) obrigatório(s): Data Início (dtInicio), Data Fim (dtFim)".
Data Inicial não informada "Erro: Campo(s) obrigatório(s): Data Início (dtInicio)".
Data Final não informada "Erro: Campo(s) obrigatório(s): Data Fim (dtFim)".
Filtro inválido (Letra, Números negativos, etc.) "Dados não encontrados".
E por fim se algum erro de natureza desconhecida ocorrer será exibido "Erro: Contate o Administrador do Sistema."

Informações Adicionais

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

Informação Descrição
X-Page-Index Página atual
X-Page-Size Tamanho da página
X-Total-Count Quantidade de registros retornados em cada requisição

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:

Nome Tipo Descrição
numContrato inteiro Número do contrato.
descFornecedor string Nome do fornecedor do contrato.
dtAssinatura data Data de assinatura do contrato. Formato (01/01/{{anocorte}}).
dtPublicacao data Data de publicação do contrato. Formato (01/01/{{anocorte}}).
descObjeto string Objeto do contrato.
dtInicio(obrigatório) data Data inicial equivalente ao período da data do contrato. Formato (01/01/{{anocorte}}).
dtFim(obrigatório) data Data final equivalente ao período da data do contrato. Formato (01/01/{{anocorte}}).

Retorno dos dados

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

Nome Tipo Descrição Tamanho
DescFornecedor string Nome do Fornecedor 100
DescObjeto string Descrição do objeto do contrato. 200
DtAssinatura data Data de assinatura do contrato. 10
DtFim data Data final do contrato. 10
DtInicio data Data inicial do contrato. 10
DtPublicacao data Data da publicação do contrato. 10
NumAnoLicitacao inteiro Ano da licitação do contrato. 4
NumContrato inteiro Número do contrato. 50
NumCpfCnpjFornecedor string Número do documento do fornecedor.
Formatos: CPF (999.999.999-99), CNPJ (99.999.999/9999-99)
20
NumProcesso string Número do processo. 50
TpLicitacao string Tipo da licitação. 50
VlContrato decimal Valor do contrato. (18,2)
Aditivos do contrato lista
Nome Tipo Descrição Tamanho
DescObservacao string Descrição da observação. 1000
DtAditivo data Data do aditivo. 10
DtAssinaturaAditivo data Data em que o aditivo foi assinado. 10
NumAditivo inteiro Número do aditivo. 18
VlAditivo decimal Valor do aditivo. (18,2)
Obs.: Dados inexistentes aparecem como vazio ou 0.

Exemplo dos dados em:

XML
                  
<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>
                  
             

JSON
                
{  
	"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:

Nome Tipo Descrição
numAno(obrigatório) inteiro Ano da receita.
numReceita string Número da receita.
descReceita string Descrição da receita.

Retorno dos dados

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

Nome Tipo Descrição Tamanho
DescReceita string Descrição da Receita. 100
NumExercicio inteiro Número(ano) do exercício 4
NumReceita string Número da Receita. 20
VlPrevisto decimal Valor previsto. (18,2)
VlRealizado decimal Valor realizado. (18,2)
Obs.: Dados inexistentes aparecem como vazio ou 0.

Exemplo dos dados em:

XML
                  
<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>
              
             

JSON
                
{  
	"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:

Nome Tipo Descrição
dtCompetencia(obrigatório) data Data de Competência do servidor.
descNome string Nome do Servidor.
descCargoFuncao string Descrição do Cargo/Função.

Retorno dos dados

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

Nome Tipo Descrição Tamanho
DescCargo string Descrição do cargo do servidor. 50
DescFuncao string Descrição da função do servidor 50
DescServidor string Nome do servidor. 50
DescUnidade string Nome da Unidade. 50
DtCompetencia string Data da competência. 7
NumMatricula inteiro Número da matricula do servidor. 9
VlBase decimal Valor da base salarial do servidor. (18,2)
VlDesconto decimal Valor de desconto salarial do servidor. (18,2)
VlLiquido decimal Valor líquido do salário do servidor. (18,2)
VlProvento decimal Valor de proventos do servidor. (18,2)
Obs.: Dados inexistentes aparecem como vazio ou 0.

Exemplo dos dados em:

XML
                  
<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>
              
             

JSON
                
{  
	"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:

Nome Tipo Descrição
numAno(obrigatório) inteiro Ano da despesa.
numDespesa string Número da despesa.
descDespesa string Descrição da despesa.

Retorno dos dados

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

Nome Tipo Descrição Tamanho
NumExercicio inteiro Número(ano) do exercício. 4
NumDespesa string Número da Despesa. 50
DescDespesa string Descrição da Despesa. 100
VlEmpenhado decimal Valor empenhado. (18,2)
VlLiquidado decimal Valor liquidado. (18,2)
VlPago decimal Valor pago. (18,2)
Obs.: Dados inexistentes aparecem como vazio ou 0.

Exemplo dos dados em:

XML
                  
<Despesa>
	<NumExercicio>{{anocorte}}</NumExercicio>
	<NumDespesa>3.0.00.00.00</NumDespesa>
	<DescDespesa>Despesas Correntes</DescDespesa>
	<VlEmpenhado>257662296.18</VlEmpenhado>
	<VlLiquidado>207257173.03</VlLiquidado>
	<VlPago>102835257.67</VlPago>
</Despesa>
              
             

JSON
                
{  
	"NumExercicio":"{{anocorte}}",
	"NumDespesa":"3.0.00.00.00",
	"DescDespesa":"Despesas Correntes",
	"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:

Nome Tipo Descrição
dtInicio(obrigatório) data Data inicial para filtrar o período do empenho. Formato (01/01/{{anocorte}}).
dtFim(obrigatório) data Data final para filtrar o período do empenho. Formato (01/01/{{anocorte}}).
numEmpenho string Número do empenho.
descFornecedor string Nome do fornecedor.
descUnidade string Nome da Unidade.
tpEmpenho string Tipo do empenho.

Retorno dos dados

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

Nome Tipo Descrição Tamanho
NumEmpenho inteiro Número do Empenho. 50
TpEmpenho string Tipo do Empenho. 50
DtEmpenho data Data do Empenho. 10
VlEmpenho decimal Valor do Empenho. (18,2)
NumDespesa string Número da despesa. 50
DescDespesa string Nome da despesa. 100
NumCpfCnpjFornecedor string Número do documento do fornecedor.
Formatos: CPF (999.999.999-99), CNPJ (99.999.999/9999-99).
20
DescFornecedor string Nome do Fornecedor. 100
NumUnidade inteiro Número da unidade. 20
DescUnidade string Nome da unidade. 50
NumLicitacao inteiro Número da Licitação. 4
TpLicitacao string Tipo da Licitação. 50
DtLicitacao string Ano da Licitação. 4
NumProcesso string Número do Processo. 50
Obs.: Dados inexistentes aparecem como vazio ou 0.

Exemplo dos dados em:

XML
                  
<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>                    
</Empenho>
              
             

JSON
                
{  
	"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}}"
}
                
             

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:

Nome Tipo Descrição
dtInicio(obrigatório) data Data inicial para filtrar o período da liquidação. Formato(01/01/{{anocorte}}).
dtFim(obrigatório) data Data final para filtrar o período da liquidação. Formato(01/01/{{anocorte}}).
numEmpenho inteiro Número do Empenho.
numLiquidacao inteiro Número da Liquidação.
descFornecedor string Nome do Fornecedor.
descUnidade string Nome da Unidade.

Retorno dos dados

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

Nome Tipo Descrição Tamanho
NumLiquidacao inteiro Número da Liquidação. 50
NumEmpenho inteiro Número do Empenho. 50
DescUnidade string Nome da Unidade. 50
NumUnidade inteiro Número da Unidade. 20
DescDespesa string Nome da Despesa. 100
NumDespesa string Número da Despesa. 50
DescFornecedor string Nome do Fornecedor. 100
NumCpfCnpjFornecedor string Número do documento do Fornecedor.
Formatos: CPF (999.999.999-99), CNPJ (99.999.999/9999-99).
20
DtLiquidacao data Data da Liquidação. 10
VlLiquidacao decimal Valor da Liquidação. (18,2)
DescLiquidacao string Descrição da Liquidação. 500
Obs.: Dados inexistentes aparecem como vazio ou 0.

Exemplo dos dados em:

XML
                  
<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>
              
             

JSON
                
{  
	"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:

Nome Tipo Descrição
dtInicio(obrigatório) data Data inicial para filtrar o período do pagamento. Formato(01/01/{{anocorte}}).
dtFim(obrigatório) data Data final para filtrar o período do pagamento. Formato(01/01/{{anocorte}}).
numEmpenho inteiro Número do Empenho.
numPagamento inteiro Número do Pagamento.
descFornecedor string Nome do Fornecedor.
descUnidade string Nome da Unidade.

Retorno dos dados

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

Nome Tipo Descrição Tamanho
NumPagamento inteiro Número da Ordem de Pagamento. 50
NumEmpenho inteiro Número do Empenho. 50
DescUnidade string Nome da Unidade. 50
NumUnidade inteiro Número da Unidade. 50
DescDespesa string Nome da Despesa. 100
NumDespesa string Número da Despesa. 50
DescFornecedor string Nome do Fornecedor. 100
NumCpfCnpjFornecedor string Número do documento do Fornecedor.
Formatos: CPF (999.999.999-99), CNPJ (99.999.999/9999-99).
20
DtPagamento data Data da Ordem de Pagamento. 10
VlPagamento decimal Valor da Ordem de Pagamento. (18,2)
DescPagamento string Descrição da Ordem de Pagamento. 500
Obs.: Dados inexistentes aparecem como vazio ou 0.

Exemplo dos dados em:

XML
                  
<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>
              
             

JSON
                
{  
	"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

Em Extra Orçamentária temos alguns outros filtros que também podem ser passados na URL que são:
Nome Tipo Descrição
dtInicio(obrigatório) data Data inicial para filtrar o período de Extra Orçamentária. Formato(01/01/{{anocorte}}).
dtFim(obrigatório) data Data final para filtrar o período de Extra Orçamentária. Formato(01/01/{{anocorte}}).
descFornecedor string Nome do Fornecedor.
tpExtra string Tipo da Extra Orçamentária (P ou R).

Retorno dos dados

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

Nome Tipo Descrição Tamanho
NumOrdem string Número da Ordem. 50
NumExtra string Número da Extra Orçamentária. 50
DtMovimento data Data do Movimento. 10
DescConta string Descrição da conta. 200
DescFornecedor string Nome do Fornecedor. 100
TpExtra string Tipo da Extra Orçamentária (P ou R). 1
VlExtra decimal Valor da Extra Orçamentária. (18,2)
Obs.: Dados inexistentes aparecem como vazio ou 0.

Exemplo dos dados em:

XML
                  
<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>
              
             

JSON
                
{  
	"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:

Nome Tipo Descrição
numAno(obrigatório) inteiro Ano da receita.
numEmpenho inteiro Número do Empenho.
descFornecedor string Nome do Fornecedor.
descUnidade string Nome da Unidade.
tpEmpenho string Tipo do Empenho.

Retorno dos dados

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

Nome Tipo Descrição Tamanho
NumEmpenho inteiro Número do Empenho. 50
TpEmpenho string Tipo do Empenho. 50
DtEmpenho data Data do Empenho. 10
VlEmpenho decimal Valor do Empenho. (18,2)
NumDespesa string Número da Despesa. 50
DescDespesa string Descrição da Despesa. 100
NumCpfCnpjFornecedor string Número do documento do Fornecedor. Formatos: CPF (999.999.999-99), CNPJ (99.999.999/9999-99). 20
DescFornecedor string Nome do Fornecedor. 100
NumUnidade inteiro Número da Unidade. 20
DescUnidade string Nome da Unidade. 50
VlInscrito decimal Valor Inscrito. (18,2)
VlPago decimal Valor Pago. (18,2)
VlCancelado decimal Valor Cancelado. (18,2)
Obs.: Dados inexistentes aparecem como vazio ou 0.

Exemplo dos dados em:

XML
                  
<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>
              
             

JSON
                
{  
   "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"
}