|
|
| Linha 1 575: |
Linha 1 575: |
| <b>Retorno:</b><br/> | | <b>Retorno:</b><br/> |
| Se sucesso:<br/> | | Se sucesso:<br/> |
| *<b>Parâmetros para o elemento notaFiscal:</b><br>
| |
| {{#tree: minExpandLevel=2 |
| |
| *nf
| |
| ** Tipo: Int 10
| |
|
| |
| *serie
| |
| ** Tipo: String 5
| |
|
| |
| *valorPISRetencao
| |
| ** Tipo: Float 11.2
| |
|
| |
| *tipoOperacao
| |
| ** Tipo: String 5
| |
|
| |
| *CFOP
| |
| ** Tipo: String 6
| |
|
| |
| *dataEmissao
| |
| ** Tipo: Date
| |
|
| |
| *viaTransporte
| |
| ** Tipo: String 1
| |
|
| |
| *documentoFiscal
| |
| ** Tipo: String 5
| |
|
| |
| *cliente
| |
| ** Tipo: String 6
| |
|
| |
| *cobranca
| |
| ** Tipo: String 6
| |
|
| |
| *representante
| |
| ** Tipo: String 6
| |
|
| |
| *baseICMS
| |
| ** Tipo: Float 13.2
| |
|
| |
| *percentualICMS
| |
| ** Tipo: Float 2.4
| |
|
| |
| *valorICMS
| |
| ** Tipo: Float 11.2
| |
|
| |
| *ICMSNaoTributado
| |
| ** Tipo: Float 11.2
| |
|
| |
| *ICMSOutros
| |
| ** Tipo: Float 11.2
| |
|
| |
| *baseIPI
| |
| ** Tipo: Float 13.2
| |
|
| |
| *valorIPI
| |
| ** Tipo: Float 11.2
| |
|
| |
| *IPINaoTributado
| |
| ** Tipo: Float 11.2
| |
|
| |
| *IPIOutros
| |
| ** Tipo: Float 11.2
| |
|
| |
| *valorISS
| |
| ** Tipo: Float 11.2
| |
|
| |
| *baseISS
| |
| ** Tipo: Float 13.2
| |
|
| |
| *incidenciaPIS
| |
| ** Tipo: String 1
| |
|
| |
| *incidenciaCOFINS
| |
| ** Tipo: String 1
| |
|
| |
| *percDescontoAteVencimento
| |
| ** Tipo: Float 3.2
| |
|
| |
| *valorDescDuplicata
| |
| ** Tipo: Float 11.2
| |
|
| |
| *percDescontoSugestaoItens
| |
| ** Tipo: Float 3.2
| |
|
| |
| *valorTotalDesconto
| |
| ** Tipo: Float 11.2
| |
|
| |
| *percGeralOutrasDespAcessorias
| |
| ** Tipo: Float 3.2
| |
|
| |
| *valorTotalFrete
| |
| ** Tipo: Float 11.2
| |
|
| |
| *seguro
| |
| ** Tipo: Float 11.2
| |
|
| |
| *totalMercadorias
| |
| ** Tipo: Float 13.2
| |
|
| |
| *totalNF
| |
| ** Tipo: Float 13.2
| |
|
| |
| *transportadora
| |
| ** Tipo: String 6
| |
|
| |
| *consignatario
| |
| ** Tipo: String 6
| |
|
| |
| *marca
| |
| ** Tipo: String 12
| |
|
| |
| *volume
| |
| ** Tipo: String 15
| |
|
| |
| *quantidade
| |
| ** Tipo: String 6
| |
|
| |
| *especie
| |
| ** Tipo: String 16
| |
|
| |
| *pesoLiquido
| |
| ** Tipo: Float 8.2
| |
|
| |
| *pesoBruto
| |
| ** Tipo: Float 8.2
| |
|
| |
| *conta
| |
| ** Tipo: String 6
| |
|
| |
| *portador
| |
| ** Tipo: String 3
| |
|
| |
| *fatura
| |
| ** Tipo: Int 10
| |
|
| |
| *cobrarPauta
| |
| ** Tipo: String 1
| |
| ** S=Sim, N=Não
| |
|
| |
| *remessa
| |
| ** Tipo: String 3
| |
|
| |
| *pedido
| |
| ** Tipo: String 12
| |
|
| |
| *dataSaida
| |
| ** Tipo: Date
| |
|
| |
| *horaSaida
| |
| ** Tipo: String 8
| |
| ** hh:mm:ss
| |
|
| |
| *percGeralEncargosFinanceiros
| |
| ** Tipo: Float 2.3
| |
|
| |
| *gerouLancamentos
| |
| ** Tipo: Bool
| |
|
| |
| *itemsNaNota
| |
| ** Tipo: Int 5
| |
|
| |
| *tipoFrete
| |
| ** Tipo: String 1
| |
| ** 1=Emitente (CIF), 2=Destinatario (FOB), 3=EXW, 4=FCA, 5=FAS, 6=CFR, 7=CPT, 8=CIP, 9=DAF, A=DES, B=DEQ, C=DDU, D= DDP
| |
|
| |
| *uf
| |
| ** Tipo: String 2
| |
|
| |
| *percentualComissao
| |
| ** Tipo: Float 3.2
| |
|
| |
| *placa
| |
| ** Tipo: String 8
| |
|
| |
| *valorIRRF
| |
| ** Tipo: Float 11.2
| |
|
| |
| *especieNota
| |
| ** Tipo: String 1
| |
| ** E=Entrada, S=Saída, N=Nula
| |
|
| |
| *subtotalizar
| |
| ** Tipo: Bool
| |
|
| |
| *incidenciaISS
| |
| ** Tipo: String 1
| |
|
| |
| *ateNota
| |
| ** Tipo: Int 10
| |
|
| |
| *totalFaturado
| |
| ** Tipo: Float 13.2
| |
|
| |
| *totalServico
| |
| ** Tipo: Float 13.2
| |
|
| |
| *valorTotalOutrasDespesasAcess
| |
| ** Tipo: Float 11.2
| |
|
| |
| *valorTotalEncargosFinanceiros
| |
| ** Tipo: Float 11.2
| |
|
| |
| *substitutoTributario
| |
| ** Tipo: String 6
| |
|
| |
| *notaReferencia
| |
| ** Tipo: Int 10
| |
|
| |
| *baseSubstituicaoTributaria
| |
| ** Tipo: Float 13.2
| |
|
| |
| *valorSubstituicaoTributaria
| |
| ** Tipo: Float 13.2
| |
|
| |
| *percentualIRRF
| |
| ** Tipo: Float 3.2
| |
|
| |
| *percentualINSS
| |
| ** Tipo: Float 3.2
| |
|
| |
| *condicaoPagamento
| |
| ** Tipo: String 3
| |
|
| |
| *percentualISS
| |
| ** Tipo: Float 3.2
| |
|
| |
| *complementoFatura
| |
| ** Tipo: String 5
| |
|
| |
| *contabilizado
| |
| ** Tipo: String 1
| |
|
| |
| *faturaAglutinada
| |
| ** Tipo: String 1
| |
| ** S=Sim, N=Não
| |
|
| |
| *gerouINSS
| |
| ** Tipo: String 1
| |
|
| |
| *serieReferencia
| |
| ** Tipo: String 5
| |
|
| |
| *codigoMunicipio
| |
| ** Tipo: String 10
| |
|
| |
| *valorDeducoes
| |
| ** Tipo: Float 13.2
| |
|
| |
| *valorINSS
| |
| ** Tipo: Float 11.2
| |
|
| |
| *unidadeNegocio
| |
| ** Tipo: String 3
| |
|
| |
| *quantidadeTotal
| |
| ** Tipo: Float 8.6
| |
|
| |
| *impressa
| |
| ** Tipo: Bool
| |
|
| |
| *declaracaoImportacao
| |
| ** Tipo: String 12
| |
|
| |
| *percentualICMSSubstituicao
| |
| ** Tipo: Float 3.2
| |
|
| |
| *percentualComissaoAReceber
| |
| ** Tipo: Float 3.2
| |
|
| |
| *notaIncentivada
| |
| ** Tipo: Bool
| |
|
| |
| *taxaIndexador
| |
| ** Tipo: Float 10.5
| |
|
| |
| *indiceIndexador
| |
| ** Tipo: String 5
| |
|
| |
| *baseIRRF
| |
| ** Tipo: Float 13.2
| |
|
| |
| *modeloCupom
| |
| ** Tipo: String 3
| |
|
| |
| *numeroControleFormulario
| |
| ** Tipo: String 12
| |
|
| |
| *romaneio
| |
| ** Tipo: Integer 10
| |
|
| |
| *dataRomaneio
| |
| ** Tipo: Date
| |
|
| |
| *ufPlacaTransportador
| |
| ** Tipo: String 2
| |
|
| |
| *percGeralDesconto
| |
| ** Tipo: Float 3.2
| |
|
| |
| *valorInformODA
| |
| ** Tipo: Float 4.2
| |
|
| |
| *percFreteInformativo
| |
| ** Tipo: Float 3.2
| |
|
| |
| *codigoCancelamento
| |
| ** Tipo: String 3
| |
|
| |
| *codigoDevolucao
| |
| ** Tipo: String 3
| |
|
| |
| *ordemCompra
| |
| ** Tipo: String 12
| |
|
| |
| *projeto
| |
| ** Tipo: String 12
| |
|
| |
| *modeloFormulario
| |
| ** Tipo: Int 2
| |
|
| |
| *notaIPIECFGerada
| |
| ** Tipo: Bool
| |
|
| |
| *creditoICMSPresumido
| |
| ** Tipo: Float 11.2
| |
|
| |
| *percentualFunrural
| |
| ** Tipo: Float 3.2
| |
|
| |
| *valorFunrural
| |
| ** Tipo: Float 11.2
| |
|
| |
| *dataNFTriangularAglutinada
| |
| ** Tipo: Date
| |
|
| |
| *dataValidacao
| |
| ** Tipo: Date
| |
|
| |
| *dataCancelamento
| |
| ** Tipo: Date
| |
|
| |
| *campo125
| |
| ** Tipo: Date
| |
|
| |
| *ordemDeCompraGerada
| |
| ** Tipo: String 2
| |
|
| |
| *totalItensServico
| |
| ** Tipo: Int 7
| |
|
| |
| *pesoExtraEmbalagem
| |
| ** Tipo: Float 8.6
| |
|
| |
| *usrnota1
| |
| ** Tipo: String 20
| |
|
| |
| *usrnota2
| |
| ** Tipo: Date
| |
|
| |
| *chaveNFe
| |
| ** Tipo: String 44
| |
|
| |
| *numeroProtocolo
| |
| ** Tipo: String 15
| |
|
| |
| *numeroLote
| |
| ** Tipo: String 15
| |
|
| |
| *gerouPedidoConsignacao
| |
| ** Tipo: String 1
| |
|
| |
| *listarLivros
| |
| ** Tipo: String 1
| |
|
| |
| *tipoNota
| |
| ** Tipo: String 1
| |
| ** N=Normal, D=Devolução, T=Transferencia, C=Complementar, I=Importação, M=Mapa Resumo, S=Sessão Crédito ICMS,
| |
| ** B=Brinde, F=Frete/Conhecimento, G=Garantia_Troca, V=Venda a Ordem, R=Remessa, 1=1 Genérico,
| |
| ** 2=2 Genérico, 3=3 Genérico, E=Entrega_Futura
| |
|
| |
| *classificacaoDocumento
| |
| ** Tipo: String 1
| |
|
| |
| *incluiSubstituicaoTributaria
| |
| ** Tipo: String 1
| |
|
| |
| *mercado
| |
| ** Tipo: String 2
| |
|
| |
| *grade
| |
| ** Tipo: String 2
| |
|
| |
| *incidenciaContribSocial
| |
| ** Tipo: String 1
| |
| ** S=Soma, D=Diminui, N=Nao considera
| |
|
| |
| *folhaLivroSaida
| |
| ** Tipo: String 6
| |
|
| |
| *tgConversaoUnidades
| |
| ** Tipo: String 6
| |
|
| |
| *fornecedor
| |
| ** Tipo: String 6
| |
|
| |
| *volumeAtualizado
| |
| ** Tipo: String 6
| |
|
| |
| *ordemEnderecoCobranca
| |
| ** Tipo: String 1
| |
|
| |
| *ordemEnderecoEntrega
| |
| ** Tipo: String 1
| |
|
| |
| *forma
| |
| ** Tipo: String 1
| |
| ** C=Carnê, D=Duplicata, F=Financiamento, P=Prédatado, E=Empresa Convênio, R=Representada
| |
|
| |
| *tipoFreteConsignatario
| |
| ** Tipo: String 2
| |
| ** 1=1 Emitente (CIF), 2=2 Destinatário (FOB)
| |
|
| |
| *conferido
| |
| ** Tipo: String 2
| |
|
| |
| *numeroLivroSaida
| |
| ** Tipo: String 3
| |
|
| |
| *usuarioAutorizado
| |
| ** Tipo: String 3
| |
|
| |
| *entregMercAposFatur
| |
| ** Tipo: String 3
| |
|
| |
| *impostosAjustados
| |
| ** Tipo: Bool
| |
|
| |
| *nfInconsistente
| |
| ** Tipo: Bool
| |
|
| |
| *buscarRegraFiscal
| |
| ** Tipo: Bool
| |
|
| |
| *contatoCliente
| |
| ** Tipo: Float 8.6
| |
|
| |
| *percICMSResponsabilidade
| |
| ** Tipo: Float 8.6
| |
|
| |
| *valorSuframaSimbahia
| |
| ** Tipo: Float 11.2
| |
|
| |
| *valorAVista
| |
| ** Tipo: Float 11.2
| |
|
| |
| *valorCOFINSRetencao
| |
| ** Tipo: Float 13.2
| |
|
| |
| *valorContribuicaoSocial
| |
| ** Tipo: Float 13.2
| |
|
| |
| *valorInformDesconto
| |
| ** Tipo: Float 11.2
| |
|
| |
| *naoCalcularFinanceiro
| |
| ** Tipo: Bool
| |
|
| |
| *naoCalcularComissoes
| |
| ** Tipo: Bool
| |
|
| |
| *usrfacomplnf3
| |
| ** Tipo: Double 11
| |
| }}<br/>
| |
|
| |
|
| *<b>Distribuição das Tags XML:</b><br> | | *<b>Distribuição das Tags XML:</b><br> |
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.
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- statusRegistro
- Tipo: String 1
- L=Liberado, P=Pendente
- Se for informado algo diferente de P ou L não será aplicado nenhum filtro.
- notaFiscalXml
- Tipo: String -
- Conteúdo de um arquivo XML com as notas fiscais, itens, grades, comissões e parcelas.
- Obrigatório apenas para requisições SOAP.
- notaFiscalJson
- Tipo: String -
- Conteúdo de um arquivo JSON com as notas fiscais, itens, grades, comissões e parcelas.
- Obrigatório apenas para requisições REST/JSON.
- Distribuição das Tags XML:
- Distribuição das Tags Json:
- {
- "notasFiscais": "",
- [{
- "unidadeNegocio": "",
- "nf": "",
- "serie": "",
- "valorPISRetencao": "",
- "tipoOperacao": "",
- "CFOP": "",
- "dataEmissao": "",
- "viaTransporte": "",
- "documentoFiscal": "",
- "cliente": "",
- "cobranca": "",
- "representante": "",
- "baseICMS": "",
- "percentualICMS": "",
- "valorICMS": "",
- "ICMSNaoTributado": "",
- "ICMSOutros": "",
- "baseIPI": "",
- "valorIPI": "",
- "IPINaoTributado": "",
- "IPIOutros": "",
- "valorISS": "",
- "baseISS": "",
- "incidenciaPIS": "",
- "incidenciaCOFINS": "",
- "percDescontoAteVencimento": "",
- "valorDescDuplicata": "",
- "percDescontoSugestaoItens": "",
- "valorTotalDesconto": "",
- "percGeralOutrasDespAcessorias": "",
- "valorTotalFrete": "",
- "seguro": "",
- "totalMercadorias": "",
- "totalNF": "",
- "transportadora": "",
- "consignatario": "",
- "marca": "",
- "volume": "",
- "quantidade": "",
- "especie": "",
- "pesoLiquido": "",
- "pesoBruto": "",
- "conta": "",
- "portador": "",
- "fatura": "",
- "cobrarPauta": "",
- "remessa": "",
- "pedido": "",
- "dataSaida": "",
- "horaSaida": "",
- "percGeralEncargosFinanceiros": "",
- "gerouLancamentos": "",
- "itemsNaNota": "",
- "tipoFrete": "",
- "uf": "",
- "percentualComissao": "",
- "placa": "",
- "valorIRRF": "",
- "especieNota": "",
- "subtotalizar": "",
- "incidenciaISS": "",
- "ateNota": "",
- "totalFaturado": "",
- "totalServico": "",
- "valorTotalOutrasDespesasAcess": "",
- "valorTotalEncargosFinanceiros": "",
- "substitutoTributario": "",
- "notaReferencia": "",
- "baseSubstituicaoTributaria": "",
- "valorSubstituicaoTributaria": "",
- "percentualIRRF": "",
- "percentualINSS": "",
- "condicaoPagamento": "",
- "percentualISS": "",
- "complementoFatura": "",
- "contabilizado": "",
- "faturaAglutinada": "",
- "gerouINSS": "",
- "serieReferencia": "",
- "codigoReferenciaEmpresa": "",
- "codigoMunicipio": "",
- "valorDeducoes": "",
- "valorINSS": "",
- "quantidadeTotal": "",
- "impressa": "",
- "declaracaoImportacao": "",
- "percentualICMSSubstituicao": "",
- "percentualComissaoAReceber": "",
- "notaIncentivada": "",
- "taxaIndexador": "",
- "indiceIndexador": "",
- "baseIRRF": "",
- "modeloCupom": "",
- "numeroControleFormulario": "",
- "romaneio": "",
- "dataRomaneio": "",
- "ufPlacaTransportador": "",
- "percentualDesconto2": "",
- "percGeralDesconto": "",
- "valorInformODA": "",
- "percFreteInformativo": "",
- "codigoCancelamento": "",
- "codigoDevolucao": "",
- "ordemCompra": "",
- "projeto": "",
- "modeloFormulario": "",
- "notaIPIECFGerada": "",
- "creditoICMSPresumido": "",
- "percentualFunrural": "",
- "valorFunrural": "",
- "dataNFTriangularAglutinada": "",
- "dataValidacao": "",
- "dataCancelamento": "",
- "campo125": "",
- "ordemDeCompraGerada": "",
- "totalItensServico": "",
- "pesoExtraEmbalagem": "",
- "usrnota1": "",
- "usrnota2": "",
- "chaveNFe": "",
- "numeroProtocolo": "",
- "numeroLote": "",
- "gerouPedidoConsignacao": "",
- "incluiSubstituicaoTributaria": "",
- "listarLivros": "",
- "tipoNota": "",
- "classificacaoDocumento": "",
- "mercado": "",
- "grade": "",
- "incidenciaContribSocial": "",
- "folhaLivroSaida": "",
- "tgConversaoUnidades": "",
- "fornecedor": "",
- "volumeAtualizado": "",
- "ordemEnderecoCobranca": "",
- "ordemEnderecoEntrega": "",
- "forma": "",
- "tipoFreteConsignatario": "",
- "conferido": "",
- "numeroLivroSaida": "",
- "usuarioAutorizado": "",
- "entregMercAposFatur": "",
- "impostosAjustados": "",
- "nfInconsistente": "",
- "buscarRegraFiscal": "",
- "contatoCliente": "",
- "percICMSResponsabilidade": "",
- "valorSuframaSimbahia": "",
- "valorAVista": "",
- "valorCOFINSRetencao": "",
- "valorContribuicaoSocial": "",
- "valorInformDesconto": "",
- "tipoPagamento": "",
- "naoCalcularFinanceiro": "",
- "naoCalcularComissoes": "",
- "observacoes": "",
- "status": "",
- 1 - Sim;
- 2 - Internet (não presencial);
- 3 - Teleatendimento;
- 4 - NFC-e entrega à domicílio;
- 5 - Sim (fora do estabelecimento);
- 9 - Outros (não presencial)
- "operacaoPresencial": "",
- "baseDifal": "",
- "valorDifalOrigem": "",
- "valorDifalDestino": "",
- "usrfacomplnf3": "",
- "origem": "",
- 0 - NFS;
- 1 - NFE;
- 2 - Devolução NFE;
- 3 - Devolução NFS;
- 4 - Transferência
- "unidadeNegocioReferencia": "",
- "informacoesPAf": ""
- [{
- "nomeCliente": "",
- "cpfCnpjCliente": "",
- "pessoa": "",
- "endereco": "",
- "numero": "",
- "complemento": "",
- "bairro": "",
- "municipio": "",
- "uf": "",
- "cep": "",
- }],
- naoGerarChaveNfe
- Ao receber 'S' não deverá criar a NFS sem chave da Nota.
- "itensNf"
- [{
- "movimento": "",
- "unidadeNegocio": "",
- "tipoOperacao": "",
- "dataMovimento": "",
- "codigoMaterial": "",
- "especif1": "",
- "especif2": "",
- "centroArmazenagem": "",
- "grade": "",
- "quantidade": "",
- "pecas": "",
- "precoUnitario": "",
- "descricao": "",
- "documento": "",
- "empresa": "",
- "contaGerencial": "",
- "tipoDocumento": "",
- "tabelaPreco": "",
- "incidenciaISS": "",
- "percentualISS": "",
- "percentualReducaoISS": "",
- "baseISS": "",
- "valorISS": "",
- "baseIRRF": "",
- "valorIRRF": "",
- "baseINSS": "",
- "valorINSS": "",
- "percentualReducaoINSS": "",
- "percentualINSSAdicional": "",
- "percentualImpImportacao": "",
- "tipoNota": "",
- "baseICMS": "",
- "ICMSIsenta": "",
- "ICMSOutros": "",
- "baseIPI": "",
- "IPIIsenta": "",
- "IPIOutras": "",
- "percentualPISRetencao": "",
- "percentualCOFINSRetencao": "",
- "percentualCSLLRetencao": "",
- "percentualFunrural": "",
- "valorFunrural": "",
- "valorSimbahia": "",
- "serie": "",
- "notaFiscal": "",
- "CFOP": "",
- "percentualICMS": "",
- "basePIS": "",
- "valorPIS": "",
- "baseCOFINS": "",
- "valorCOFINS": "",
- "basePISRetencao": "",
- "valorPISRetencao": "",
- "baseCOFINSRetencao": "",
- "valorCOFINSRetencao": "",
- "baseCSLLRetencao": "",
- "valorCSLLRetencao": "",
- "valorImpImportacao": "",
- "percentualSimbahia": "",
- "percentualSuframa": "",
- "baseSimbahia": "",
- "baseSuframa": "",
- "baseImpImportacao": "",
- "baseFunrural": "",
- "codigoTipoDocumento": "",
- "percReducaoIPI": "",
- "percReducaoST": "",
- "percIGI": "",
- "percICMS_IGI": "",
- "ICMSDiferido": "",
- "baseIGI": "",
- "retencaoInformada": "",
- "complementoIncidIPI": "",
- "ICMSPresumido": "",
- "CSTPIS": "",
- "CSTCOFINS": "",
- "codBaseCreditoPisCofinsEntrad": "",
- "impostosAjustados": "",
- "sequenciaNota": "",
- "valorIGI": "",
- "baseSubtituicaoObs": "",
- "valorSubstituicaoObs": "",
- "freteInternacional": "",
- "seguroInternacional": "",
- "descontoISS": "",
- "valorContabil": "",
- "incidenciaIPI": "",
- "incidenciaICMS": "",
- "incidenciaPIS": "",
- "incidenciaCOFINS": "",
- "incidenciaICMSEntrada": "",
- "complementoIncidenciaICMS": "",
- "incidenciaContribSocial": "",
- "percentualIPI": "",
- "percentualIRRF": "",
- "percentualDesconto": "",
- "valorICMS": "",
- "valorIPI": "",
- "percentualComissao": "",
- "valorDesconto": "",
- "valorFrete": "",
- "baseSubstituicao": "",
- "percentualSubstituicao": "",
- "valorSuframaSimbahia": "",
- "percentualINSS": "",
- "percentualReducaoSimbahia": "",
- "percentualPIS": "",
- "percentualCreditoPISCOFINS": "",
- "reducaoICMSISS": "",
- "valorBaseSubstituicao": "",
- "percentualICMSSubstituicao": "",
- "valorIPIObs": "",
- "valorSeguro": "",
- "percentualCOFINS": "",
- "transfCentroArmaz": "",
- "estorno": "",
- "pedidoOc": "",
- "indice": "",
- "ordenacao": "",
- "transfUnNegocio": "",
- "contrato": "",
- "contabil": "",
- "codigoRetorno": "",
- "contabilidade": "",
- "excecaoNCM": "",
- "etiquetaHex": "",
- "inspecao": "",
- "classePedidoExclusivo4": "",
- "saidaSemSaldo": "",
- "usrmovi2": "",
- "valorSubstituicao": "",
- "totalDespesaItem": "",
- "totalCompras": "",
- "precoTotalCusto": "",
- "totalEntradas": "",
- "custoMedio": "",
- "totalEstoque": "",
- "percentualContribSocial": "",
- "outrasDespesasAcessorias": "",
- "difAliquotaPercImportacao": "",
- "valorEncargosFinanceiros": "",
- "valorICMSOutrosNaoDestacado": "",
- "totalEntradasIndepCA": "",
- "totalSaidasIndepCA": "",
- "totalSaidas": "",
- "usrmovi4": "",
- "contraPartTransferencia": "",
- "sequenciaDia": "",
- "sequenciaPedidoOC": "",
- "itemOS": "",
- "sequenciaDiaPedidoOC": "",
- "os": "",
- "dataValidacao": "",
- "usrmovi3": "",
- "baseICMSComIPI": "",
- "aglitinouConverteu": "",
- "buscarRegraFiscal": "",
- "impostoImportacao": "",
- "descontoInformado": "",
- "valorIcmsStFcp": "",
- "baseDifal": "",
- "valorDifalOrigem": "",
- "valorDifalDestino": "",
- "percentualDifalOrigem": "",
- "percentualDifalDestino": "",
- "proporcaoDifal": "",
- "usrmovimp2": "",
- "usrmovimp1": "",
- "valorAcrescimo": "",
- "grades":
- [{
- "movimento": "",
- "numeracao": "",
- "codigoEspecif3": "",
- "lote": "",
- "quantidade": "",
- "validadeLote": "",
- "sequencia": "",
- }],
- "comissoesItem":
- [{
- "nf": "",
- "serie": "",
- "unidadeDeNegocio": "",
- "clienteFornecedor": "",
- "especieNF": "",
- "sequenciaNF": "",
- "representante": "",
- "valorBaseComissao": "",
- "percentualComissao": "",
- "tipoBaseComissao": "",
- "percComissaoOrigRepresentante": "",
- "percentualReducaoBaseComissao": "",
- "lancamentoComissao": "",
- "origem": "",
- }],
- "unidadeNegocioItemReferencia": "",
- "serieItemReferencia": "",
- "notaItemReferencia": "",
- "empresaItemReferencia": "",
- "tipoItemReferencia": "",
- "sequenciaNfItemReferencia": "",
- "tipoOperacaoItemReferencia": "",
- ]}
- "comissoesNf":
- [{
- "nf": "",
- "serie": "",
- "unidadeDeNegocio": "",
- "clienteFornecedor": "",
- "especieNF": "",
- "sequenciaNF": "",
- "representante": "",
- "valorBaseComissao": "",
- "percentualComissao": "",
- "tipoBaseComissao": "",
- "percComissaoOrigRepresentante": "",
- "percentualReducaoBaseComissao": "",
- "lancamentoComissao": "",
- "origem": "",
- }],
- "parcelasNf"
- [{
- "nf": "",
- "serie": "",
- "unidadeNegocio": "",
- "vencimento": "",
- "valorParcela": "",
- "nossoNumero": "",
- "codigoCaixa": "",
- "turnoSequencial": "",
- "sessaoCaixa": "",
- "modeloLancamento": "",
- }],
- "lancamentosNf"
- [{
- "lancamento": "",
- "data": "",
- "vencimento": "",
- "fatura": "",
- "complemento": "",
- "codHistorico": "",
- "historico": "",
- "conta": "",
- "tipo": "",
- "valor": "",
- "cdEmpresa": "",
- "cdCobranca": "",
- "cheque": "",
- "cdPortador": "",
- "emissao": "",
- "cPartida": "",
- "saldo": "",
- "conferido": "",
- "situacao": "",
- "conciliado": "",
- "contabilizado": "",
- "tipoPagamento": "",
- "numeroBanco": "",
- "jurosDia": "",
- "ultimaLiquidacao": "",
- "documento": "",
- "tipoDocumento": "",
- "valorIndexado": "",
- "saldoIndexado": "",
- "toleranciaVenc": "",
- "valorMulta": "",
- "toleranciaMulta": "",
- "toleranciaJuros": "",
- "tipoJuros": "",
- "valorDesconto": "",
- "lancVinculado": "",
- "dataInclusao": "",
- "sacadorAvalista": "",
- "modalidadeVenc": "",
- "modalidadePag": "",
- "especieDoc": "",
- "vencOriginal": "",
- "projeto": "",
- "multRemessaEnviada": "",
- "indice": "",
- "bloqImpresso": "",
- "duplImpresso": "",
- "remessaEnviada": "",
- "autorizadoPor": "",
- "autorizadoEm": "",
- "dataModif": "",
- "sessao": "",
- "dataCompensBco": "",
- "dataFaturamentoCtr": "",
- "dataValidacao": "",
- "remessaSerasa": "",
- "adiantRetornCobran": "",
- "formaCobranCtr": "",
- "comandoRemessa": "",
- "ordemEnderCobran": "",
- "tipoMulta": "",
- "pagamento": "",
- "listarIss": "",
- "codigoBarrasLido": "",
- "dataDirf": "",
- "cdCaixa": "",
- "turnoSequencial": "",
- "ordemContaCorrente": "",
- "previsao": "",
- "listarDirf": "",
- "possuiChequesTitulo": "",
- "ctrSequencia": "",
- "limitMultaFracio": "",
- "valorCustoAdmin": "",
- "conciliacaoSeq": "",
- "percentIss": "",
- "sessaoCaixa": "",
- "autoriPlacaGnre": "",
- "userLancto1": "",
- "userLancto2": "",
- "userLancto3": "",
- "cheque"
- [{
- "numero": "",
- "sequencia": "",
- "lancamentoVinculado": "",
- "lancamentoOrigPartRel": "",
- "lancamentoTrocaCheque": "",
- "vinculadoDadosPreenchido": "",
- "conta": "",
- "titulo": "",
- "cpfCnpj": "",
- "fone": "",
- "usrinchelan1": "",
- "banco": "",
- "agencia": "",
- "codigoSacado": "",
- "modeloLancamento": "",
- "vinculadoContaFinancei": "",
- "vinculadoOcorrencia": "",
- "div1div2div3": "",
- "digitoVerificador": "",
- "tipoPagamento": "",
- "vinculadoTipoPagamento": "",
- "vinculadoPortador": "",
- "camaraCompensacao": "",
- "vinculadoHistorico": "",
- "complementoNome1": "",
- "complementoNome2": "",
- "nome": "",
- "valor": "",
- "lancamentoDevolucao": "",
- "partesRelSaida": "",
- "remessaCustodiaEnviada": "",
- "usrinchelan3": "",
- "emissao": "",
- "vencimento": "",
- "devolucao": "",
- "dataValidacao": "",
- "usrinchelan2": "",
- }],
- "lancamentoTerceiro": "",
- "nsuAutenticacaoBancaria": "",
- "autorizacaoCartao": "",
- }],
- "formasPagamentoNf"
- [{
- "pagamentoTroco": "",
- "sequencia": "",
- "condPagamento": "",
- "formaCondicao": "",
- "tipoPagamento": "",
- "formaPagamento": "",
- "empresa": "",
- "cobranca": "",
- "ordemEndCobran": "",
- "tipoDocumento": "",
- "documento": "",
- "primeiroVenctoSemAjuste": "",
- "fatura": "",
- "valorBruto": "",
- "vlrMercadFaturadas": "",
- "vlrServFaturados": "",
- "vlrDescItensFaturados": "",
- "vlrIpi": "",
- "vlrIcms": "",
- "vlrSubsTribut": "",
- "valorIrrf": "",
- "vlrOutrosImpSomamFatu": "",
- "vlrOutrosImpDiminueFa": "",
- "vlrFrete": "",
- "vlrSeguro": "",
- "vlrDescGeral": "",
- "percDescAteVencto": "",
- "vlrEncarFinanc": "",
- "tipoPagEntrada": "",
- "formaDePagEntrada": "",
- "empresaEntrada": "",
- "cobrancaEntrada": "",
- "ordemEndCobraEnt": "",
- "tipoDocEntrada": "",
- "docEntrada": "",
- "vlrEntrada": "",
- "vlrJuros": "",
- "vlrOutrasDespAcess": "",
- "vlrLiquido": "",
- "VlrTarifCartao": "",
- "prazoMedio": "",
- "LanctoCompetenciaVal": "",
- "usuCriacao": "",
- "dtCriacao": "",
- "hrCriacao": "",
- "usuModif": "",
- "dtModif": "",
- "hrModif": "",
- "gerouFinanc": "",
- "moduloOrig": "",
- "vlrLancamento": "",
- }],
- "buscouNfDaSerie": "",
- "valorContabil": "",
- "totalizarImpostoCapa": "",
- "idEnvioSat": "",
- "idCancelamentoSat": "",
- }]
- }
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.
{"minExpandLevel":2}
- pin:
- Obrigatório, Tipo: String 20
- nf:
- serie:
- codigoUnidadeNegocio:
{"minExpandLevel":2}
- <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>
{"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": "..........."
- }
- ]
RegistrarNotaFiscalInutilizada
Método que tem por finalidade registrar as numerações de NFe inutilizadas no ERP CIGAM.
{"minExpandLevel":2}
- pin
- 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
- horaRecibo
- numeroProtocolo
- Obrigatório, Tipo: String 15A
- Retorno informado em nProt
- xmlEnvio
- Obrigatório, Tipo: Blob
- Xml de Envio
- xmlRetorno
- Obrigatório, Tipo: Blob
- XML de Retorno
- chaveAcesso
- Obrigatório, Tipo: String 41A
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.
<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>
ListarPendentes
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- acao
- Tipo: String 1
- C=Cadastrar, E=Excluir
- Se for informado algo diferente de C ou E não será aplicado nenhum filtro
- statusRegistro
- Tipo: String 1
- L=Liberado, P=Pendente
- Se for informado algo diferente de P ou L não será aplicado nenhum filtro.
Retorno:
Se sucesso:
{"minExpandLevel":2}
- idRegistro
- acao
- statusRegistro
- dataRequisicao
- horaRequisicao
- idCorrelato
- codigoPedido
- codigoCliente
- codigoTipoOperacao
- emissao
- situacao
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.
ListarNotasFiscais
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- nf
- serie
- codigoUnidadeNegocio
- tipoOperacao
- codigoCliente
- codigoRepresentante
- tipoNota
- Tipo: String 1
- N=Normal, D=Devolução,T=Transferência, C=Complementar, I=Importação, S=Sessão de Crédito ICMS, M=Mapa Resumo,
- B=Brinde, F=Frete/Conhecimento, G=Garantia/Troca, E=Entrega Futura, V=Venda a Ordem, R=Remessa, 1=Genérico, 2=Genérico,
- 3=Genérico, 4=Genérico, 5=Genérico, A=Beneficiamento, H=Conserto, J=Consignação, K=Demonstração, O=Remessa 1,
- P=Remessa 2, Q=Remessa 3, U=Correção, 6=Importação Drawback, 7=Normal Drawback, 8=Genérico, 9=Genérico, 0=Genérico,
- W=Genérico, X=Genérico, Y=Genérico, Z=Genérico, L=Genérico
- codigoTransportadora
- dataEmissaoInicial
- dataEmissaoFinal
Retorno:
Se sucesso:
- Distribuição das Tags XML:
{"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>
- Distribuição das Tags Json:
{"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"
- }
- }]
- }
- }]
- }
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.
ListarId
LiberarPendentes
ListarNotasFiscaisPaf
ListarComissoesPorRepresentante
