[W] Insere Baixa Conta Receber

<Comercial>

Especificação Técnica e Regras de Negócio

<Implantação dos sistemas Midia+>

Versão <4>

Produto MIDIA+

Solicitante

Criado por

Revisado por

Objetivo: Criar um serviço para efetuar baixas de contas a receber do midia+

Item no JIRA

Aceite do Cliente

Histórico de Alterações no Documento

Versão Data Atividade Responsável

1 25 de abr. de Orçamento Inicial Felipe Luiz Jungblut

2023

Objetivo

Promover endpoint para recebimento de baixas de contas a receber via API

Escopo do Produto

Criar APIs para receber baixar de contas a receber enviadas do midia+

Regras de Negócio

Cód. Descrição

RN1 A API deverá efetuar a baixa da conta a receber conforme interface de quitação de contas a receber.

RN2 A API não efetuará o controle de saldo da conta a receber

RN3 No caso de não encontrar algum objeto de referencia (moeda, conta financeira, operação financeira, tipo Movimento, Tipo
Documento) o sistema não efetuará a inclusão da baixa.

Especificação técnica
Criação de um novo serviço de API de quitação de contas a receber.

Requisição

1 {
2 "baixaContaReceber": [
3 {
4 "idContaReceber": 123,
5 "dataRecebimento": "25/04/2023",
6 "dataCredito": "25/04/2023",
7 "valorBaixa": 4900.00,
8 "valorAmortizado": 5000.00,
9 "valorDesconto": 100.00,
10 "valorJuros": 0.00,
11 "valorMulta": 0.00,
12 "moeda": {
13 "codigo": "1",
14 "nome": "REAL",
15 "codigoExterno": "1"
16 },
17 "contaFinanceira": {
18 "sigla": "123",
19 "nome": "Teste",
20 "codigoExterno": "23"
21 },
22 "lancamento": {
23 "dataCadastro": "25/04/2023",
24 "data": "25/04/2023",
25 "historico": "",
26 "valor": 4900.00,
27 "natureza": 1,
28 "compensadoBanco": "N",
29 "tipoHistorico": "",
30 "operacaoFinanceira": {
31 "codigo": "5",
32 "nome": "teste2",
33 "codigoExterno": "1235415"
34 },
35 "tipoMovimento": {
36 "codigo": "1",
37 "nome": "teste",
38 "codigoExterno": "123"
39 },
40 "tipoDocumento": {
41 "codigo": "123",
42 "nome": "teste",
43 "codigoExterno": "123"
44 }
45 }
46 }
47 ]
48 }

Campo Tipo Obrig. Descrição

baixaContaReceber Object Sim Array de objetos da baixa contareceber

idContaReceber Integer Sim Identificador da conta a receber

dataRecebimento String Sim Data de Recebimento da baixa receber (YYYY-MM-DD)

dataCredito String Sim Data de crédito da Baixa receber (YYYY-MM-DD)

valorBaixa Numeric Sim Valor da baixa (considerando juros, desconto e multa)

valorAmortizado Numeric Sim Valor de Amortização da conta a receber

valorDesconto Numeric Sim Valor de desconto

valorJuros Numeric Sim Valor de Juros

valorMulta Numeric Sim Valor de Multa

baixaContaReceber.moeda Object Sim Objeto da Moeda

codigo String Não Código do sistema remetente(apenas para conferência de

valores)

nome String Não Nome do sistema remetente(apenas para conferência de

valores)

codigoExterno String Sim Código Externo da Moeda, deverá ser o mesmo informado no
campo abaixo.

baixaContaReceber.contaFinanceira Object Sim Objeto da Conta Financeira

sigla String Não Sigla do sistema remetente(apenas para conferência de

valores)

nome String Não Nome do sistema remetente(apenas para conferência de

valores)

codigoExterno String Sim Código Externo da Conta Financeira, deverá ser o mesmo
informado no campo abaixo.

baixaContaReceber.lancamento Object Não Objeto do Lançamento Contábil

dataCadastro String Sim Data do cadastro do lançamento contábil (YYYY-MM-DD)

data String Sim Data do Lançamento Contábil (YYYY-MM-DD)

historico String Não Histórico do Lançamento.

Quando informado será gravado conforme recebido, senão
seguirá a regra do campo tipoHistorico.

valor Numeric Sim Valor de Amortização do Lançamento.

natureza int Sim Tipo de Natureza

1 - Crédito
2 - Débito

compensadoBanco char(1) Sim Compensado via banco

”S” - Sim
”N” - Não

tipoHistorico char(1) Sim Tipo de histórico

”P” - Personalizado conforme campo historico.
”C” - Conforme histórico da conta rebeber
”O” - Outros conforme definido no cadastro da empresa

baixaContaReceber.lancamento.operaca Object Não Objeto da Operação Financeira

oFinanceira

codigo String Não Código da operação financeira do sistema remetente(apenas

para conferência de valores)

nome String Não Nome da operação financeira do sistema remetente(apenas

para conferência de valores)

codigoExterno String Sim Código Externo da operação financeira, deverá ser o mesmo
informado no campo abaixo.
 baixaContaReceber.lancamento.tipoMovi Object Não Objeto do Tipo de Movimento
mento

codigo String Não Código do tipo de movimento do sistema remetente(apenas

para conferência de valores)

nome String Não Nome do tipo de movimento do sistema remetente(apenas

para conferência de valores)

codigoExterno String Sim Código Externo do tipo de movimento, deverá ser o mesmo
informado no campo abaixo.

baixaContaReceber.lancamento.tipoDocu Object Não Objeto do Tipo de Documento

mento

codigo String Não Código do tipo de documento do sistema remetente(apenas

para conferência de valores)

nome String Não Nome do tipo de documento do sistema remetente(apenas

para conferência de valores)

codigoExterno String Sim Código Externo ddo tipo de documento, deverá ser o mesmo
informado no campo abaixo.

Retorno

1 {
2 "baixaContareceber": [
3 {
4 "idContaReceber": 123,
5 "idBaixaContaReceber": 546,
6 "sucesso": "S",
7 "mensagem": "Baixa efetuada com sucesso"
8 },
9 {
10 "idContaReceber": 123,
11 "idBaixaContaReceber": 478,
12 "sucesso": "N",
13 "mensagem": "Conta Financeira não encontrada"
 14 }
15 ]
16 }

Campo Tipo Descrição

baixaContaReceber Object Array de Objetos de Baixa Conta Receber

idContaReceber Integer Identificador da Conta a Receber

idBaixaContaReceber Integer Identificador da Baixa a Receber

sucesso Char(1) Indica se a baixa foi efetuada com sucesso

”S” - Sim
”N” - Não

mensagem String Mensagem da transação

Dados de Acesso

Método: post

End-point: /services/midiamaisrest/financeiro/inserirBaixaContaReceber

Header:
content-type: application/json
authorization: token [deve ser enviado um token do adSim para acessar o serviço]

Exemplo Post: