privado
180
edições
Mudanças
Ir para navegação
Ir para pesquisar
Linha 818:
Linha 818: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Gestão Escolar - API de integração (ver código-fonte)
Edição das 17h42min de 19 de maio de 2022
, 17h42min de 19 de maio de 2022Dados referentes a pesquisa financeira
|}
|}
=== Resumo financeiro: Obtendo dados: ===
Busca o resumo financeiro sumarizado por tipo de movimentação financeira ("Receber" e "Pagar") e contas contábeis dentro do intervalo de datas informado.
Método: GET
(base)/gestaoescolar/services/v1/resumofinanrio?inicio=01/01/2022&periodoLetivo=31/12/2021
====Query String (Parâmetros)====
{| class="wikitable"
|Obrigatório
|Campo
|Descrição
|-
|Sim
|inicio
|Data de inicio considerando o data de faturamento da movimentação financeira no formato dd/MM/aaaa
|-
|Sim
|fim
|Data de termino considerando o data de faturamento da movimentação financeira no formato dd/MM/aaaa
|-
|
|pagina (paginação)
|Indica qual página está listando na sequência
|-
|
|registros (paginação)
|Quantidade de registros que devem ser retornados em cada página
|}
==== Respostas esperadas ====
Status 200: : OK ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/matriculas?codigoUnidadeEnsino=1&periodoLetivo=2022 Exemplo])
Status 417: : Caso não seja informado o código da unidade de negócio e a descrição do período letivo ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/matriculas?codigoUnidadeEnsino=1 Exemplo])
Status 401: : Caso o token de autenticação não esteja no header da requisição ou esteja expirado ([https://ultramax.free.beeceptor.com/gestaoescolar/services/v1/matriculas?codigoUnidadeEnsino=1&periodoLetivo=2022&sigla=Med Exemplo])
{| class="wikitable"
|'''Atributo'''
|'''Descrição'''
|Tipo
|Tamanho
|-
|mes
|Representação numérica com o mês que foi contabilizado (Exemplo: janeiro = 1)
|Número
|
|-
|ano
|Ano que foi contabilizado
|Número
|
|-
|codigoContaContabil
|Código com a conta contábil contabilizada
|Texto
|15
|-
|contaContabilExterna
|Código utilizada por um sistema externo com a conta contábil contabilizada, esse caso é para associar um "de para" entre a conta contágio do Ultramax Gestão Escolar e um sistema externo
|Texto
|255
|-
|tipo
|Tipo da movimentação financeira contabilizada. Os tipos podem ser "Receber" e "Pagar"
|Texto
|7
|-
|valor
|Valor total sumarizado por mês/Ano/Tipo/Conta Contábil
|Número
|
|-
|percentualValorRelacaoTotal
|O quanto equivale em percentual em relação ao Total geral por Tipo dentro do intervalo pesquisado
|Númeo
|
|}
==APIS para manutenção da base de dados==
==APIS para manutenção da base de dados==