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

De CIGAM WIKI
Sem resumo de edição
Linha 2 514: Linha 2 514:
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*[
*[
***{
**{
******"nf": "0000687623",
***"nf": "0000687623",
******"serie": "NFE",
***"serie": "NFE",
******"codigoUnidadeNegocio": "2",
***"codigoUnidadeNegocio": "2",
******"codigoRetornoInutilizacao": "102",
***"codigoRetornoInutilizacao": "102",
******"descricaoRetornoInutilizacao": "Inutilizacao de numero de Nfe",
***"descricaoRetornoInutilizacao": "Inutilizacao de numero de Nfe",
******"dataNota": "DD/MM/AAAA",
***"dataNota": "DD/MM/AAAA",
******"dataEnvio": "DD/MM/AAAA",
***"dataEnvio": "DD/MM/AAAA",
******"dataRetorno": "DD/MM/AAAA",
***"dataRetorno": "DD/MM/AAAA",
******"horaRetorno": "HHMMSS",
***"horaRetorno": "HHMMSS",
******"status": "6",
***"status": "6",
******"numeroProtocolo": "143170000292574",
***"numeroProtocolo": "143170000292574",
******"tipoAmbiente": "2",
***"tipoAmbiente": "2",
******"especieNota": "S",
***"especieNota": "S",
******"xmlEnvio": "............",
***"xmlEnvio": "............",
******"xmlRetorno": "..........."
***"xmlRetorno": "..........."
***}
**}
*]
*]
}}
}}

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


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