IN Faturamento: mudanças entre as edições
De CIGAM WIKI
| Linha 507: | Linha 507: | ||
***** <sequenciaNfItemReferencia/> | ***** <sequenciaNfItemReferencia/> | ||
***** <tipoOperacaoItemReferencia/> | ***** <tipoOperacaoItemReferencia/> | ||
**** </itensNf> | ***** </itensNf> | ||
*** </itemNf> | **** </itemNf> | ||
*** <comissaoNf> | **** <comissaoNf> | ||
**** <comissoesNf> | ***** <comissoesNf> | ||
***** <nf/> | ****** <nf/> | ||
***** <serie/> | ****** <serie/> | ||
***** <unidadeDeNegocio/> | ****** <unidadeDeNegocio/> | ||
***** <clienteFornecedor/> | ****** <clienteFornecedor/> | ||
***** <especieNF/> | ****** <especieNF/> | ||
***** <sequenciaNF/> | ****** <sequenciaNF/> | ||
***** <representante/> | ****** <representante/> | ||
***** <valorBaseComissao/> | ****** <valorBaseComissao/> | ||
***** <percentualComissao/> | ****** <percentualComissao/> | ||
***** <tipoBaseComissao/> | ****** <tipoBaseComissao/> | ||
***** <percComissaoOrigRepresentante/> | ****** <percComissaoOrigRepresentante/> | ||
***** <percentualReducaoBaseComissao/> | ****** <percentualReducaoBaseComissao/> | ||
***** <lancamentoComissao/> | ****** <lancamentoComissao/> | ||
***** <origem/> | ****** <origem/> | ||
**** | ***** </comissoesNf> | ||
*** | **** </comissaoNf> | ||
*** <parcelaNf> | **** <parcelaNf> | ||
**** <parcelasNf> | ***** <parcelasNf> | ||
***** <nf/> | ****** <nf/> | ||
***** <serie/> | ****** <serie/> | ||
***** <unidadeNegocio/> | ****** <unidadeNegocio/> | ||
***** <vencimento/> | ****** <vencimento/> | ||
***** <valorParcela/> | ****** <valorParcela/> | ||
***** <nossoNumero/> | ****** <nossoNumero/> | ||
***** <codigoCaixa/> | ****** <codigoCaixa/> | ||
***** <turnoSequencial/> | ****** <turnoSequencial/> | ||
***** <sessaoCaixa/> | ****** <sessaoCaixa/> | ||
***** <modeloLancamento/> | ****** <modeloLancamento/> | ||
**** </parcelasNf> | ***** </parcelasNf> | ||
*** </parcelaNf> | **** </parcelaNf> | ||
*** <lancamentoNf> | **** <lancamentoNf> | ||
**** <lancamentosNf> | ***** <lancamentosNf> | ||
***** <lancamento/> | ****** <lancamento/> | ||
***** <data/> | ****** <data/> | ||
***** <vencimento/> | ****** <vencimento/> | ||
***** <fatura/> | ****** <fatura/> | ||
***** <complemento/> | ****** <complemento/> | ||
***** <codHistorico/> | ****** <codHistorico/> | ||
***** <historico/> | ****** <historico/> | ||
***** <conta/> | ****** <conta/> | ||
***** <tipo/> | ****** <tipo/> | ||
***** <valor/> | ****** <valor/> | ||
***** <cdEmpresa/> | ****** <cdEmpresa/> | ||
***** <cdCobranca/> | ****** <cdCobranca/> | ||
***** <cheque/> | ****** <cheque/> | ||
***** <cdPortador/> | ****** <cdPortador/> | ||
***** <emissao/> | ****** <emissao/> | ||
***** <cPartida/> | ****** <cPartida/> | ||
***** <saldo/> | ****** <saldo/> | ||
***** <conferido/> | ****** <conferido/> | ||
***** <situacao/> | ****** <situacao/> | ||
***** <conciliado/> | ****** <conciliado/> | ||
***** <contabilizado/> | ****** <contabilizado/> | ||
***** <tipoPagamento/> | ****** <tipoPagamento/> | ||
***** <numeroBanco/> | ****** <numeroBanco/> | ||
***** <jurosDia/> | ****** <jurosDia/> | ||
***** <ultimaLiquidacao/> | ****** <ultimaLiquidacao/> | ||
***** <documento/> | ****** <documento/> | ||
***** <tipoDocumento/> | ****** <tipoDocumento/> | ||
***** <valorIndexado/> | ****** <valorIndexado/> | ||
***** <saldoIndexado/> | ****** <saldoIndexado/> | ||
***** <toleranciaVenc/> | ****** <toleranciaVenc/> | ||
***** <valorMulta/> | ****** <valorMulta/> | ||
***** <toleranciaMulta/> | ****** <toleranciaMulta/> | ||
***** <toleranciaJuros/> | ****** <toleranciaJuros/> | ||
***** <tipoJuros/> | ****** <tipoJuros/> | ||
***** <valorDesconto/> | ****** <valorDesconto/> | ||
***** <lancVinculado/> | ****** <lancVinculado/> | ||
***** <dataInclusao/> | ****** <dataInclusao/> | ||
***** <sacadorAvalista/> | ****** <sacadorAvalista/> | ||
***** <modalidadeVenc/> | ****** <modalidadeVenc/> | ||
***** <modalidadePag/> | ****** <modalidadePag/> | ||
***** <especieDoc/> | ****** <especieDoc/> | ||
***** <vencOriginal/> | ****** <vencOriginal/> | ||
***** <projeto/> | ****** <projeto/> | ||
***** <multRemessaEnviada/> | ****** <multRemessaEnviada/> | ||
***** <indice/> | ****** <indice/> | ||
***** <bloqImpresso/> | ****** <bloqImpresso/> | ||
***** <duplImpresso/> | ****** <duplImpresso/> | ||
***** <remessaEnviada/> | ****** <remessaEnviada/> | ||
***** <autorizadoPor/> | ****** <autorizadoPor/> | ||
***** <autorizadoEm/> | ****** <autorizadoEm/> | ||
***** <dataModif/> | ****** <dataModif/> | ||
***** <sessao/> | ****** <sessao/> | ||
***** <dataCompensBco/> | ****** <dataCompensBco/> | ||
***** <dataFaturamentoCtr/> | ****** <dataFaturamentoCtr/> | ||
***** <dataValidacao/> | ****** <dataValidacao/> | ||
***** <remessaSerasa/> | ****** <remessaSerasa/> | ||
***** <adiantRetornCobran/> | ****** <adiantRetornCobran/> | ||
***** <formaCobranCtr/> | ****** <formaCobranCtr/> | ||
***** <comandoRemessa/> | ****** <comandoRemessa/> | ||
***** <ordemEnderCobran/> | ****** <ordemEnderCobran/> | ||
***** <tipoMulta/> | ****** <tipoMulta/> | ||
***** <pagamento/> | ****** <pagamento/> | ||
***** <listarIss/> | ****** <listarIss/> | ||
***** <codigoBarrasLido/> | ****** <codigoBarrasLido/> | ||
***** <dataDirf/> | ****** <dataDirf/> | ||
***** <cdCaixa/> | ****** <cdCaixa/> | ||
***** <turnoSequencial/> | ****** <turnoSequencial/> | ||
***** <ordemContaCorrente/> | ****** <ordemContaCorrente/> | ||
***** <previsao/> | ****** <previsao/> | ||
***** <listarDirf/> | ****** <listarDirf/> | ||
***** <possuiChequesTitulo/> | ****** <possuiChequesTitulo/> | ||
***** <ctrSequencia/> | ****** <ctrSequencia/> | ||
***** <limitMultaFracio/> | ****** <limitMultaFracio/> | ||
***** <valorCustoAdmin/> | ****** <valorCustoAdmin/> | ||
***** <conciliacaoSeq/> | ****** <conciliacaoSeq/> | ||
***** <percentIss/> | ****** <percentIss/> | ||
***** <sessaoCaixa/> | ****** <sessaoCaixa/> | ||
***** <autoriPlacaGnre/> | ****** <autoriPlacaGnre/> | ||
***** <userLancto1/> | ****** <userLancto1/> | ||
***** <userLancto2/> | ****** <userLancto2/> | ||
***** <userLancto3/> | ****** <userLancto3/> | ||
***** <cheques> | ****** <cheques> | ||
****** <cheque> | ******* <cheque> | ||
******* <numero/> | ******** <numero/> | ||
******* <sequencia/> | ******** <sequencia/> | ||
******* <lancamentoVinculado/> | ******** <lancamentoVinculado/> | ||
******* <lancamentoOrigPartRel/> | ******** <lancamentoOrigPartRel/> | ||
******* <lancamentoTrocaCheque/> | ******** <lancamentoTrocaCheque/> | ||
******* <vinculadoDadosPreenchido/> | ******** <vinculadoDadosPreenchido/> | ||
******* <conta/> | ******** <conta/> | ||
******* <titulo/> | ******** <titulo/> | ||
******* <cpfCnpj/> | ******** <cpfCnpj/> | ||
******* <fone/> | ******** <fone/> | ||
******* <usrinchelan1/> | ******** <usrinchelan1/> | ||
******* <banco/> | ******** <banco/> | ||
******* <agencia/> | ******** <agencia/> | ||
******* <codigoSacado/> | ******** <codigoSacado/> | ||
******* <modeloLancamento/> | ******** <modeloLancamento/> | ||
******* <vinculadoContaFinancei/> | ******** <vinculadoContaFinancei/> | ||
******* <vinculadoOcorrencia/> | ******** <vinculadoOcorrencia/> | ||
******* <div1div2div3/> | ******** <div1div2div3/> | ||
******* <digitoVerificador/> | ******** <digitoVerificador/> | ||
******* <tipoPagamento/> | ******** <tipoPagamento/> | ||
******* <vinculadoTipoPagamento/> | ******** <vinculadoTipoPagamento/> | ||
******* <vinculadoPortador/> | ******** <vinculadoPortador/> | ||
******* <camaraCompensacao/> | ******** <camaraCompensacao/> | ||
******* <vinculadoHistorico/> | ******** <vinculadoHistorico/> | ||
******* <complementoNome1/> | ******** <complementoNome1/> | ||
******* <complementoNome2/> | ******** <complementoNome2/> | ||
******* <nome/> | ******** <nome/> | ||
******* <valor/> | ******** <valor/> | ||
******* <lancamentoDevolucao/> | ******** <lancamentoDevolucao/> | ||
******* <partesRelSaida/> | ******** <partesRelSaida/> | ||
******* <remessaCustodiaEnviada/> | ******** <remessaCustodiaEnviada/> | ||
******* <usrinchelan3/> | ******** <usrinchelan3/> | ||
******* <emissao/> | ******** <emissao/> | ||
******* <vencimento/> | ******** <vencimento/> | ||
******* <devolucao/> | ******** <devolucao/> | ||
******* <dataValidacao/> | ******** <dataValidacao/> | ||
******* <usrinchelan2/> | ******** <usrinchelan2/> | ||
****** </cheque> | ******* </cheque> | ||
***** </cheques> | ****** </cheques> | ||
***** <lancamentoTerceiro/> | ****** <lancamentoTerceiro/> | ||
***** <nsuAutenticacaoBancaria/> | ****** <nsuAutenticacaoBancaria/> | ||
***** <autorizacaoCartao/> | ****** <autorizacaoCartao/> | ||
**** </lancamentosNf> | ***** </lancamentosNf> | ||
*** </lancamentoNf> | **** </lancamentoNf> | ||
*** <formaPagamentoNf> | **** <formaPagamentoNf> | ||
**** <formasPagamentoNf> | ***** <formasPagamentoNf> | ||
***** <pagamentoTroco/> | ****** <pagamentoTroco/> | ||
***** <sequencia/> | ****** <sequencia/> | ||
***** <condPagamento/> | ****** <condPagamento/> | ||
***** <formaCondicao/> | ****** <formaCondicao/> | ||
***** <tipoPagamento/> | ****** <tipoPagamento/> | ||
***** <formaPagamento/> | ****** <formaPagamento/> | ||
***** <empresa/> | ****** <empresa/> | ||
***** <cobranca/> | ****** <cobranca/> | ||
***** <ordemEndCobran/> | ****** <ordemEndCobran/> | ||
***** <tipoDocumento/> | ****** <tipoDocumento/> | ||
***** <documento/> | ****** <documento/> | ||
***** <primeiroVenctoSemAjuste/> | ****** <primeiroVenctoSemAjuste/> | ||
***** <fatura/> | ****** <fatura/> | ||
***** <valorBruto/> | ****** <valorBruto/> | ||
***** <vlrMercadFaturadas/> | ****** <vlrMercadFaturadas/> | ||
***** <vlrServFaturados/> | ****** <vlrServFaturados/> | ||
***** <vlrDescItensFaturados/> | ****** <vlrDescItensFaturados/> | ||
***** <vlrIpi/> | ****** <vlrIpi/> | ||
***** <vlrIcms/> | ****** <vlrIcms/> | ||
***** <vlrSubsTribut/> | ****** <vlrSubsTribut/> | ||
***** <valorIrrf/> | ****** <valorIrrf/> | ||
***** <vlrOutrosImpSomamFatu/> | ****** <vlrOutrosImpSomamFatu/> | ||
***** <vlrOutrosImpDiminueFa/> | ****** <vlrOutrosImpDiminueFa/> | ||
***** <vlrFrete/> | ****** <vlrFrete/> | ||
***** <vlrSeguro/> | ****** <vlrSeguro/> | ||
***** <vlrDescGeral/> | ****** <vlrDescGeral/> | ||
***** <percDescAteVencto/> | ****** <percDescAteVencto/> | ||
***** <vlrEncarFinanc/> | ****** <vlrEncarFinanc/> | ||
***** <tipoPagEntrada/> | ****** <tipoPagEntrada/> | ||
***** <formaDePagEntrada/> | ****** <formaDePagEntrada/> | ||
***** <empresaEntrada/> | ****** <empresaEntrada/> | ||
***** <cobrancaEntrada/> | ****** <cobrancaEntrada/> | ||
***** <ordemEndCobraEnt/> | ****** <ordemEndCobraEnt/> | ||
***** <tipoDocEntrada/> | ****** <tipoDocEntrada/> | ||
***** <docEntrada/> | ****** <docEntrada/> | ||
***** <vlrEntrada/> | ****** <vlrEntrada/> | ||
***** <vlrJuros/> | ****** <vlrJuros/> | ||
***** <vlrOutrasDespAcess/> | ****** <vlrOutrasDespAcess/> | ||
***** <vlrLiquido/> | ****** <vlrLiquido/> | ||
***** <VlrTarifCartao/> | ****** <VlrTarifCartao/> | ||
***** <prazoMedio/> | ****** <prazoMedio/> | ||
***** <LanctoCompetenciaVal/> | ****** <LanctoCompetenciaVal/> | ||
***** <usuCriacao/> | ****** <usuCriacao/> | ||
***** <dtCriacao/> | ****** <dtCriacao/> | ||
***** <hrCriacao/> | ****** <hrCriacao/> | ||
***** <usuModif/> | ****** <usuModif/> | ||
***** <dtModif/> | ****** <dtModif/> | ||
***** <hrModif/> | ****** <hrModif/> | ||
***** <gerouFinanc/> | ****** <gerouFinanc/> | ||
***** <moduloOrig/> | ****** <moduloOrig/> | ||
***** <vlrLancamento/> | ****** <vlrLancamento/> | ||
**** | ***** </formaPagamentoNf> | ||
*** </formaPagamentoNf> | **** </formaPagamentoNf> | ||
*** <buscouNfDaSerie/> | **** <buscouNfDaSerie/> | ||
*** <valorContabil/> | **** <valorContabil/> | ||
*** <totalizarImpostoCapa/> | **** <totalizarImpostoCapa/> | ||
*** <idEnvioSat/> | **** <idEnvioSat/> | ||
*** <idCancelamentoSat/> | **** <idCancelamentoSat/> | ||
*** </notaFiscal> | *** </notaFiscal> | ||
** </notasFiscais> | ** </notasFiscais> | ||
Edição das 20h23min de 6 de outubro de 2020
Cadastrar
ListarId
ListarPendentes
LiberarPendentes
ListarNotasFiscais
ListarNotasFiscaisInutilizadas
Método que tem por finalidade filtrar as numerações de NFe inutilizadas no ERP CIGAM.
Parâmetros:
• pin: Obrigatório, Tipo: String • nf: Tipo: numerico • serie: Tipo: String • codigoUnidadeNegocio: Tipo: String
Exemplo de Retorno XML:
<Retorno>
<fagernfe>
<reg>
<nf>0000687623</nf>
<serie>NFE</serie>
<codigoUnidadeNegocio>2</codigoUnidadeNegocio>
<codigoRetornoInutilizacao>102</codigoRetornoInutilizacao>
<descricaoRetornoInutilizacao>Inutilizacao de numero Nfe</descricaoRetornoInutilizacao>
<dataNota>DD/MM/AAAA</dataNota>
<dataEnvio>DD/MM/AAAA</dataEnvio>
<dataRetorno>DD/MM/AAAA</dataRetorno>
<horaRetorno>HHMMSS</horaRetorno>
<status>6</status>
<numeroProtocolo>143170000292574</numeroProtocolo>
<tipoAmbiente>2</tipoAmbiente>
<especieNota>S</especieNota>
<xmlEnvio>..........</xmlEnvio>
<xmlRetorno>........</xmlRetorno>
</reg>
</fagernfe>
</Retorno>
Exemplo de Retorno JSON:
[
{
"nf": "0000687623",
"serie": "NFE",
"codigoUnidadeNegocio": "2",
"codigoRetornoInutilizacao": "102",
"descricaoRetornoInutilizacao": "Inutilizacao de numero de Nfe",
"dataNota": "DD/MM/AAAA",
"dataEnvio": "DD/MM/AAAA",
"dataRetorno": "DD/MM/AAAA",
"horaRetorno": "HHMMSS",
"status": "6",
"numeroProtocolo": "143170000292574",
"tipoAmbiente": "2",
"especieNota": "S",
"xmlEnvio": "............",
"xmlRetorno": "..........."
}
]
ListarNotasFiscaisPaf
ListasNFsMultiplasFormasPagamento
ListarComissoesPorRepresentante
CadastrarNotasFiscais
Cadastra notas fiscais, itens, grades, comissões e parcelas em uma única requisição. Os dados da Nota Fiscal 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.
- Requisição
- Soap: http://servidor/CadastroNotaFiscal.integrador.asmx
- Rest/JSon: http://servidor/CadastroNotaFiscal.integrador.ashx/metodo
- Tipo de registro: CADNF
- Parâmetros:
pin:
Obrigatório, Tipo: String 20
statusRegistro
Obrigatório, Tipo: String 1
L=Liberado, P=Pendente
Se for informado algo diferente de P ou L não será aplicado nenhum filtro.
notaFiscalXml
Obrigatório apenas para requisições SOAP. Tipo: String
Conteúdo de um arquivo XML com as notas fiscais, itens, grades, comissões e parcelas.
notaFiscalJson:
Obrigatório apenas para requisições REST/JSON. Tipo: String
Conteúdo de um arquivo JSON com as notas fiscais, itens, grades, comissões e parcelas.
- Distribuição das Tags XML:
- Distribuição das Tags Json:
RegistrarNotaFiscalInutilizada
Método que tem por finalidade registrar as numerações de NFe inutilizadas no ERP CIGAM.
| Parâmetro | Tipo | Máscara | Observação |
| *pin: | String | 20A | |
| *statusRegistro: | String | 1A | L=Liberado, P=Pendente |
| *codigoUnidadeNegocio: | String | 3A | |
| *nf: | numérico | 10 | |
| *serie | String | 5A | |
| *codigoRetorno: | String | 3A | Retorno informado em cStat |
| *descricaoRetorno: | String | 255A | Retorno informado em xMotivo |
| *dataRecibo: | Date | ##/##/##A | |
| *horaRecibo: | Time | HH:MM:SS | |
| *numeroProtocolo: | String | 15A | Retorno informado em nProt |
| *xmlEnvio: | Blob | Xml de Envio | |
| *xmlRetorno: | Blob | XML de Retorno | |
| *chaveAcesso: | String | 41A |
| (*) Campo obrigatório |
Retornos:
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.
