IN CadastroNotaFiscal.integrador: mudanças entre as edições

De CIGAM WIKI
Sem resumo de edição
Linha 2 467: Linha 2 467:


== ListarNotasFiscaisInutilizadas ==
== ListarNotasFiscaisInutilizadas ==
<p align="justify"><b><i>
<p align="justify"><i>
Método que tem por finalidade filtrar as numerações de NFe inutilizadas no ERP CIGAM.</br></b></i></p>
Método que tem por finalidade filtrar as numerações de NFe inutilizadas no ERP CIGAM.
</i></p>


*<b>Parâmetros:</b></br>
*<b>Parâmetros:</b><br>
<div style="background-color: #f2f2f2">
{{#tree: minExpandLevel=2 |
&nbsp;&nbsp;&nbsp;<b>pin:</b><br>
*pin:</b><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Obrigatório, Tipo: String 20<br><br>
**Obrigatório, Tipo: String 20<br>
&nbsp;&nbsp;&nbsp; <b>nf:</b><br>  
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tipo: numerico<br><br>
*nf:</b><br>  
&nbsp;&nbsp;&nbsp;<b>serie:</b><br>
**Tipo: numerico<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tipo: String<br><br>
<br>
&nbsp;&nbsp;&nbsp;<b>codigoUnidadeNegocio:</b><br>
*serie:</b><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tipo: String<br><br>
**Tipo: String<br>
  </div>
<br>
</br>
*codigoUnidadeNegocio:</b><br>
**Tipo: String
}}


<b>Exemplo de Retorno XML:</b></br>
*<b>Exemplo de Retorno XML:</b><br>
<Retorno></br>
{{#tree: minExpandLevel=2 |
&nbsp;&nbsp;<fagernfe></br>
*<Retorno>
&nbsp;&nbsp;&nbsp;&nbsp;<reg></br>
**<fagernfe>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<nf>0000687623</nf></br>
****<reg>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<serie>NFE</serie></br>
******<nf>0000687623</nf>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<codigoUnidadeNegocio>2</codigoUnidadeNegocio></br>
******<serie>NFE</serie>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<codigoRetornoInutilizacao>102</codigoRetornoInutilizacao></br>
******<codigoUnidadeNegocio>2</codigoUnidadeNegocio>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<descricaoRetornoInutilizacao>Inutilizacao de numero Nfe</descricaoRetornoInutilizacao></br>
******<codigoRetornoInutilizacao>102</codigoRetornoInutilizacao>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<dataNota>DD/MM/AAAA</dataNota></br>
******<descricaoRetornoInutilizacao>Inutilizacao de numero Nfe</descricaoRetornoInutilizacao>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<dataEnvio>DD/MM/AAAA</dataEnvio></br>
******<dataNota>DD/MM/AAAA</dataNota>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<dataRetorno>DD/MM/AAAA</dataRetorno></br>
******<dataEnvio>DD/MM/AAAA</dataEnvio>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<horaRetorno>HHMMSS</horaRetorno></br>
******<dataRetorno>DD/MM/AAAA</dataRetorno>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<status>6</status></br>
******<horaRetorno>HHMMSS</horaRetorno>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<numeroProtocolo>143170000292574</numeroProtocolo></br>
******<status>6</status>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<tipoAmbiente>2</tipoAmbiente></br>
******<numeroProtocolo>143170000292574</numeroProtocolo>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<especieNota>S</especieNota></br>
******<tipoAmbiente>2</tipoAmbiente>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<xmlEnvio>..........</xmlEnvio></br>
******<especieNota>S</especieNota>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;<xmlRetorno>........</xmlRetorno></br>
******<xmlEnvio>..........</xmlEnvio>
&nbsp;&nbsp;&nbsp;&nbsp;</reg></br>
******<xmlRetorno>........</xmlRetorno>
&nbsp;&nbsp;</fagernfe></br>
****</reg>
</Retorno>
**</fagernfe>
</br>
*</Retorno>
}}<br>
 
*<b>Exemplo de Retorno JSON:</b><br>
{{#tree: minExpandLevel=2 |
*[
***{
******"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": "..........."
***}
*]
}}


<b>Exemplo de Retorno JSON:</b></br>
&nbsp;[</br>
&nbsp;&nbsp;&nbsp;{</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"nf": "0000687623",</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"serie": "NFE",</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"codigoUnidadeNegocio": "2",</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"codigoRetornoInutilizacao": "102",</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"descricaoRetornoInutilizacao": "Inutilizacao de numero de Nfe",</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"dataNota": "DD/MM/AAAA",</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"dataEnvio": "DD/MM/AAAA",</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"dataRetorno": "DD/MM/AAAA",</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"horaRetorno": "HHMMSS",</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"status": "6",</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"numeroProtocolo": "143170000292574",</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"tipoAmbiente": "2",</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"especieNota": "S",</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"xmlEnvio": "............",</br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"xmlRetorno": "..........."</br>
&nbsp;&nbsp;&nbsp;}</br>
&nbsp;]</br>


==== ListarNotasFiscaisPaf ====
==== ListarNotasFiscaisPaf ====

Edição das 12h20min de 17 de fevereiro de 2022

Voltar

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. As Notas Fiscais de Entrada não possuem listagem, foi liberado somente o cadastro da mesma via integração.

  • Parâmetros:


  • Parâmetros para o elemento notaFiscal:


  • Parâmetros para o elemento itemNf:


  • Parâmetros para o elemento gradeItemNf:


  • Parâmetros para o elemento comissaoNf:


  • Parâmetros para o elemento parcelaNf:


  • Parâmetros para o elemento lancamentoNf:


  • Parâmetros para o elemento cheque:


  • Distribuição das Tags XML:


  • Distribuição das Tags Json:


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

   Se sucesso:
      idRegistro - ID que representa este registro na tabela de integração.

   Se algum parâmetro inválido:
      Parâmetro necessário não informado.

ListarNotasFiscaisInutilizadas

Método que tem por finalidade filtrar as numerações de NFe inutilizadas no ERP CIGAM.

  • Parâmetros:


  • nf:
    • Tipo: numerico


  • serie:
    • Tipo: String


  • codigoUnidadeNegocio:
    • Tipo: String
  • Exemplo de Retorno XML:


  • Exemplo de Retorno JSON:


ListarNotasFiscaisPaf

ListasNFsMultiplasFormasPagamento

ListarComissoesPorRepresentante

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.

ExcluirNotaFiscal

Esse método fará as mesmas validações que ocorrem ao tentar excluir uma NFe manualmente, com a diferença que permitirá a exclusão de notas fiscais confirmadas, visto que o cancelamento na SEFAZ já foi feito através de um sistema de terceiros.

Informações obrigatórias para a exclusão da nota: Número, Série e Unidade de Negócio. O sistema faz a validação se a série da nota fiscal está cadastrada para a unidade de negócio informada nos filtro do programa utilizado para integração.

Parâmetros

<pin Type="System.String">001</pin>
<statusRegistro Type="System.String">L</statusRegistro>
<nf Type="System.Int32">número NF</nf>
<serie Type="System.String">série NF</serie>
<codigoUnidadeNegocio Type="System.String">UN NEG NF</codigoUnidadeNegocio>

ListarId

ListarPendentes

LiberarPendentes

ListarNotasFiscais