Serviço externo padrão - Gerar lançamento contábil

Este serviço realiza a geração do lançamento contábil, permitindo realizar a contabilização das parcelas/contas referente aos filtros informados.

1. Parâmetros para chamada do serviço externo

Parâmetro	Descrição	Obrigatório	Tipo	Observação
dataInicial	Data base inicial para recuperar as parcelas/contas que serão contabilizadas	Sim	Date	Formado: dd/mm/yyyy
dataFinal	Data base final para recuperar as parcelas/contas que serão contabilizadas	Sim	Date	Formado: dd/mm/yyyy
faseMensalidadeGerada	Contabiliza fase de mensalidade gerada¹	Não	Integer	1 = Sim / 0 = Não
faseContaReceberGerada	Contabiliza fase de conta receber gerada¹	Não	Integer	1 = Sim / 0 = Não
faseMensalidadeFaturada	Contabiliza fase de mensalidade faturada¹	Não	Integer	1 = Sim / 0 = Não
faseContaReceberFaturada	Contabiliza fase de conta receber faturada¹	Não	Integer	1 = Sim / 0 = Não
faseMensalidadeRecebida	Contabiliza fase de mensalidade recebida¹	Não	Integer	1 = Sim / 0 = Não
faseContaReceberRecebida	Contabiliza fase de conta receber recebida¹	Não	Integer	1 = Sim / 0 = Não
faseRenegociacao	Contabiliza fase de renegociação¹	Não	Integer	1 = Sim / 0 = Não
loteId	Código do lote	Não	Integer
listaParcelasIds	Lista de identificadores das parcelas, separados por vírgula²	Não	String
unidadeId	Código da unidade corrente²	Não	Integer
dataDocumento	Data do documento	Não	Date	Data do documento original
token Deve-se passar no cabeçalho da requisição o parâmetro token. O valor deste parâmetro é gerado pelo serviço de geração de token.
¹ Pelo menos um dos parâmetros referente à fase é obrigatório.
² Pelo menos um dos parâmetros referente à código de unidade e lista de parcelas é obrigatório.

2. Exemplo de chamada do Serviço

URL: http://IP:PORTA/APLICACAO/rest/servicoexterno/execute/geraLancamento

2.1. Exemplo da passagem de parâmetros por Json:

{
  "loteId" : null,
  "dataDocumento" : null,
  "faseRenegociacao" : 0,
  "faseContaReceberGerada" : 0,
  "listaParcelasIds" : "30010,30011,30012",
  "faseMensalidadeRecebida" : 0,
  "dataInicial" : "02/02/2017 00:00:00",
  "faseContaReceberRecebida" : 0,
  "faseMensalidadeGerada" : 1,
  "dataFinal" : "03/02/2017 23:59:59",
  "faseContaReceberFaturada" : 0,
  "faseMensalidadeFaturada" : 1,
  "unidadeId" : 1
}

2.2. Exemplo de chamada do serviço no PostMan

Passando o token

Passando os demais parâmetros

3. Retorno do serviço (Json)

Para obter o retorno do serviço deve-se verificar o status da requisição http. Sempre que o status for 200, significa que o processo foi realizado com sucesso.

3.1. Atributos retornados do serviço para o chamador

Campo	Descrição	Tipo	Observação
logProcessoId	Identificador do log de processo	Integer	Pode ser utilizado no MentorWeb na tela de consulta de log, para consultar o log gerado.
quantidadeLancamentos	Quantidade de lançamentos que foram gerados	Integer
resultado	Retorna a situação do resultado	String(7)	Valores possíveis: SUCESSO / ERRO

Exemplo de retorno Json:

{
    "logProcessoId": 831587,
    "quantidadeLancamentos": 64,
    "resultado": "SUCESSO"
}

3.2. Possíveis retornos para o chamador do serviço

Código	Descrição	Observação
FIN_00027	É obrigatório informar o parâmetro código da unidade.	Quando compartilhamento LayoutContabil for por unidade ou grupo de unidade é obrigatório informar o parâmetro “unidadeId”
FIN_00028	É obrigatório informar o código da unidade ou a lista de parcelas.	É obrigatório informar pelo menos um dos parâmetros: “listaParcelasIds” ou “unidadeId”
FIN_00029	É obrigatório informar pelo menos uma fase para realizar a contabilização.	Pelo menos em um dos parâmetros de fase deve ser informado valor “1”, ou seja, deve contabilizar pelo menos uma das fases.

Exemplo de retorno Json:

{
    "resultado": "ERRO",
    "erro": {
        "operacao": "br.com.edusoft.mentorweb.servico.controller.ServicoExternoFinanceiroImplJava.geraLancamento",
        "valores": "{\n  \"loteId\" : null,\n  \"dataDocumento\" : null,\n  \"faseRenegociacao\" : 0,\n  \"faseContaReceberGerada\" : 0,\n  \"listaParcelasIds\" : \"\",\n  \"faseMensalidadeRecebida\" : 0,\n  \"dataInicial\" : \"08/02/2017\",\n  \"faseContaReceberRecebida\" : 0,\n  \"faseMensalidadeGerada\" : 1,\n  \"dataFinal\" : \"08/02/2017\",\n  \"faseContaReceberFaturada\" : 0,\n  \"faseMensalidadeFaturada\" : 1\n}",
        "motivo": "EduClientLogProcessoException: É obrigatório informar o código da unidade ou a lista de parcelas."
    }
}

Informações importantes:

Para que o sistema realize o processo de geração de lançamento contábil é necessário possuir a unidade logada para recuperar os layouts contábeis. Nesse caso, quando é informado o parâmetro código da unidade, esse valor é utilizado como unidade logada. Se não for informado (só não é obrigatório quando LayoutContabil é compartilhado entre todas as unidades) é utilizado como unidade logada a primeira unidade encontrada, pois como é compartilhado entre todas as unidades não irá fazer diferença.

Informações sobre o serviço de exclusão:

Acesse também a documentação para o serviço de exclusão. Para mais informações clique aqui para verificar a documentação.