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

De CIGAM WIKI
Sem resumo de edição
Sem resumo de edição
Linha 3 693: Linha 3 693:
*modeloLancamento
*modeloLancamento
** Tipo: String 6
** Tipo: String 6
}}<br>
*<b>Distribuição das Tags XML:</b><br>
{{#tree: minExpandLevel=2 |
*<cadastrarNotasFiscais>
**<notasFiscais>
***<notaFiscal>
****<unidadeNegocio />
****<nf>0</nf>
****<serie />
****<tipoOperacao />
****<dataEmissao />
****<cliente />
****<representante />
****<uf />
****<quantidadeTotal>0</quantidadeTotal>
****<entrega>0</entrega>
****<itensNf>
*****<itemNf>
******<codigoMaterial />
******<centroArmazenagem />
******<grade />
******<quantidade>0</quantidade>
******<precoUnitario>0</precoUnitario>
******<descricao />
******<grades>
*******<gradeItemNf>
********<numeracao />
********<quantidade>0</quantidade>
*******</gradeItemNf>
******</grades>
******<comissoesItem>
*******<comissaoNf>
********<representante />
********<valorBaseComissao>0</valorBaseComissao>
********<percentualComissao>0</percentualComissao>
*******</comissaoNf>
******</comissoesItem>
*****</itemNf>
****</itensNf>
****<comissoesNf>
*****<comissaoNf>
******<representante />
******<valorBaseComissao>0</valorBaseComissao>
******<percentualComissao>0</percentualComissao>
*****</comissaoNf>
****</comissoesNf>
****<parcelasNf>
*****<parcelaNf>
******<vencimento />
******<valorParcela>0</valorParcela>
*****</parcelaNf>
****</parcelasNf>
***</notaFiscal>
**</notasFiscais>
*</cadastrarNotasFiscais>
}}<br>
*<b>Distribuição das Tags Json:</b><br>
{{#tree: minExpandLevel=2 |
*{
**"notasFiscais": [{
***"notaFiscal": {
****"unidadeNegocio": "",
****"nf": "0",
****"serie": "",
****"tipoOperacao": "",
****"dataEmissao": "",
****"cliente": "",
****"representante": "",
****"uf": "",
****"quantidadeTotal": "0",
****“entrega”: “0”,
****"itensNf": [{
*****"itemNf": {
******"codigoMaterial": "",
******"centroArmazenagem": "",
******"grade": "",
******"quantidade": "0",
******"precoUnitario": "0",
******"descricao": "",
******"grades": [{
*******"gradeItemNf": {
********"numeracao": "",
********"quantidade": "0"
*******}
******}],
******"comissoesItem": [{
*******"comissaoNf": {
********"representante": "",
********"valorBaseComissao": "0",
********"percentualComissao": "0"
*******}
******}]
*****}
****}],
****"comissoesNf": [{
*****"comissaoNf": {
******"representante": "",
******"valorBaseComissao": "0",
******"percentualComissao": "0"
*****}
****}],
****"parcelasNf": [{
*****"parcelaNf": {
******"vencimento": "",
******"valorParcela": "0"
*****}
****}]
***}
**}]
*}
}}
}}
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>

Edição das 17h12min 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 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

  • Parâmetros:


Retorno:
   Se sucesso:

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


  • Distribuição das Tags XML:


  • Distribuição das Tags Json:


   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.

ListarNotasFiscaisPaf

ListasNFsMultiplasFormasPagamento

ListarComissoesPorRepresentante