IN Financeiro: mudanças entre as edições

De CIGAM WIKI
Sem resumo de edição
Linha 7: Linha 7:
===[[IN_CadastroLancamentos.integrador|CadastroLancamentos.integrador]]===
===[[IN_CadastroLancamentos.integrador|CadastroLancamentos.integrador]]===
==== Cadastrar====
==== Cadastrar====
Método que tem por finalidade cadastrar títulos a pagar e a receber no CIGAM via webservice.</br>
<p align="justify"><b><i>
</br>
Os dados do Lançamento deverão estar em formato XML para requisições SOAP e JSON para
<b>Tipo de registro:</b> <u>LANCAD</u></br>
requisições REST. Ambos com estrutura específica conforme descrito a seguir.</i></b>
<center><table width="850" border="1" cellspacing="0" cellpadding="7" style="font-size:10.0pt;text-align:justify">
</p>
        <tr>
 
<td width="25%" style="background:#d9d9d9;text-align:center"><strong>Par&acirc;metro</strong></td>
*<b>Requisição</b>
<td width="15%" style="background:#d9d9d9;text-align:center"><strong>Tipo</strong></td>
**<b>Soap:</b> http://servidor/CadastroLancamentos.integrador.asmx
  <td width="15%" style="background:#d9d9d9;text-align:center"><strong>M&aacute;scara</strong></td>
**<b>Rest/JSon:</b> http://servidor/CadastroLancamentos.integrador.ashx/metodo
<td width="45%" style="background:#d9d9d9;text-align:center"><strong>Observa&ccedil;&atilde;o</strong></td>
**<b>Tipo de registro:</b> <u>LANCAD</u></br>
        </tr>
 
<tr>
*<b>Distribuição das Tags XML:</b>
<td>&nbsp;&nbsp;&nbsp;*pin</td>
{{#tree:
<td>String</td>
*Method="Cadastrar"
<td>20</td>
**<pin/>                                        
<td>&nbsp;</td>
**<statusRegistro/>
</tr>
***L=Liberado, P=Pendente
<tr>
***Este par&acirc;metro n&atilde;o &eacute; obrigat&oacute;rio, mas se for informado algo diferente de L ou P, por padr&atilde;o,
<td>&nbsp;&nbsp;&nbsp;*statusRegistro</td>
ser&aacute; cadastrado como P na tabela de integra&ccedil;&atilde;o.                         
<td>String</td>
**<codigoLancamento/>                          
<td>1</td>
**<data/>                                      
<td>L=Liberado, P=Pendente
**<dataVencimento/>                            
Este par&acirc;metro n&atilde;o &eacute; obrigat&oacute;rio, mas se for informado algo diferente de L ou P, por padr&atilde;o, ser&aacute; cadastrado como P na tabela de integra&ccedil;&atilde;o.</td>
**<nf/>                                        
</tr>
**<fatura/>                                    
<tr>
**<complemento/>                                
<td>&nbsp;&nbsp;&nbsp;CodigoLancamento</td>
**<codigoHistorico/>
<td>Int</td>
***Se informado, dever&aacute; ser um hist&oacute;rico valido do cadastro de hist&oacute;ricos.                         
<td>10</td>
**<complementoHistorico/>                      
<td>&nbsp;</td>
**<codigoConta/>
</tr>
***Se vier, tem que ser uma conta do cadastro de contas financeiras.                             
<tr>
**<tipo/>                                      
<td>&nbsp;&nbsp;&nbsp;Data</td>
**<valor/>  
<td>Date</td>
***Valor lan&ccedil;amento, n&atilde;o pode ser negativo.                                   
<td>##/##/####</td>
**<codigoEmpresa/>
<td>&nbsp;</td>
***Se informado dever&aacute; ser uma empresa cadastrada.
</tr>
**<codigoCobranca/>
<tr>
***Se informado dever&aacute; ser uma empresa&nbsp; de cobran&ccedil;a cadastrada.                            
<td>&nbsp;&nbsp;&nbsp;dataVencimento</td>
**<cheque/>                                    
<td>Date</td>
**<codigoPortador/>
<td>##/##/####</td>
***Se informado dever&aacute; ser um portador existente do cadastro de portadores.                           
<td>&nbsp;</td>
**<emissao/>                                    
</tr>
**<codigoPartida/>                            
<tr>
**<saldo/>                                      
<td>&nbsp;&nbsp;&nbsp;complemento</td>
**<conferido/>                                  
<td>String</td>
**<situacao/>
<td>&nbsp;</td>
***A=Aberto,
<td>&nbsp;</td>
B=Bonif/Desc/Tarifa,
</tr>
C=Cartorio,
<tr>
D=Devolvido,
<td>&nbsp;&nbsp;&nbsp;codigoHistorico</td>
E=Executado,
<td>string</td>
I=Inadimplente,
<td>3</td>
J=Juros/VM/Multa,
<td>Se informado, dever&aacute; ser um hist&oacute;rico valido do cadastro de hist&oacute;ricos.</td>
L=Liquidado,
</tr>
P=Protestado,
<tr>
U=Unificado,
<td>&nbsp;&nbsp;&nbsp;complementoHistorico</td>
V=Vale/Adiant.,
<td>string</td>
R=Reten&ccedil;&atilde;o,
<td>201</td>
S=Saldo Inicial,
<td>&nbsp;</td>
M=Monet&aacute;rio,
</tr>
T=Transfer&ecirc;ncia
<tr>
**<conciliado/>                                
<td>&nbsp;&nbsp;&nbsp;codigoConta</td>
**<serie/>                                      
<td>string</td>
**<contabilizado/>
<td>6</td>
***Branco=a Contabilizar,
<td>Se vier, tem que ser uma conta do cadastro de contas financeiras.</td>
C=Contabilizado,
</tr>
A=Abertura,
<tr>
N=N&atilde;o Contabilizar                             
<td>&nbsp;&nbsp;&nbsp;codigoTipo</td>
**<tipoPagamento/>
<td> string </td>
***Se informado ser&aacute; verificado a exist&ecirc;ncia no cadastro de tipos de pagamento                           
<td>1</td>
**<numeroBanco/>                                
<td>&nbsp;</td>
**<jurosDia/>                                  
</tr>
**<ultimaLiquidacao/>                          
<tr>
**<codigoUnidadeNegocio/>
<td>&nbsp;&nbsp;&nbsp;*valor</td>
***Se n&atilde;o informado o integrador ir&aacute; buscar da configura&ccedil;&atilde;o 21.                     
<td>float</td>
**<documento/>                                  
<td>11.2</td>
**<tipoDocumento/>
<td>Valor lan&ccedil;amento, n&atilde;o pode ser negativo.</td>
***Branco=Geral,
</tr>
A=Aglutinado,
<tr>
B=BRenegocia&ccedil;&atilde;o,
<td>&nbsp;&nbsp;&nbsp;codigoEmpresa</td>
C=Contrato,
<td>string</td>
D=Devolu&ccedil;&atilde;o,
<td>6</td>
E=Empr&eacute;stFinanciamento,
<td>Se informado dever&aacute; ser uma empresa cadastrada.</td>
F=Folha,
</tr>
I=Incobr&aacute;vel,
<tr>
M=MDiferimento,
<td>&nbsp;&nbsp;&nbsp;codigoCobranca</td>
N=NotaD&eacute;bito,
<td>string</td>
P=Pedido,
<td>6</td>
O=Ordem,
<td>Se informado dever&aacute; ser uma empresa&nbsp; de cobran&ccedil;a cadastrada.</td>
R=Reten&ccedil;&atilde;o,
</tr>
S=SubTribut&aacute;ria,
<tr>
T=Transporte,
<td>&nbsp;&nbsp;&nbsp;cheque</td>
U=Unificado,
<td>&nbsp;</td>
1=1OrdFrete,
<td>&nbsp;</td>
2=2Cr&eacute;dito,
<td>&nbsp;</td>
3=3OrdServi&ccedil;o,
</tr>
4=4Financeira,
<tr>
5=5Embarque,
<td>&nbsp;&nbsp;&nbsp;codigoPortador</td>
6=6Curso,
<td>string</td>
7=7 Evento,
<td>3</td>
8=8 GNRE,
<td>Se informado dever&aacute; ser um portador existente do cadastro de portadores.</td>
9=9 Estorno                           
</tr>
**<valorIndexado/>                              
<tr>
**<saldoIndexado/>                              
<td>&nbsp;&nbsp;&nbsp;emissao</td>
**<toleranciaVencimento/>                      
<td>Date</td>
**<valorMulta/>                                
<td>##/##/####</td>
**<toleranciaMulta/>                          
<td>&nbsp;</td>
**<toleranciaJuros/>                          
</tr>
**<tipoJuros/>
<tr>
***S=Simples,
<td>&nbsp;&nbsp;&nbsp;codigoPartida</td>
C=Composto
<td>int</td>
**<valorDesconto/>                              
<td>8</td>
**<lancamentoVinculado/>                      
<td>int</td>
**<sacadorAvalista/>                            
</tr>
**<modalidadeVencimento/>
<tr>
***Branco=Prazo,
<td>&nbsp;&nbsp;&nbsp;saldo</td>
V=Vista,
<td>float</td>
A=Apresenta&ccedil;&atilde;o,
<td>11.2</td>
E=Entrada
<td>&nbsp;</td>
**<modalidadePagamento/>  
</tr>
***Branco=Exato, A=Anterior, S=Seguinte, P=Previsto                       
<tr>
**<especieDocumento/>                          
<td>&nbsp;&nbsp;&nbsp;situacao</td>
**<vencimentoOriginal/>                        
<td>string</td>
**<projeto/>                                    
<td>1</td>
**<multiploRemessaEnviada/>                    
<td>A=Aberto, B=Bonif/Desc/Tarifa, C=Cartorio,, D=Devolvido, E=Executado, I=Inadimplente, J=Juros/VM/Multa, L=Liquidado, P=Protestado, U=Unificado, V=Vale/Adiant., R=Reten&ccedil;&atilde;o, S=Saldo Inicial, M=Monet&aacute;rio, T=Transfer&ecirc;ncia</td>
**<indice/>                                    
</tr>
**<bloquetoImpresso/>                          
<tr>
**<duplicataImpressa/>                          
<td>&nbsp;&nbsp;&nbsp;serie</td>
**<remessaEnviada/>                            
<td>string</td>
**<autorizadoPor/>                              
<td>5</td>
**<autorizadoEm/>                              
<td>>&nbsp;</td>
**<dataCompensacaoBancaria/>                    
</tr>
**<dataFaturamentoContrato/>                    
<tr>
**<dataValidacao/>                              
<td>&nbsp;&nbsp;&nbsp;contabilizado</td>
**<remessaSerasa/>                              
<td>string</td>
**<adiantarRetornoCobranca/>                    
<td>1</td>
**<formaCobrancaContrato/>                     
<td>Branco=a Contabilizar, C=Contabilizado, A=Abertura, N=N&atilde;o Contabilizar</td>
**<codigoPagamentoGps/>                        
</tr>
**<comandoRemessa/>                            
<tr>
**<ordemEnderecoCobranca/>                      
<td>&nbsp;&nbsp;&nbsp;codigoTipoPagamento</td>
**<tipoMulta/>                                  
<td>string</td>
**<pagamento/>                                  
<td>2</td>
**<listarIss/>
<td>Se informado ser&aacute; verificado a exist&ecirc;ncia no cadastro de tipos de pagamento</td>
***_N=N&atilde;o,
</tr>
Ab=Abertura NF,
<tr>
Si=Sim
<td>&nbsp;&nbsp;&nbsp;jurosDia</td>
**<codigoBarrasLido/>
<td>float</td>
***S_,
<td>8.6</td>
N_
<td>float</td>
**<dataDirf/>                                  
</tr>
**<codigoCaixa/>                                
<tr>
**<turnoSequencial/>                            
<td>&nbsp;&nbsp;&nbsp;codigoUnidadeNegocio</td>
**<ordemContaCorrente/>                        
<td>string</td>
**<previsao/>                                  
<td>3</td>
**<listarDirf/>                                
<td>Se n&atilde;o informado o integrador ir&aacute; buscar da configura&ccedil;&atilde;o 21.</td>
**<possuiChequesTitulos/>                      
</tr>
**<ctrSequencia/>                              
<tr>
**<limiteMultaFracionada/>                      
<td>&nbsp;&nbsp;&nbsp;documento</td>
**<valorCustoAdministrativo/>                  
<td>string</td>
**<conciliacaoSequencia/>                      
<td>12</td>
**<percentualIss/>                              
<td>&nbsp;</td>
**<sessaoCaixa/>                                
</tr>
**<autorizadoPlacaGnre/>                        
<tr>
**<usrlanc1/>                                  
<td>&nbsp;&nbsp;&nbsp;tipoDocumento</td>
**<usrlanc2/>                                  
<td>string</td>
**<usrlanc3/>                                  
<td>1</td>
**<tipoResposta/>                              
<td>Branco=Geral, A=Aglutinado, B=BRenegocia&ccedil;&atilde;o, C=Contrato, D=Devolu&ccedil;&atilde;o, E=Empr&eacute;stFinanciamento, F=Folha, I=Incobr&aacute;vel, M=MDiferimento, N=NotaD&eacute;bito, P=Pedido, O=Ordem, R=Reten&ccedil;&atilde;o, S=SubTribut&aacute;ria, T=Transporte, U=Unificado, 1=1OrdFrete, 2=2Cr&eacute;dito, 3=3OrdServi&ccedil;o, 4=4Financeira, 5=5Embarque, 6=6Curso, 7=7 Evento, 8=8 GNRE, 9=9 Estorno</td>
**<lancamentoTerceiro/>
</tr>
*<p align="justify" style=""font-size:8.5pt">&nbsp;&nbsp;&nbsp;<b>(*)</b> Campo obrigatório</td>
<tr>
 
<td>&nbsp;&nbsp;&nbsp;tipoJuros</td>
 
<td>string</td>
<td>1</td>
<td>S=Simples, C=Composto</td>
</tr>
<tr>
<td>&nbsp;&nbsp;&nbsp;lancamentoVinculado</td>
<td>int</td>
<td>8</td>
<td>&nbsp;</td>
</tr>
<tr>
<td>&nbsp;&nbsp;&nbsp;modalidadeVencimento</td>
<td>string</td>
<td>1</td>
<td>Branco=Prazo, V=Vista, A=Apresenta&ccedil;&atilde;o, E=Entrada</td>
</tr>
<tr>
<td>&nbsp;&nbsp;&nbsp;modalidadePagamento</td>
<td>string</td>
<td>1</td>
<td>Branco=Exato, A=Anterior, S=Seguinte, P=Previsto</td>
</tr>
<tr>
<td>&nbsp;&nbsp;&nbsp;vencimentoOriginal</td>
<td>date</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
<tr>
<td>&nbsp;&nbsp;&nbsp;projeto</td>
<td>string</td>
<td>12</td>
<td>&nbsp;</td>
</tr>
<tr>
<td>&nbsp;&nbsp;&nbsp;listarIss</td>
<td>string</td>
<td>2</td>
<td>_N=N&atilde;o, Ab=Abertura NF, Si=Sim</td>
</tr>
<tr>
<td>&nbsp;&nbsp;&nbsp;codigoBarrasLido</td>
<td>string</td>
<td>2</td>
<td>S_, N_</td>
</tr>
<tr>
<td>&nbsp;&nbsp;&nbsp;codigoCaixa</td>
<td>string</td>
<td>3</td>
<td>&nbsp;</td>
</tr>
<tr>
<td>&nbsp;&nbsp;&nbsp;turnoSequencial</td>
<td>string</td>
<td>3</td>
<td>&nbsp;</td>
</tr>
<tr>
<td>&nbsp;&nbsp;&nbsp;previsao</td>
<td>bool</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
</tr>
<tr>
<td>&nbsp;&nbsp;&nbsp;ctrSequencia</td>
<td>float</td>
<td>8.6</td>
<td>&nbsp;</td>
</tr>
<tr>
<td>&nbsp;&nbsp;&nbsp;sessaoCaixa</td>
<td>string</td>
<td>>&nbsp;</td>
<td>&nbsp;</td>
</tr>
</table></center>
<center><table width="850" border="0" cellspacing="0" cellpadding="7" style="font-size:8.5pt">
    <tr>
        <td colspan=4 valign=top'>&nbsp;&nbsp;&nbsp;<b>(*)</b> Campo obrigatório</td>
    </tr>
</table></center>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<b>Retornos:</b><br/>
<b>Retornos:</b><br/>
Linha 267: Linha 185:
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;idRegistro: 00</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;idRegistro: 00</br>
</p>
</p>
==== CadastrarValeAdiantamento ====
==== CadastrarValeAdiantamento ====
==== ListarId ====
==== ListarId ====

Edição das 19h24min de 29 de outubro de 2020

Cadastrar

Os dados do Lançamento deverão estar em formato XML para requisições SOAP e JSON para requisições REST. Ambos com estrutura específica conforme descrito a seguir.

  • Distribuição das Tags XML:

{{#tree:

  • Method="Cadastrar"
    • <pin/>
    • <statusRegistro/>
      • L=Liberado, P=Pendente
      • Este parâmetro não é obrigatório, mas se for informado algo diferente de L ou P, por padrão,

será cadastrado como P na tabela de integração.

    • <codigoLancamento/>
    • <dataVencimento/>
    • <nf/>
    • <fatura/>
    • <complemento/>
    • <codigoHistorico/>
      • Se informado, deverá ser um histórico valido do cadastro de históricos.
    • <complementoHistorico/>
    • <codigoConta/>
      • Se vier, tem que ser uma conta do cadastro de contas financeiras.
    • <tipo/>
    • <valor/>
      • Valor lançamento, não pode ser negativo.
    • <codigoEmpresa/>
      • Se informado deverá ser uma empresa cadastrada.
    • <codigoCobranca/>
      • Se informado deverá ser uma empresa  de cobrança cadastrada.
    • <cheque/>
    • <codigoPortador/>
      • Se informado deverá ser um portador existente do cadastro de portadores.
    • <emissao/>
    • <codigoPartida/>
    • <saldo/>
    • <conferido/>
    • <situacao/>
      • A=Aberto,

B=Bonif/Desc/Tarifa, C=Cartorio, D=Devolvido, E=Executado, I=Inadimplente, J=Juros/VM/Multa, L=Liquidado, P=Protestado, U=Unificado, V=Vale/Adiant., R=Retenção, S=Saldo Inicial, M=Monetário, T=Transferência

    • <conciliado/>
    • <serie/>
    • <contabilizado/>
      • Branco=a Contabilizar,

C=Contabilizado, A=Abertura, N=Não Contabilizar

    • <tipoPagamento/>
      • Se informado será verificado a existência no cadastro de tipos de pagamento
    • <numeroBanco/>
    • <jurosDia/>
    • <ultimaLiquidacao/>
    • <codigoUnidadeNegocio/>
      • Se não informado o integrador irá buscar da configuração 21.
    • <documento/>
    • <tipoDocumento/>
      • Branco=Geral,

A=Aglutinado, B=BRenegociação, C=Contrato, D=Devolução, E=EmpréstFinanciamento, F=Folha, I=Incobrável, M=MDiferimento, N=NotaDébito, P=Pedido, O=Ordem, R=Retenção, S=SubTributária, T=Transporte, U=Unificado, 1=1OrdFrete, 2=2Crédito, 3=3OrdServiço, 4=4Financeira, 5=5Embarque, 6=6Curso, 7=7 Evento, 8=8 GNRE, 9=9 Estorno

    • <valorIndexado/>
    • <saldoIndexado/>
    • <toleranciaVencimento/>
    • <valorMulta/>
    • <toleranciaMulta/>
    • <toleranciaJuros/>
    • <tipoJuros/>
      • S=Simples,

C=Composto

    • <valorDesconto/>
    • <lancamentoVinculado/>
    • <sacadorAvalista/>
    • <modalidadeVencimento/>
      • Branco=Prazo,

V=Vista, A=Apresentação, E=Entrada

    • <modalidadePagamento/>
      • Branco=Exato, A=Anterior, S=Seguinte, P=Previsto
    • <especieDocumento/>
    • <vencimentoOriginal/>
    • <projeto/>
    • <multiploRemessaEnviada/>
    • <indice/>
    • <bloquetoImpresso/>
    • <duplicataImpressa/>
    • <remessaEnviada/>
    • <autorizadoPor/>
    • <autorizadoEm/>
    • <dataCompensacaoBancaria/>
    • <dataFaturamentoContrato/>
    • <dataValidacao/>
    • <remessaSerasa/>
    • <adiantarRetornoCobranca/>
    • <formaCobrancaContrato/>
    • <codigoPagamentoGps/>
    • <comandoRemessa/>
    • <ordemEnderecoCobranca/>
    • <tipoMulta/>
    • <pagamento/>
    • <listarIss/>
      • _N=Não,

Ab=Abertura NF, Si=Sim

    • <codigoBarrasLido/>
      • S_,

N_

    • <dataDirf/>
    • <codigoCaixa/>
    • <turnoSequencial/>
    • <ordemContaCorrente/>
    • <previsao/>
    • <listarDirf/>
    • <possuiChequesTitulos/>
    • <ctrSequencia/>
    • <limiteMultaFracionada/>
    • <valorCustoAdministrativo/>
    • <conciliacaoSequencia/>
    • <percentualIss/>
    • <sessaoCaixa/>
    • <autorizadoPlacaGnre/>
    • <usrlanc1/>
    • <usrlanc2/>
    • <usrlanc3/>
    • <tipoResposta/>
    • <lancamentoTerceiro/>
  •    (*) Campo obrigatório



Retornos:
   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se registro válido:
      Inserção efetuada com sucesso
         idRegistro: 00

CadastrarValeAdiantamento

ListarId

ListarPendentes

ListarModificacoes

ListarIndividual

ListarLancamentos

ListarLancamentosTerceiro

LiberarPendentes

Excluir

LiquidarLancamentoNotaFiscal

Método que tem por finalidade liquidar títulos de Notas Fiscais no ERP CIGAM.

Tipo de registro: LIQLNF
Parâmetros:

 • pin: Obrigatório, Tipo: String
 • nf: Obrigatório, Tipo: numerico 10
 • serie: Obrigatório, Tipo: Alpha 6A
 • codigoUnidadeNegocio:Obrigatório, Tipo: Alpha 3A
 • codigoUnidadeNegocioLiquidacao: Tipo: Alpha 3A
 • codigoEmpresa: Tipo: Alpha 6A
 • complemento: Tipo: Alpha 6A
 • valorLiquidar: Obrigatório, Tipo: Numeric 12.6
 • forcarJurosMultaDesconto: Tipo: boolean (True, False)
 • juros: Tipo: Numeric 12.6
 • valorMulta: Tipo: Numeric 12.6
 • valorDesconto: Tipo: Numeric 12.6
 • dataLiquidacao: Tipo: Date ##/##/##
 • portadorLiquidacao: Tipo: Alpha 3A
 • historicoLiquidacao: Tipo: Alpha 3A

Exemplo de Retorno:
   Se registro válido:
      Inserção efetuada com sucesso
         idRegistro: 00

   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.