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

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


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


==== ListarNotasFiscaisPaf ====
*<b>Parâmetros:</b><br>
==== ListasNFsMultiplasFormasPagamento ====
{{#tree: minExpandLevel=2 |
==== ListarComissoesPorRepresentante ====
*pin</td>
** Obrigatório, Tipo: String 20A


*statusRegistro
** Obrigatório, Tipo: String 1A
** L=Liberado, P=Pendente


*codigoUnidadeNegocio
** Obrigatório, Tipo: String 3A


*nf
** Obrigatório, Tipo: numérico 10


*serie
** Obrigatório, Tipo: String 5A


*codigoRetorno
** Obrigatório, Tipo: String 3A
** Retorno informado em cStat


*descricaoRetorno
** Obrigatório, Tipo: String 255A
** Retorno informado em xMotivo


*dataRecibo
** Obrigatório, Tipo: Date


==== RegistrarNotaFiscalInutilizada ====
*horaRecibo
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;">
** Obrigatório, Tipo: Time
Método que tem por finalidade registrar as numerações de NFe inutilizadas no ERP CIGAM.</p>


<center><table width="650" border="1" cellspacing="0" cellpadding="7" style="font-size:10.0pt">
*numeroProtocolo
    <tr>
** Obrigatório, Tipo: String 15A
        <td width="35%" style="background:#d9d9d9;text-align:center"><strong>Par&acirc;metro</strong></td>
** Retorno informado em nProt
        <td width="15%" style="background:#d9d9d9;text-align:center"><strong>Tipo</strong></td>
        <td width="15%" style="background:#d9d9d9;text-align:center"><strong>M&aacute;scara</strong></td>
        <td width="35%" style="background:#d9d9d9;text-align:center"><strong>Observa&ccedil;&atilde;o</strong></td>
      </tr>
      <tr>
        <td>&nbsp;&nbsp;&nbsp;*pin:</td>
        <td>String</td>
        <td>20A</td>
        <td>&nbsp;</td>
      </tr>
      <tr>
        <td>&nbsp;&nbsp;&nbsp;*statusRegistro:</td>
        <td>String</td>
        <td>1A</td>
        <td>L=Liberado, P=Pendente</td>
      </tr>
      <tr>
        <td>&nbsp;&nbsp;&nbsp;*codigoUnidadeNegocio:</td>
        <td>String</td>
        <td>3A</td>
        <td>&nbsp;</td>
      </tr>
      <tr>
        <td>&nbsp;&nbsp;&nbsp;*nf:</td>
        <td>num&eacute;rico</td>
        <td>10</td>
        <td>&nbsp;</td>
      </tr>
      <tr>
        <td>&nbsp;&nbsp;&nbsp;*serie</td>
        <td>String</td>
        <td>5A</td>
        <td>&nbsp;</td>
      </tr>
      <tr>
        <td>&nbsp;&nbsp;&nbsp;*codigoRetorno:</td>
        <td>String</td>
        <td>3A</td>
        <td>Retorno informado em cStat</td>
      </tr>
      <tr>
        <td>&nbsp;&nbsp;&nbsp;*descricaoRetorno:</td>
        <td>String</td>
        <td>255A</td>
        <td>Retorno informado em xMotivo</td>
      </tr>
      <tr>
        <td>&nbsp;&nbsp;&nbsp;*dataRecibo:</td>
        <td>Date</td>
        <td>##/##/##A</td>
        <td>&nbsp;</td>
      </tr>
      <tr>
        <td>&nbsp;&nbsp;&nbsp;*horaRecibo:</td>
        <td>Time</td>
        <td>HH:MM:SS</td>
        <td>&nbsp;</td>
      </tr>
      <tr>
        <td>&nbsp;&nbsp;&nbsp;*numeroProtocolo:</td>
        <td>String</td>
        <td>15A</td>
        <td>Retorno informado em nProt</td>
      </tr>
      <tr>
        <td>&nbsp;&nbsp;&nbsp;*xmlEnvio:</td>
        <td>Blob</td>
        <td>&nbsp;</td>
        <td>Xml de Envio</td>
      </tr>
      <tr>
        <td>&nbsp;&nbsp;&nbsp;*xmlRetorno:</td>
        <td>Blob</td>
        <td>&nbsp;</td>
        <td>XML de Retorno</td>
      </tr>
      <tr>
        <td>&nbsp;&nbsp;&nbsp;*chaveAcesso:</td>
        <td>String</td>
        <td>41A</td>
        <td>&nbsp;</td>
    </tr>
</table></center>


<center><table width="650" border="0" cellspacing="0" cellpadding="7" style="font-size:8.5pt">
*xmlEnvio
    <tr>
** Obrigatório, Tipo: Blob
        <td colspan=4 valign=top'>&nbsp;&nbsp;&nbsp;<b>(*)</b> Campo obrigatório</td>
** Xml de Envio
    </tr>
 
</table></center>
*xmlRetorno
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
** Obrigatório, Tipo: Blob
<b>Retornos:</b><br/>
** XML de Retorno
 
*chaveAcesso
** Obrigatório, Tipo: String 41A
}}
<p align=“justify” style=“margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;”><br/>
<b>Retorno:</b><br/>
&nbsp;&nbsp;&nbsp;Se pin inválido:<br/>
&nbsp;&nbsp;&nbsp;Se pin inválido:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;O usuário não possui direitos suficientes para executar esta rotina.<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;O usuário não possui direitos suficientes para executar esta rotina.<br/>
<br/>
<br/>
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.<br/></p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>


==== ExcluirNotaFiscal ====
== 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.
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.
<P align="justify">
<P align="justify">
Linha 2 673: Linha 2 617:
== LiberarPendentes ==
== LiberarPendentes ==
== ListarNotasFiscais ==
== ListarNotasFiscais ==
== ListarNotasFiscaisPaf ==
== ListasNFsMultiplasFormasPagamento ==
== ListarComissoesPorRepresentante ==

Edição das 12h40min 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:


  • Exemplo de Retorno XML:


  • Exemplo de Retorno JSON:

RegistrarNotaFiscalInutilizada

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

  • Parâmetros:


Retorno:
   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

ListarNotasFiscaisPaf

ListasNFsMultiplasFormasPagamento

ListarComissoesPorRepresentante