Cadastrar
Os dados do Lançamento deverão estar em formato XML para requisições SOAP e JSON para
requisições REST.
- Parâmetros:
- 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
- data
- Deve ser informada data de criação
- dataVencimento
- Deve ser informada data de vencimento do título
- 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
- Tipo lançamento, não pode ser branco, deve ser informado R: Receber/c: Recebido, P: Pagar/d: Pago, E: Entrada ou S: Saída.
- valor
- Valor lançamento, não pode ser negativo, nem zero.
- codigoEmpresa
- Deve ser informado e deverá ser uma empresa cadastrada.
- codigoCobranca
- Deve ser informado e 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
- 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
- dataDirf
- codigoCaixa
- turnoSequencial
- ordemContaCorrente
- previsao
- listarDirf
- possuiChequesTitulos
- ctrSequencia
- limiteMultaFracionada
- valorCustoAdministrativo
- conciliacaoSequencia
- percentualIss
- sessaoCaixa
- autorizadoPlacaGnre
- usrlanc1
- usrlanc2
- usrlanc3
- tipoResposta
- lancamentoTerceiro
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
{"minExpandLevel":2}
- Parâmetros:
- pin
- statusRegistro
- codigoLancamento
- data
- codigoHistorico
- complementoHistorico
- codigoConta
- valor
- codigoEmpresa
- codigoPortador
- codigoTipoPagamento
- codigoUnidadeNegocio
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
ListarId
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
Retorno:
Se sucesso:
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.
ListarPendentes
{"minExpandLevel":2}
- Parâmetros:
- pin
- acao
- C: Cadastrar, E: Excluir
- Se for informado algo diferente de C ou E não será aplicado nenhum filtro
- statusRegistro
- L: Liberado,P: Pendente
- Se for informado algo diferente de P ou L não será aplicado nenhum filtro.
{"minExpandLevel":2}
- Retorno:
- idRegistro
- acao
- statusRegistro
- dataRequisicao
- horaRequisicao
- idCorrelato
- codigoLancamento
- data
- dataVencimento
- tipo
- valor
ListarModificacoes
{"minExpandLevel":2}
- Parâmetros:
- pin
- dataInicial
- horaInicial
- dataFinal
- horaFinal
- Retorno:
- codigoLancamento
- data
- dataVencimento
- nf
- fatura
- complemento
- codigoHistorico
- complementoHistorico
- codigoConta
- codigoTipo
- valor
- codigoEmpresa
- codigoCobranca
- cheque
- codigoPortador
- emissao
- codigoPartida
- saldo
- conferido
- situacao
- conciliado
- serie
- contabilizado
- codigoUsuarioModificacao
- codigoTipoPagamento
- numeroBanco
- jurosDia
- ultimaLiquidacao
- codigoUnidadeNegocio
- documento
- tipoDocumento
- valorIndexado
- saldoIndexado
- toleranciaVencimento
- valorMulta
- toleranciaMulta
- toleranciaJuros
- tipoJuros
- valorDesconto
- lancamentoVinculado
- dataInclusao
- sacadorAvalista
- modalidadeVencimento
- modalidadePagamento
- especieDocumento
- vencimentoOriginal
- projeto
- multiploRemessaEnviada
- indice
- bloquetoImpresso
- duplicataImpressa
- remessaEnviada
- autorizadoPor
- autorizadoEm
- dataModificacao
- codigoUsuarioCriacao
- sessao
- dataCompensacaoBancaria
- dataFaturamentoContrato
- dataValidacao
- remessaSerasa
- adiantarRetornoCobranca
- formaCobrancaContrato
- codigoPagamentoGps
- comandoRemessa
- ordemEnderecoCobranca
- tipoMulta
- pagamento
- listarIss
- codigoBarrasLido
- dataDirf
- codigoCaixa
- turnoSequencial
- ordemContaCorrente
- previsao
- listarDirf
- possuiChequesTitulos
- ctrSequencia
- limiteMultaFracionada
- valorCustoAdministrativo
- conciliacaoSequencia
- percentualIss
- sessaoCaixa
- autorizadoPlacaGnre
- horaCriacao
- usrlanc1
- usrlanc2
- usrlanc3
ListarIndividual
- Retorno:
- codigoLancamento
- data
- dataVencimento
- nf
- fatura
- complemento
- codigoHistorico
- complementoHistorico
- codigoConta
- codigoTipo
- valor
- codigoEmpresa
- codigoCobranca
- cheque
- codigoPortador
- emissao
- codigoPartida
- saldo
- conferido
- situacao
- conciliado
- serie
- contabilizado
- codigoUsuarioModificacao
- codigoTipoPagamento
- numeroBanco
- jurosDia
- ultimaLiquidacao
- codigoUnidadeNegocio
- documento
- tipoDocumento
- valorIndexado
- saldoIndexado
- toleranciaVencimento
- valorMulta
- toleranciaMulta
- toleranciaJuros
- tipoJuros
- valorDesconto
- lancamentoVinculado
- dataInclusao
- sacadorAvalista
- modalidadeVencimento
- modalidadePagamento
- especieDocumento
- vencimentoOriginal
- projeto
- multiploRemessaEnviada
- indice
- bloquetoImpresso
- duplicataImpressa
- remessaEnviada
- autorizadoPor
- autorizadoEm
- dataModificacao
- codigoUsuarioCriacao
- sessao
- dataCompensacaoBancaria
- dataFaturamentoContrato
- dataValidacao
- remessaSerasa
- adiantarRetornoCobranca
- formaCobrancaContrato
- codigoPagamentoGps
- comandoRemessa
- ordemEnderecoCobranca
- tipoMulta
- pagamento
- listarIss
- codigoBarrasLido
- dataDirf
- codigoCaixa
- turnoSequencial
- ordemContaCorrente
- previsao
- listarDirf
- possuiChequesTitulos
- ctrSequencia
- limiteMultaFracionada
- valorCustoAdministrativo
- conciliacaoSequencia
- percentualIss
- sessaoCaixa
- autorizadoPlacaGnre
- horaCriacao
- usrlanc1
- usrlanc2
- usrlanc3
ListarLancamentos
{"minExpandLevel":2}
- Parâmetros:
- pin
- codigoLancamento
- nf
- serie
- codigoUnidadeNegocio
- codigoTipo
- situacao
- Retorno:
- codigoLancamento
- data
- dataVencimento
- nf
- fatura
- complemento
- codigoHistorico
- complementoHistorico
- codigoConta
- codigoTipo
- valor
- codigoEmpresa
- codigoCobranca
- cheque
- codigoPortador
- emissao
- codigoPartida
- saldo
- conferido
- situacao
- conciliado
- serie
- contabilizado
- codigoUsuarioModificacao
- codigoTipoPagamento
- numeroBanco
- jurosDia
- ultimaLiquidacao
- codigoUnidadeNegocio
- documento
- tipoDocumento
- valorIndexado
- saldoIndexado
- toleranciaVencimento
- valorMulta
- toleranciaMulta
- toleranciaJuros
- tipoJuros
- valorDesconto
- lancamentoVinculado
- dataInclusao
- sacadorAvalista
- modalidadeVencimento
- modalidadePagamento
- especieDocumento
- vencimentoOriginal
- projeto
- multiploRemessaEnviada
- indice
- bloquetoImpresso
- duplicataImpressa
- remessaEnviada
- autorizadoPor
- autorizadoEm
- dataModificacao
- codigoUsuarioCriacao
- sessao
- dataCompensacaoBancaria
- dataFaturamentoContrato
- dataValidacao
- remessaSerasa
- adiantarRetornoCobranca
- formaCobrancaContrato
- codigoPagamentoGps
- comandoRemessa
- ordemEnderecoCobranca
- tipoMulta
- pagamento
- listarIss
- codigoBarrasLido
- dataDirf
- codigoCaixa
- turnoSequencial
- ordemContaCorrente
- previsao
- listarDirf
- possuiChequesTitulos
- ctrSequencia
- limiteMultaFracionada
- valorCustoAdministrativo
- conciliacaoSequencia
- percentualIss
- sessaoCaixa
- autorizadoPlacaGnre
- horaCriacao
- usrlanc1
- usrlanc2
- usrlanc3
ListarLancamentosVencimento
{"minExpandLevel":2}
- Parâmetros:
- pin
- codigoLancamento
- nf
- serie
- codigoUnidadeNegocio
- codigoTipo
- situacao
- codigoEmpresa
- vencimentoInicial
- vencimentoFinal
- Retorno:
- codigoLancamento
- data
- dataVencimento
- nf
- fatura
- complemento
- codigoHistorico
- complementoHistorico
- codigoConta
- codigoTipo
- valor
- codigoEmpresa
- codigoCobranca
- cheque
- codigoPortador
- emissao
- codigoPartida
- saldo
- conferido
- situacao
- conciliado
- serie
- contabilizado
- codigoUsuarioModificacao
- codigoTipoPagamento
- numeroBanco
- jurosDia
- ultimaLiquidacao
- codigoUnidadeNegocio
- documento
- tipoDocumento
- valorIndexado
- saldoIndexado
- toleranciaVencimento
- valorMulta
- toleranciaMulta
- toleranciaJuros
- tipoJuros
- valorDesconto
- lancamentoVinculado
- dataInclusao
- sacadorAvalista
- modalidadeVencimento
- modalidadePagamento
- especieDocumento
- vencimentoOriginal
- projeto
- multiploRemessaEnviada
- indice
- bloquetoImpresso
- duplicataImpressa
- remessaEnviada
- autorizadoPor
- autorizadoEm
- dataModificacao
- codigoUsuarioCriacao
- sessao
- dataCompensacaoBancaria
- dataFaturamentoContrato
- dataValidacao
- remessaSerasa
- adiantarRetornoCobranca
- formaCobrancaContrato
- codigoPagamentoGps
- comandoRemessa
- ordemEnderecoCobranca
- tipoMulta
- pagamento
- listarIss
- codigoBarrasLido
- dataDirf
- codigoCaixa
- turnoSequencial
- ordemContaCorrente
- previsao
- listarDirf
- possuiChequesTitulos
- ctrSequencia
- limiteMultaFracionada
- valorCustoAdministrativo
- conciliacaoSequencia
- percentualIss
- sessaoCaixa
- autorizadoPlacaGnre
- horaCriacao
- usrlanc1
- usrlanc2
- usrlanc3
ListarLancamentosTerceiro
LiberarPendentes
ExcluirValeAdiantamento
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- codigoLancamento
- Obrigatório, Tipo: String 8
Retorno:
Se sucesso:
idRegistro - ID que representa este registro na tabela de integração.
Se pin inválido:
O usuário não possui direitos suficientes para executar esta rotina.
LiquidarLancamentoNotaFiscal
Método que tem por finalidade liquidar títulos de Notas Fiscais no ERP CIGAM.
Tipo de registro: LIQLNF
{"minExpandLevel":2}
- Parâmetros
- pin
- nf
- serie
- codigoUnidadeNegocio
- codigoUnidadeNegocioLiquidacao
- codigoEmpresa
- complemento
- valorLiquidar
- forcarJurosMultaDesconto
- juros
- valorMulta
- valorDesconto
- dataLiquidacao
- portadorLiquidacao
- historicoLiquidacao
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.
