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

De CIGAM WIKI
 
Linha 77: Linha 77:


<b>Parâmetros:</b></br>
<b>Parâmetros:</b></br>
 
<table width="588">
 
    <tr>
 
        <td width="199">
            <p><strong>Par&acirc;metro</strong></p>
        </td>
        <td width="88">
            <p><strong>Tipo</strong></p>
        </td>
        <td width="87">
            <p><strong>M&aacute;scara</strong></p>
        </td>
        <td width="212">
            <p><strong>Observa&ccedil;&atilde;o</strong></p>
        </td>
      </tr>
      <tr>
        <td width="199">
            <p>&nbsp;*pin:</p>
        </td>
        <td width="88">
            <p>String</p>
        </td>
        <td width="87">
            <p>20A</p>
        </td>
        <td width="212">
            <p>&nbsp;</p>
        </td>
      </tr>
      <tr>
        <td width="199">
            <p>*statusRegistro:</p>
        </td>
        <td width="88">
            <p>String</p>
        </td>
        <td width="87">
            <p>1A</p>
        </td>
        <td width="212">
            <p>L=Liberado, P=Pendente</p>
        </td>
      </tr>
      <tr>
        <td width="199">
            <p>*codigoUnidadeNegocio:</p>
        </td>
        <td width="88">
            <p>String</p>
        </td>
        <td width="87">
            <p>3A</p>
        </td>
        <td width="212">
            <p>&nbsp;</p>
        </td>
      </tr>
      <tr>
        <td width="199">
            <p>*nf:</p>
        </td>
        <td width="88">
            <p>num&eacute;rico</p>
        </td>
        <td width="87">
            <p>10</p>
        </td>
        <td width="212">
            <p>&nbsp;</p>
        </td>
      </tr>
      <tr>
        <td width="199">
            <p>*serie</p>
        </td>
        <td width="88">
            <p>String</p>
        </td>
        <td width="87">
            <p>5A</p>
        </td>
        <td width="212">
            <p>&nbsp;</p>
        </td>
      </tr>
      <tr>
        <td width="199">
            <p>*codigoRetorno:</p>
        </td>
        <td width="88">
            <p>String</p>
        </td>
        <td width="87">
            <p>3A</p>
        </td>
        <td width="212">
            <p>Retorno informado em cStat</p>
        </td>
      </tr>
      <tr>
        <td width="199">
            <p>*descricaoRetorno:</p>
        </td>
        <td width="88">
            <p>String</p>
        </td>
        <td width="87">
            <p>255A</p>
        </td>
        <td width="212">
            <p>Retorno informado em xMotivo</p>
        </td>
      </tr>
      <tr>
        <td width="199">
            <p>*dataRecibo:</p>
        </td>
        <td width="88">
            <p>Date</p>
        </td>
        <td width="87">
            <p>##/##/##A</p>
        </td>
        <td width="212">
            <p>&nbsp;</p>
        </td>
      </tr>
      <tr>
        <td width="199">
            <p>*horaRecibo:</p>
        </td>
        <td width="88">
            <p>Time</p>
        </td>
        <td width="87">
            <p>HH:MM:SS</p>
        </td>
        <td width="212">
            <p>&nbsp;</p>
        </td>
      </tr>
      <tr>
        <td width="199">
            <p>*numeroProtocolo:</p>
        </td>
        <td width="88">
            <p>String</p>
        </td>
        <td width="87">
            <p>15A</p>
        </td>
        <td width="212">
            <p>Retorno informado em nProt</p>
        </td>
      </tr>
      <tr>
        <td width="199">
            <p>*xmlEnvio:</p>
        </td>
        <td width="88">
            <p>Blob</p>
        </td>
        <td width="87">
            <p>&nbsp;</p>
        </td>
        <td width="212">
            <p>Xml de Envio</p>
        </td>
      </tr>
      <tr>
        <td width="199">
            <p>*xmlRetorno:</p>
        </td>
        <td width="88">
            <p>Blob</p>
        </td>
        <td width="87">
            <p>&nbsp;</p>
        </td>
        <td width="212">
            <p>XML de Retorno</p>
        </td>
      </tr>
      <tr>
        <td width="199">
            <p>*chaveAcesso:</p>
        </td>
        <td width="88">
            <p>String</p>
        </td>
        <td width="87">
            <p>41A</p>
        </td>
        <td width="212">
            <p>&nbsp;</p>
        </td>
    </tr>
</table>





Edição das 16h28min de 28 de maio 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

RegistrarNotaFiscalInutilizada

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

Parâmetros:

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

 


Exemplo de Retorno XML:
<Retorno>