Nota Fiscal Saída

notaFiscalSaida

Obter Listagem de Notas Fiscais de Saída

get

https://localhost/comercial/v10http://localhost/comercial/v10

/notaFiscalSaida

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de consulta

continuationTokenstring · anulávelOpcional

Identificador da Paginação da Consulta

tipoNotainteger[] · anulávelOpcional

Lista de código do Tipo de Nota

dataEmissaoIniciostring · anulávelOpcional

Data de Emissão Inicial da Nota Fiscal (YYYY-MM-DD)

dataEmissaoFimstring · anulávelOpcional

Data de Emissão Final da Nota Fiscal (YYYY-MM-DD)

clientesstring[] · anulávelOpcional

Lista de Código de Cliente

statusNFeinteger[] · anulávelOpcional

Lista de Status da Nota Fiscal Eletrônica

mascarasinteger[] · anulávelOpcional

Código da Máscara do Produto

tipoFiltroMascarainteger · anulávelOpcional

Tipo do Filtro da Máscara do Produto: 1 - Desconsiderar Nota Fiscal, 2 - Considerar Nota Fiscal

pedidosstring[] · anulávelOpcional

Lista de Código de Pedido

paginacaointeger · anulávelOpcional

Quantidade de Notas Fiscais na Paginação de Retorno

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

OK

application/json

continuationTokenstringOpcional

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/notaFiscalSaida

HTTPcURLJavaScriptPython

GET /comercial/v10/notaFiscalSaida?situacao=1 HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "continuationToken": "text",
  "data": [
    {
      "dataEmissao": "2026-05-08",
      "codNumNota": 1,
      "serie": 1,
      "codTipoDeNota": 1,
      "codCliente": 1,
      "codRepresentante": 1,
      "codPedido": "text",
      "percDesconto": 1,
      "valorFrete": 1,
      "valorSeguro": 1,
      "valorLiquido": 1,
      "valorIPI": 1,
      "valorTotal": 1,
      "valorDescNormal": 1,
      "codNatOperacao": 1,
      "situacao": 1,
      "baseCalcIPI": 1,
      "valorICMSnaoPagoReduc": 1,
      "valorICMSSubstit": 1,
      "valorICMSIsentas": 1,
      "valorIPIIsentas": 1,
      "valorOutrasDespesas": 1,
      "baseICMSSubs": 1,
      "deducICMSNFManaus": 1,
      "percISS": 1,
      "valorISS": 1,
      "valorPIS": 1,
      "valorCOFINS": 1,
      "basePIS": 1,
      "baseCofins": 1,
      "baseRetPIS": 1,
      "valorRetPIS": 1,
      "baseRetCOFINS": 1,
      "valorRetCOFINS": 1,
      "valorPISZF": 1,
      "valorCOFINSZF": 1,
      "valorDifAliq": 1,
      "baseRetCSSL": 1,
      "valorRetCSSL": 1,
      "baseRetIR": 1,
      "valorRetIR": 1,
      "baseRet": 1,
      "valorFECP": 1,
      "percRetencaoPIS": 1,
      "percRetencaoCOFINS": 1,
      "percRetencaoCSSL": 1,
      "percRetencaoIR": 1,
      "baseISS": 1,
      "valorReducaoISS": 1,
      "codCnae": "text",
      "atendimentoPresencial": 0,
      "valFCP": 1,
      "valICMSDest": 1,
      "valICMSRem": 1,
      "IPIDevol": 1,
      "valorFCPST": 1,
      "valorFCPICMS": 1,
      "tipoFrete": 1,
      "codTransportadora": 1,
      "pesoBruto": 1,
      "pesoLiquido": 1,
      "qtdVolumes": 1,
      "especieVolumes": "text",
      "dataHoraSaida": "2026-05-08T23:26:48.877Z",
      "codTabela": 1,
      "placaVeiculo": "text",
      "codEstPlacaVeic": "text",
      "consumidorFinal": 0,
      "codPortador": 1,
      "codTipoCobranca": 1,
      "marca": "text",
      "numeroVolume": "text",
      "dataHoraGeracaoNF": "2026-05-08T23:26:48.877Z",
      "obsCancNF1": "text",
      "obsCancNF2": "text",
      "obsCancNF3": "text",
      "dataGeracao1": "2026-05-08T23:26:48.877Z",
      "chaveAcesso": "text",
      "dataHoraNfe": "2026-05-08T23:26:48.877Z",
      "protNfe": "text",
      "statusNfe": "text",
      "codLote": "text",
      "dataHoraDanfe": "2026-05-08T23:26:48.877Z",
      "dataHoraCancelaNfe": "2026-05-08T23:26:48.877Z",
      "protCancelaNfe": "text",
      "statusCancelaNfe": "text",
      "tipoEmissaoNfe": 1,
      "emailNfe": "text",
      "flagReplicado": true,
      "baseComissaoAtendente": 1,
      "valorComissaoAtendente": 1,
      "valorDescEspecPropCapa": 1,
      "valorComissaoRepresentante": 1,
      "percComissaoRepresentante": 1,
      "baseComissaoRepresentante": 1,
      "itensNotaFiscalSaida": [
        {
          "codItem": 1,
          "codProduto": "text",
          "qtdFaturada": 1,
          "precoUnitario": 1,
          "valorItem": 1,
          "valorIPI": 1,
          "valorDesconto": 1,
          "codItemPedido": 1,
          "codClassifFiscal": "text",
          "codGrupo": "text",
          "percICMS": 1,
          "valorICMS": 1,
          "percICMSSubst": 1,
          "valorICMSSubstituto": 1,
          "margemLucro": 1,
          "percReducICMS": 1,
          "pesoLiquido": 1,
          "codSitTributICMS": "text",
          "percIPI": 1,
          "codNatOperacao": 1,
          "vlrDescICMSZonaFranca": 1,
          "baseCalcICMS": 1,
          "baseCalcICMSIsenta": 1,
          "baseCalcICMSOutra": 1,
          "baseCalcIPI": 1,
          "baseCalcIPIIsenta": 1,
          "baseCalcIPIOutra": 1,
          "codSitTributIPI": "text",
          "valorDescNaoIncideICMS": 1,
          "baseCalcSTPIS": 1,
          "valorSTPIS": 1,
          "baseCalcSTCOFINS": 1,
          "valorSTCOFINS": 1,
          "valorFreteProp": 1,
          "valorSeguroProp": 1,
          "valorDespAcesProp": 1,
          "valorPISProp": 1,
          "valorCOFINSProp": 1,
          "percPIS": 1,
          "percCOFINS": 1,
          "baseCalcICMSSubst": 1,
          "basePIS": 1,
          "baseCofins": 1,
          "valorPISZF": 1,
          "valorCOFINSZF": 1,
          "valorIPIDescAcess": 1,
          "situaICMS": 0,
          "codCSTPis": "text",
          "codCSTCofins": "text",
          "valorBaseSTRetAnt": 1,
          "valorSTRetAnt": 1,
          "perCreditoIcms": 1,
          "valorCreditoIcms": 1,
          "perReducaoPis": 1,
          "perReducaoCofins": 1,
          "valorDiferencaPis": 1,
          "valorDiferencaCofins": 1,
          "reducaoBaseIcmsST": 1,
          "codCSTCSOSN": "text",
          "numeroPedidoCompra": "text",
          "itemPedidoCompra": 1,
          "aliquotaPIS": 1,
          "aliquotaCOFINS": 1,
          "valorDespesasBaseIcms": 1,
          "codEnquadramentoIPI": 1,
          "baseICMSUFDestino": 1,
          "percFCP": 1,
          "aliqUFDest": 1,
          "aliICMSInt": 1,
          "valorICMSInterestUFDest": 1,
          "valorFCP": 1,
          "valorDescPropTroca": 1,
          "valorDescEspecPropCapa": 1,
          "valorAcrescimo": 1,
          "baseComissaoAtendente": 1,
          "percComissaoAtendente": 1,
          "valorComissaoAtendente": 1,
          "baseComissaoRepresentante": 1,
          "percComissaoRepresentante": 1,
          "valorComissaoRepresentante": 1,
          "cBenef": "text",
          "cCredPresumido": "text",
          "pCredPresumido": 1,
          "vCredPresumido": 1,
          "valorBaseIBSCBS": 1,
          "aliquotaIBSEstadual": 1,
          "valorIBSEstadual": 1,
          "aliquotaIBSMunicipal": 1,
          "valorIBSMunicipal": 1,
          "aliquotaCBS": 1,
          "valorCBS": 1,
          "cClassTribIBSCBS": "text",
          "cstIBSCBS": "text",
          "valorBaseIS": 1,
          "aliquotaIS": 1,
          "valorIS": 1,
          "itemPedidoAgrupado": [
            {
              "codPedido": "text",
              "itemPedido": 1,
              "qtdFaturadaItemPedido": 1
            }
          ],
          "dadosCustomizados": [
            {
              "campo": "text",
              "valor": "text"
            }
          ]
        }
      ],
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ]
}

Cadastrar uma Nota Fiscal de Saída

put

https://localhost/comercial/v10http://localhost/comercial/v10

/notaFiscalSaida

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

application/json

dataEmissaostring · dateObrigatório

Data de Emissão da Nota Fiscal (YYYY-MM-DD)

codNumNotainteger · máx: 9999999Obrigatório

Código Numérico da Nota

codTipoDeNotainteger · máx: 9999Opcional

Código do Tipo de Nota

codClienteinteger · máx: 9999999Opcional

Código do Cliente

codRepresentanteinteger · máx: 9999Opcional

Código do Representante

percDescontonumberOpcional

Percentual de Desconto

valorFretenumberOpcional

Valor do Frete

valorSeguronumberOpcional

Valor do Seguro

valorLiquidonumberOpcional

Valor Liquido da Nota Fiscal

valorIPInumberOpcional

Valor do IPI

valorTotalnumberOpcional

Valor Total da Nota Fiscal

valorDescNormalnumberOpcional

Valor do Desconto Normal

codNatOperacaointeger · máx: 99999Opcional

Código da Natureza de Operação

situacaointeger · enumOpcional

Situação da Nota Fiscal (1 - Gerada, 2 - Emitida, 3 - Cancelada)

Valores possíveis:

baseCalcIPInumberOpcional

Base de Cálculo do IPI

valorICMSnaoPagoReducnumberOpcional

Valor do ICMS não Pago Redução

valorICMSSubstitnumberOpcional

Valor do ICMS Substituto

valorICMSIsentasnumberOpcional

Valor do ICMS Isentas

valorIPIIsentasnumberOpcional

Valor do IPI Isentas

valorOutrasDespesasnumberOpcional

Valor de Outras Despesas

baseICMSSubsnumberOpcional

Base do ICMS Substituto

deducICMSNFManausnumberOpcional

Dedução do ICMS para Manaus

percISSnumberOpcional

Percentual do ISS

valorISSnumberOpcional

Valor do ISS

valorPISnumberOpcional

Valor do PIS

valorCOFINSnumberOpcional

Valor do COFINS

basePISnumberOpcional

Base do PIS

baseCofinsnumberOpcional

Base do COFINS

baseRetPISnumberOpcional

Base de Retenção do PIS

valorRetPISnumberOpcional

Valor de Retenção do PIS

baseRetCOFINSnumberOpcional

Base de Retenção do COFINS

valorRetCOFINSnumberOpcional

Valor de Retenção do COFINS

valorPISZFnumberOpcional

Valor do PISZF

valorCOFINSZFnumberOpcional

Valor do COFINSZF

valorDifAliqnumberOpcional

Valor da Diferença da Aliquota

baseRetCSSLnumberOpcional

Base de Retenção do CSSL

valorRetCSSLnumberOpcional

Valor de Retenção do CSSL

baseRetIRnumberOpcional

Base de Retenção do IR

valorRetIRnumberOpcional

Valor de Retenção do IR

baseRetnumberOpcional

Base de Retenção

valorFECPnumberOpcional

Valor de Retenção do FECP

percRetencaoPISnumberOpcional

Percentual de Retenção do PIS

percRetencaoCOFINSnumberOpcional

Percentual de Retenção do COFINS

percRetencaoCSSLnumberOpcional

Percentual de Retenção do CSSL

percRetencaoIRnumberOpcional

Percentual de Retenção do IR

baseISSnumberOpcional

Base do ISS

valorReducaoISSnumberOpcional

Valor Redução do ISS

codCnaestring · máx: 7Opcional

Código do Cnae

atendimentoPresencialinteger · enumOpcional

Atendimento Presencial (0 - Não se aplica, 1 - Operação presencial, 2 - Operação não presencial, pela internet, 3 - Operação não presencial, Teleatendimento, 5 - Operação presencial fora do estabelecimento, 9 - Operação não presencial outros)

Valores possíveis:

valFCPnumberOpcional

Valor do FCP

valICMSDestnumberOpcional

Valor do ICMS Interestadual para a UF de Destino

valICMSRemnumberOpcional

Valor total do ICMS Interestadual para a UF do Remetente

IPIDevolnumberOpcional

Valor total do IPI Devolvido

valorFCPSTnumberOpcional

Valor do FCP/FECOEP do ST

valorFCPICMSnumberOpcional

Valor FCP ICMS

tipoFreteintegerOpcional

Tipo de Frete

codTransportadorainteger · máx: 9999Opcional

Código da Transportadora

pesoBrutonumberOpcional

Peso Bruto

pesoLiquidonumberOpcional

Peso Liquido

qtdVolumesinteger · máx: 9999999Opcional

Quantidade de Volumes

especieVolumesstring · máx: 10Opcional

Espécie dos Volumes

dataHoraSaidastring · date-timeOpcional

Data e Hora da Saída (YYYY-MM-DDTHH:mm:ss.sssZ)

codTabelainteger · máx: 99999Opcional

Código da Tabela de Preço

placaVeiculostring · máx: 10Opcional

Placa do Veículo

codEstPlacaVeicstring · máx: 10Opcional

Código do Estado da Placa do Veículo

consumidorFinalinteger · enumOpcional

É para Consumidor Final? (0 - Não, 1 - Sim)

Valores possíveis:

codPortadorinteger · máx: 9999Opcional

Código do Portador

codTipoCobrancainteger · máx: 99Opcional

Código do Tipo de Cobrança

marcastring · máx: 13Opcional

Marca

numeroVolumestring · máx: 10Opcional

Número do Volume

dataHoraGeracaoNFstring · date-timeOpcional

Data e Hora da Geração da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)

obsCancNF1string · máx: 35Opcional

Observação do Cancelamento da Nota Fiscal

obsCancNF2string · máx: 35Opcional

Complemento da Observação do Cancelamento da Nota Fiscal

obsCancNF3string · máx: 35Opcional

Complemento da Observação do Cancelamento da Nota Fiscal

dataGeracao1string · date-timeOpcional

Data e Hora do Cancelamento da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)

chaveAcessostring · mín: 44 · máx: 44Opcional

Chave de acesso da NF-e

dataHoraNfestring · date-timeOpcional

Data do processamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)

protNfestring · máx: 15Opcional

Número do Protocolo da NF-e e NFS-e

statusNfestring · máx: 3Opcional

Código do status da resposta para a NF-e e NFS-e

codLotestring · máx: 7Opcional

Identificador de Controle do Envio do Lote da NFe

dataHoraDanfestring · date-timeOpcional

Data e Hora da Emissão do DANFE (YYYY-MM-DDTHH:mm:ss.sssZ)

dataHoraCancelaNfestring · date-timeOpcional

Data e Hora do Cancelamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)

protCancelaNfestring · máx: 15Opcional

Número do Protocolo de Cancelamento da NF-e e NFS-e

statusCancelaNfestring · máx: 3Opcional

Código do status do Cancelamento NF-e e NFS-e

tipoEmissaoNfeinteger · enumOpcional

Tipo de Emissão (1 - Normal, 2 - Contingência FS (Formulário Segurança), 3 - Contingência SCAN (Sistema de Contingência Ambiente Nacional), 4 - Contingência EPEC (Evento Prévio de Emissão em Contingência), 5 - Contingência FS-DA, 6 - Contingencia SVC-AN, 7 - Contingencia SVC-RS)

Valores possíveis:

emailNfestring · máx: 50Opcional

E-mail Destinatario que foi enviado arquivo distribuição NF-e

flagReplicadobooleanOpcional

Flag se foi Replicado

CEPEntregastring · máx: 8Opcional

CEP da Entrega

codCondicaoVendaintegerOpcional

Código da Condição de Venda

msgNotaFiscalstring · máx: 1000Opcional

Mensagem para a Nota Fiscal

valorBaseCalcIPIIsentasnumberOpcional

Valor de Base de Cálculo IPI Isentas

valorBaseCalcIPIOutrasnumberOpcional

Valor de Base de Cálculo IPI Outras

valorICMSOutrasnumberOpcional

Valor de Base de Cálculo ICMS Outras

baseCalcComisRepnumberOpcional

Base de Comissão do Representante

percComissaonumberOpcional

Percentual de Comissão do Representante

valorComissaonumberOpcional

Valor da Comissão do Representante

valorDescontoEspecialCapanumberOpcional

Valor do Desconto Especial da Capa

baseComissaoAtendentenumberOpcional

Base de Cálculo de Comissão do Atendente

valorComissaoAtendentenumberOpcional

Valor de Comissão do Atendente

Respostas

200

OK

application/json

dataEmissaostring · dateOpcional

Data de Emissão da Nota Fiscal (YYYY-MM-DD)

codNumNotaintegerOpcional

Código Numérico da Nota

serieintegerOpcional

Série da Nota Fiscal

codTipoDeNotaintegerOpcional

Código do Tipo de Nota

codClienteintegerOpcional

Código do Cliente

codRepresentanteintegerOpcional

Código do Representante

codPedidostringOpcional

Código do Pedido de Venda

percDescontonumberOpcional

Percentual de Desconto

valorFretenumberOpcional

Valor do Frete

valorSeguronumberOpcional

Valor do Seguro

valorLiquidonumberOpcional

Valor Liquido da Nota Fiscal

valorIPInumberOpcional

Valor do IPI

valorTotalnumberOpcional

Valor Total da Nota Fiscal

valorDescNormalnumberOpcional

Valor do Desconto Normal

codNatOperacaointeger · máx: 99999Opcional

Código da Natureza de Operação

situacaointeger · enumOpcional

Situação da Nota Fiscal (1 - Gerada, 2 - Emitidade, 3 - Cancelada)

Valores possíveis:

baseCalcIPInumberOpcional

Base de Cálculo do IPI

valorICMSnaoPagoReducnumberOpcional

Valor do ICMS não Pago Redução

valorICMSSubstitnumberOpcional

Valor do ICMS Substituto

valorICMSIsentasnumberOpcional

Valor do ICMS Isentas

valorIPIIsentasnumberOpcional

Valor do IPI Isentas

valorOutrasDespesasnumberOpcional

Valor de Outras Despesas

baseICMSSubsnumberOpcional

Base do ICMS Substituto

deducICMSNFManausnumberOpcional

Dedução do ICMS para Manaus

percISSnumberOpcional

Percentual do ISS

valorISSnumberOpcional

Valor do ISS

valorPISnumberOpcional

Valor do PIS

valorCOFINSnumberOpcional

Valor do COFINS

basePISnumberOpcional

Base do PIS

baseCofinsnumberOpcional

Base do COFINS

baseRetPISnumberOpcional

Base de Retenção do PIS

valorRetPISnumberOpcional

Valor de Retenção do PIS

baseRetCOFINSnumberOpcional

Base de Retenção do COFINS

valorRetCOFINSnumberOpcional

Valor de Retenção do COFINS

valorPISZFnumberOpcional

Valor do PISZF

valorCOFINSZFnumberOpcional

Valor do COFINSZF

valorDifAliqnumberOpcional

Valor diferença da Aliquota

baseRetCSSLnumberOpcional

Base de Retenção do CSSL

valorRetCSSLnumberOpcional

Valor de Retenção do CSSL

baseRetIRnumberOpcional

Base de Retenção do IR

valorRetIRnumberOpcional

Valor de Retenção do IR

baseRetnumberOpcional

Base de Retenção

valorFECPnumberOpcional

Valor de Retenção do FECP

percRetencaoPISnumberOpcional

Percentual de Retenção do PIS

percRetencaoCOFINSnumberOpcional

Percentual de Retenção do COFINS

percRetencaoCSSLnumberOpcional

Percentual de Retenção do CSSL

percRetencaoIRnumberOpcional

Percentual de Retenção do IR

baseISSnumberOpcional

Base do ISS

valorReducaoISSnumberOpcional

Valor Redução do ISS

codCnaestringOpcional

Código do Cnae

atendimentoPresencialinteger · enumOpcional

Atendimento Presencial (0 - Não se aplica, 1 - Operação presencial, 2 - Operação não presencial, pela internet, 3 - Operação não presencial, Teleatendimento, 5 - Operação presencial fora do estabelecimento, 9 - Operação não presencial outros)

Valores possíveis:

valFCPnumberOpcional

Valor do FCP

valICMSDestnumberOpcional

Valor do ICMS Interestadual para a UF de Destino

valICMSRemnumberOpcional

Valor total do ICMS Interestadual para a UF do Remetente

IPIDevolnumberOpcional

Valor total do IPI Devolvido

valorFCPSTnumberOpcional

Valor do FCP/FECOEP do ST

valorFCPICMSnumberOpcional

Valor FCP ICMS

tipoFreteintegerOpcional

Tipo de Frete

codTransportadoraintegerOpcional

Código da Transportadora

pesoBrutonumberOpcional

Peso Bruto

pesoLiquidonumberOpcional

Peso Liquido

qtdVolumesintegerOpcional

Quantidade de Volumes

especieVolumesstringOpcional

Espécie dos Volumes

dataHoraSaidastring · date-timeOpcional

Data e Hora da Saída (YYYY-MM-DDTHH:mm:ss.sssZ)

codTabelaintegerOpcional

Código da Tabela de Preço

placaVeiculostringOpcional

Placa do Veículo

codEstPlacaVeicstringOpcional

Código do Estado da Placa do Veículo

consumidorFinalinteger · enumOpcional

É para Consumidor Final? (0 - Não, 1 - Sim)

Valores possíveis:

codPortadorintegerOpcional

Código do Portador

codTipoCobrancaintegerOpcional

Código do Tipo de Cobrança

marcastringOpcional

Marca

numeroVolumestringOpcional

Número do Volume

dataHoraGeracaoNFstring · date-timeOpcional

Data e Hora da Geração da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)

obsCancNF1stringOpcional

Observação do Cancelamento da Nota Fiscal

obsCancNF2stringOpcional

Complemento da Observação do Cancelamento da Nota Fiscal

obsCancNF3stringOpcional

Complemento da Observação do Cancelamento da Nota Fiscal

dataGeracao1string · date-timeOpcional

Data e Hora do Cancelamento da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)

chaveAcessostringOpcional

Chave de acesso da NF-e

dataHoraNfestring · date-timeOpcional

Data do processamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)

protNfestringOpcional

Número do Protocolo da NF-e e NFS-e

statusNfestringOpcional

Código do status da resposta para a NF-e e NFS-e

codLotestringOpcional

Identificador de controle do envio do lote da NFe

dataHoraDanfestring · date-timeOpcional

Data e Hora da Emissão do DANFE (YYYY-MM-DDTHH:mm:ss.sssZ)

dataHoraCancelaNfestring · date-timeOpcional

Data e Hora do Cancelamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)

protCancelaNfestringOpcional

Número do Protocolo de Cancelamento da NF-e e NFS-e

statusCancelaNfestringOpcional

Código do status do Cancelamento NF-e e NFS-e

tipoEmissaoNfeinteger · enumOpcional

Tipo de Emissão (1 - Normal, 2 - Contingência FS (Formulário Segurança), 3 - Contingência SCAN (Sistema de Contingência Ambiente Nacional), 4 - Contingência EPEC (Evento Prévio de Emissão em Contingência), 5 - Contingência FS-DA, 6 - Contingencia SVC-AN, 7 - Contingencia SVC-RS)

Valores possíveis:

emailNfestringOpcional

E-mail Destinatario que foi enviado arquivo distribuição NF-e

flagReplicadobooleanOpcional

Flag se foi Replicado

baseComissaoAtendentenumberOpcional

Base de Cálculo de Comissão do Atendente

valorComissaoAtendentenumberOpcional

Valor de Comissão do Atendente

valorDescEspecPropCapanumberOpcional

Valor do Desconto Especial Proporcional Capa

valorComissaoRepresentantenumberOpcional

Valor de Comissão do Representante

percComissaoRepresentantenumberOpcional

Percentual de Comissão do Representante

baseComissaoRepresentantenumberOpcional

Base de Comissão do Representante

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

put

/notaFiscalSaida

HTTPcURLJavaScriptPython

PUT /comercial/v10/notaFiscalSaida HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 4528

{
  "dataEmissao": "2026-05-08",
  "codNumNota": 1,
  "codTipoDeNota": 1,
  "codCliente": 1,
  "codRepresentante": 1,
  "percDesconto": 1,
  "valorFrete": 1,
  "valorSeguro": 1,
  "valorLiquido": 1,
  "valorIPI": 1,
  "valorTotal": 1,
  "valorDescNormal": 1,
  "codNatOperacao": 1,
  "situacao": 1,
  "baseCalcIPI": 1,
  "valorICMSnaoPagoReduc": 1,
  "valorICMSSubstit": 1,
  "valorICMSIsentas": 1,
  "valorIPIIsentas": 1,
  "valorOutrasDespesas": 1,
  "baseICMSSubs": 1,
  "deducICMSNFManaus": 1,
  "percISS": 1,
  "valorISS": 1,
  "valorPIS": 1,
  "valorCOFINS": 1,
  "basePIS": 1,
  "baseCofins": 1,
  "baseRetPIS": 1,
  "valorRetPIS": 1,
  "baseRetCOFINS": 1,
  "valorRetCOFINS": 1,
  "valorPISZF": 1,
  "valorCOFINSZF": 1,
  "valorDifAliq": 1,
  "baseRetCSSL": 1,
  "valorRetCSSL": 1,
  "baseRetIR": 1,
  "valorRetIR": 1,
  "baseRet": 1,
  "valorFECP": 1,
  "percRetencaoPIS": 1,
  "percRetencaoCOFINS": 1,
  "percRetencaoCSSL": 1,
  "percRetencaoIR": 1,
  "baseISS": 1,
  "valorReducaoISS": 1,
  "codCnae": "text",
  "atendimentoPresencial": 0,
  "valFCP": 1,
  "valICMSDest": 1,
  "valICMSRem": 1,
  "IPIDevol": 1,
  "valorFCPST": 1,
  "valorFCPICMS": 1,
  "tipoFrete": 1,
  "codTransportadora": 1,
  "pesoBruto": 1,
  "pesoLiquido": 1,
  "qtdVolumes": 1,
  "especieVolumes": "text",
  "dataHoraSaida": "2026-05-08T23:26:48.877Z",
  "codTabela": 1,
  "placaVeiculo": "text",
  "codEstPlacaVeic": "text",
  "consumidorFinal": 0,
  "codPortador": 1,
  "codTipoCobranca": 1,
  "marca": "text",
  "numeroVolume": "text",
  "dataHoraGeracaoNF": "2026-05-08T23:26:48.877Z",
  "obsCancNF1": "text",
  "obsCancNF2": "text",
  "obsCancNF3": "text",
  "dataGeracao1": "2026-05-08T23:26:48.877Z",
  "chaveAcesso": "text",
  "dataHoraNfe": "2026-05-08T23:26:48.877Z",
  "protNfe": "text",
  "statusNfe": "text",
  "codLote": "text",
  "dataHoraDanfe": "2026-05-08T23:26:48.877Z",
  "dataHoraCancelaNfe": "2026-05-08T23:26:48.877Z",
  "protCancelaNfe": "text",
  "statusCancelaNfe": "text",
  "tipoEmissaoNfe": 1,
  "emailNfe": "text",
  "flagReplicado": true,
  "CEPEntrega": "text",
  "codCondicaoVenda": 1,
  "msgNotaFiscal": "text",
  "valorBaseCalcIPIIsentas": 1,
  "valorBaseCalcIPIOutras": 1,
  "valorICMSOutras": 1,
  "baseCalcComisRep": 1,
  "percComissao": 1,
  "valorComissao": 1,
  "valorDescontoEspecialCapa": 1,
  "baseComissaoAtendente": 1,
  "valorComissaoAtendente": 1,
  "duplicatas": [
    {
      "tipoPagamento": "boleto",
      "dataEmissao": "2026-05-08",
      "qtdParcela": 1,
      "codPortador": 1,
      "tipoCobranca": 1,
      "condicaoVenda": 1,
      "parcela": [
        {
          "valor": 1,
          "dataVencimento": "2026-05-08",
          "dataPagamento": "2026-05-08",
          "numeroBancario": "text",
          "codAutorizacao": "text",
          "codNSU": "text",
          "baseComissaoAtendente": 1,
          "valorComissaoAtendente": 1,
          "baseComissaoRepresentante": 1,
          "percComissaoRepresentante": 1,
          "valorComissaoRepresentante": 1
        }
      ]
    }
  ],
  "itensNotaFiscalSaida": [
    {
      "codItem": 1,
      "codProduto": "text",
      "qtdFaturada": 1,
      "precoUnitario": 1,
      "valorItem": 1,
      "valorIPI": 1,
      "valorDesconto": 1,
      "codItemPedido": 1,
      "codClassifFiscal": "text",
      "codGrupo": "text",
      "percICMS": 1,
      "valorICMS": 1,
      "percICMSSubst": 1,
      "valorICMSSubstituto": 1,
      "margemLucro": 1,
      "percReducICMS": 1,
      "pesoLiquido": 1,
      "codSitTributICMS": "text",
      "percIPI": 1,
      "codNatOperacao": 1,
      "vlrDescICMSZonaFranca": 1,
      "baseCalcICMS": 1,
      "baseCalcICMSIsenta": 1,
      "baseCalcICMSOutra": 1,
      "baseCalcIPI": 1,
      "baseCalcIPIIsenta": 1,
      "baseCalcIPIOutra": 1,
      "codSitTributIPI": "text",
      "valorDescNaoIncideICMS": 1,
      "baseCalcSTPIS": 1,
      "valorSTPIS": 1,
      "baseCalcSTCOFINS": 1,
      "valorSTCOFINS": 1,
      "valorFreteProp": 1,
      "valorSeguroProp": 1,
      "valorDespAcesProp": 1,
      "valorPISProp": 1,
      "valorCOFINSProp": 1,
      "percPIS": 1,
      "percCOFINS": 1,
      "baseCalcICMSSubst": 1,
      "basePIS": 1,
      "baseCofins": 1,
      "valorPISZF": 1,
      "valorCOFINSZF": 1,
      "valorIPIDescAcess": 1,
      "situaICMS": 0,
      "codCSTPis": "text",
      "codCSTCofins": "text",
      "valorBaseSTRetAnt": 1,
      "valorSTRetAnt": 1,
      "perCreditoIcms": 1,
      "valorCreditoIcms": 1,
      "perReducaoPis": 1,
      "perReducaoCofins": 1,
      "valorDiferencaPis": 1,
      "valorDiferencaCofins": 1,
      "reducaoBaseIcmsST": 1,
      "codCSTCSOSN": "text",
      "numeroPedidoCompra": "text",
      "itemPedidoCompra": 1,
      "aliquotaPIS": 1,
      "aliquotaCOFINS": 1,
      "valorDespesasBaseIcms": 1,
      "codEnquadramentoIPI": 1,
      "baseICMSUFDestino": 1,
      "percFCP": 1,
      "aliqUFDest": 1,
      "aliICMSInt": 1,
      "valorICMSInterestUFDest": 1,
      "valorFCP": 1,
      "valorDescPropTroca": 1,
      "valorDescEspecPropCapa": 1,
      "valorAcrescimo": 1,
      "baseComissaoAtendente": 1,
      "percComissaoAtendente": 1,
      "valorComissaoAtendente": 1,
      "baseComissaoRepresentante": 1,
      "percComissaoRepresentante": 1,
      "valorComissaoRepresentante": 1,
      "cBenef": "text",
      "cCredPresumido": "text",
      "pCredPresumido": 1,
      "vCredPresumido": 1,
      "valorBaseIBSCBS": 1,
      "aliquotaIBSEstadual": 1,
      "valorIBSEstadual": 1,
      "aliquotaIBSMunicipal": 1,
      "valorIBSMunicipal": 1,
      "aliquotaCBS": 1,
      "valorCBS": 1,
      "cClassTribIBSCBS": "text",
      "cstIBSCBS": "text",
      "valorBaseIS": 1,
      "aliquotaIS": 1,
      "valorIS": 1,
      "itemPedidoAgrupado": [
        {
          "codPedido": "text",
          "itemPedido": 1,
          "qtdFaturadaItemPedido": 1
        }
      ],
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

{
  "dataEmissao": "2026-05-08",
  "codNumNota": 1,
  "serie": 1,
  "codTipoDeNota": 1,
  "codCliente": 1,
  "codRepresentante": 1,
  "codPedido": "text",
  "percDesconto": 1,
  "valorFrete": 1,
  "valorSeguro": 1,
  "valorLiquido": 1,
  "valorIPI": 1,
  "valorTotal": 1,
  "valorDescNormal": 1,
  "codNatOperacao": 1,
  "situacao": 1,
  "baseCalcIPI": 1,
  "valorICMSnaoPagoReduc": 1,
  "valorICMSSubstit": 1,
  "valorICMSIsentas": 1,
  "valorIPIIsentas": 1,
  "valorOutrasDespesas": 1,
  "baseICMSSubs": 1,
  "deducICMSNFManaus": 1,
  "percISS": 1,
  "valorISS": 1,
  "valorPIS": 1,
  "valorCOFINS": 1,
  "basePIS": 1,
  "baseCofins": 1,
  "baseRetPIS": 1,
  "valorRetPIS": 1,
  "baseRetCOFINS": 1,
  "valorRetCOFINS": 1,
  "valorPISZF": 1,
  "valorCOFINSZF": 1,
  "valorDifAliq": 1,
  "baseRetCSSL": 1,
  "valorRetCSSL": 1,
  "baseRetIR": 1,
  "valorRetIR": 1,
  "baseRet": 1,
  "valorFECP": 1,
  "percRetencaoPIS": 1,
  "percRetencaoCOFINS": 1,
  "percRetencaoCSSL": 1,
  "percRetencaoIR": 1,
  "baseISS": 1,
  "valorReducaoISS": 1,
  "codCnae": "text",
  "atendimentoPresencial": 0,
  "valFCP": 1,
  "valICMSDest": 1,
  "valICMSRem": 1,
  "IPIDevol": 1,
  "valorFCPST": 1,
  "valorFCPICMS": 1,
  "tipoFrete": 1,
  "codTransportadora": 1,
  "pesoBruto": 1,
  "pesoLiquido": 1,
  "qtdVolumes": 1,
  "especieVolumes": "text",
  "dataHoraSaida": "2026-05-08T23:26:48.877Z",
  "codTabela": 1,
  "placaVeiculo": "text",
  "codEstPlacaVeic": "text",
  "consumidorFinal": 0,
  "codPortador": 1,
  "codTipoCobranca": 1,
  "marca": "text",
  "numeroVolume": "text",
  "dataHoraGeracaoNF": "2026-05-08T23:26:48.877Z",
  "obsCancNF1": "text",
  "obsCancNF2": "text",
  "obsCancNF3": "text",
  "dataGeracao1": "2026-05-08T23:26:48.877Z",
  "chaveAcesso": "text",
  "dataHoraNfe": "2026-05-08T23:26:48.877Z",
  "protNfe": "text",
  "statusNfe": "text",
  "codLote": "text",
  "dataHoraDanfe": "2026-05-08T23:26:48.877Z",
  "dataHoraCancelaNfe": "2026-05-08T23:26:48.877Z",
  "protCancelaNfe": "text",
  "statusCancelaNfe": "text",
  "tipoEmissaoNfe": 1,
  "emailNfe": "text",
  "flagReplicado": true,
  "baseComissaoAtendente": 1,
  "valorComissaoAtendente": 1,
  "valorDescEspecPropCapa": 1,
  "valorComissaoRepresentante": 1,
  "percComissaoRepresentante": 1,
  "baseComissaoRepresentante": 1,
  "itensNotaFiscalSaida": [
    {
      "codItem": 1,
      "codProduto": "text",
      "qtdFaturada": 1,
      "precoUnitario": 1,
      "valorItem": 1,
      "valorIPI": 1,
      "valorDesconto": 1,
      "codItemPedido": 1,
      "codClassifFiscal": "text",
      "codGrupo": "text",
      "percICMS": 1,
      "valorICMS": 1,
      "percICMSSubst": 1,
      "valorICMSSubstituto": 1,
      "margemLucro": 1,
      "percReducICMS": 1,
      "pesoLiquido": 1,
      "codSitTributICMS": "text",
      "percIPI": 1,
      "codNatOperacao": 1,
      "vlrDescICMSZonaFranca": 1,
      "baseCalcICMS": 1,
      "baseCalcICMSIsenta": 1,
      "baseCalcICMSOutra": 1,
      "baseCalcIPI": 1,
      "baseCalcIPIIsenta": 1,
      "baseCalcIPIOutra": 1,
      "codSitTributIPI": "text",
      "valorDescNaoIncideICMS": 1,
      "baseCalcSTPIS": 1,
      "valorSTPIS": 1,
      "baseCalcSTCOFINS": 1,
      "valorSTCOFINS": 1,
      "valorFreteProp": 1,
      "valorSeguroProp": 1,
      "valorDespAcesProp": 1,
      "valorPISProp": 1,
      "valorCOFINSProp": 1,
      "percPIS": 1,
      "percCOFINS": 1,
      "baseCalcICMSSubst": 1,
      "basePIS": 1,
      "baseCofins": 1,
      "valorPISZF": 1,
      "valorCOFINSZF": 1,
      "valorIPIDescAcess": 1,
      "situaICMS": 0,
      "codCSTPis": "text",
      "codCSTCofins": "text",
      "valorBaseSTRetAnt": 1,
      "valorSTRetAnt": 1,
      "perCreditoIcms": 1,
      "valorCreditoIcms": 1,
      "perReducaoPis": 1,
      "perReducaoCofins": 1,
      "valorDiferencaPis": 1,
      "valorDiferencaCofins": 1,
      "reducaoBaseIcmsST": 1,
      "codCSTCSOSN": "text",
      "numeroPedidoCompra": "text",
      "itemPedidoCompra": 1,
      "aliquotaPIS": 1,
      "aliquotaCOFINS": 1,
      "valorDespesasBaseIcms": 1,
      "codEnquadramentoIPI": 1,
      "baseICMSUFDestino": 1,
      "percFCP": 1,
      "aliqUFDest": 1,
      "aliICMSInt": 1,
      "valorICMSInterestUFDest": 1,
      "valorFCP": 1,
      "valorDescPropTroca": 1,
      "valorDescEspecPropCapa": 1,
      "valorAcrescimo": 1,
      "baseComissaoAtendente": 1,
      "percComissaoAtendente": 1,
      "valorComissaoAtendente": 1,
      "baseComissaoRepresentante": 1,
      "percComissaoRepresentante": 1,
      "valorComissaoRepresentante": 1,
      "cBenef": "text",
      "cCredPresumido": "text",
      "pCredPresumido": 1,
      "vCredPresumido": 1,
      "valorBaseIBSCBS": 1,
      "aliquotaIBSEstadual": 1,
      "valorIBSEstadual": 1,
      "aliquotaIBSMunicipal": 1,
      "valorIBSMunicipal": 1,
      "aliquotaCBS": 1,
      "valorCBS": 1,
      "cClassTribIBSCBS": "text",
      "cstIBSCBS": "text",
      "valorBaseIS": 1,
      "aliquotaIS": 1,
      "valorIS": 1,
      "itemPedidoAgrupado": [
        {
          "codPedido": "text",
          "itemPedido": 1,
          "qtdFaturadaItemPedido": 1
        }
      ],
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Obter as Notas Fiscais de Saída a partir do Pedido de Venda

get

https://localhost/comercial/v10http://localhost/comercial/v10

/notaFiscalSaidaPedido/{codPedido}

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de rota

codPedidostringObrigatório

Código do Pedido

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

OK

application/json

dataEmissaostring · dateOpcional

Data de Emissão da Nota Fiscal (YYYY-MM-DD)

codNumNotaintegerOpcional

Código Numérico da Nota

serieintegerOpcional

Série da Nota Fiscal

codTipoDeNotaintegerOpcional

Código do Tipo de Nota

codClienteintegerOpcional

Código do Cliente

codRepresentanteintegerOpcional

Código do Representante

codPedidostringOpcional

Código do Pedido de Venda

percDescontonumberOpcional

Percentual de Desconto

valorFretenumberOpcional

Valor do Frete

valorSeguronumberOpcional

Valor do Seguro

valorLiquidonumberOpcional

Valor Liquido da Nota Fiscal

valorIPInumberOpcional

Valor do IPI

valorTotalnumberOpcional

Valor Total da Nota Fiscal

valorDescNormalnumberOpcional

Valor do Desconto Normal

codNatOperacaointeger · máx: 99999Opcional

Código da Natureza de Operação

situacaointeger · enumOpcional

Situação da Nota Fiscal (1 - Gerada, 2 - Emitidade, 3 - Cancelada)

Valores possíveis:

baseCalcIPInumberOpcional

Base de Cálculo do IPI

valorICMSnaoPagoReducnumberOpcional

Valor do ICMS não Pago Redução

valorICMSSubstitnumberOpcional

Valor do ICMS Substituto

valorICMSIsentasnumberOpcional

Valor do ICMS Isentas

valorIPIIsentasnumberOpcional

Valor do IPI Isentas

valorOutrasDespesasnumberOpcional

Valor de Outras Despesas

baseICMSSubsnumberOpcional

Base do ICMS Substituto

deducICMSNFManausnumberOpcional

Dedução do ICMS para Manaus

percISSnumberOpcional

Percentual do ISS

valorISSnumberOpcional

Valor do ISS

valorPISnumberOpcional

Valor do PIS

valorCOFINSnumberOpcional

Valor do COFINS

basePISnumberOpcional

Base do PIS

baseCofinsnumberOpcional

Base do COFINS

baseRetPISnumberOpcional

Base de Retenção do PIS

valorRetPISnumberOpcional

Valor de Retenção do PIS

baseRetCOFINSnumberOpcional

Base de Retenção do COFINS

valorRetCOFINSnumberOpcional

Valor de Retenção do COFINS

valorPISZFnumberOpcional

Valor do PISZF

valorCOFINSZFnumberOpcional

Valor do COFINSZF

valorDifAliqnumberOpcional

Valor diferença da Aliquota

baseRetCSSLnumberOpcional

Base de Retenção do CSSL

valorRetCSSLnumberOpcional

Valor de Retenção do CSSL

baseRetIRnumberOpcional

Base de Retenção do IR

valorRetIRnumberOpcional

Valor de Retenção do IR

baseRetnumberOpcional

Base de Retenção

valorFECPnumberOpcional

Valor de Retenção do FECP

percRetencaoPISnumberOpcional

Percentual de Retenção do PIS

percRetencaoCOFINSnumberOpcional

Percentual de Retenção do COFINS

percRetencaoCSSLnumberOpcional

Percentual de Retenção do CSSL

percRetencaoIRnumberOpcional

Percentual de Retenção do IR

baseISSnumberOpcional

Base do ISS

valorReducaoISSnumberOpcional

Valor Redução do ISS

codCnaestringOpcional

Código do Cnae

atendimentoPresencialinteger · enumOpcional

Atendimento Presencial (0 - Não se aplica, 1 - Operação presencial, 2 - Operação não presencial, pela internet, 3 - Operação não presencial, Teleatendimento, 5 - Operação presencial fora do estabelecimento, 9 - Operação não presencial outros)

Valores possíveis:

valFCPnumberOpcional

Valor do FCP

valICMSDestnumberOpcional

Valor do ICMS Interestadual para a UF de Destino

valICMSRemnumberOpcional

Valor total do ICMS Interestadual para a UF do Remetente

IPIDevolnumberOpcional

Valor total do IPI Devolvido

valorFCPSTnumberOpcional

Valor do FCP/FECOEP do ST

valorFCPICMSnumberOpcional

Valor FCP ICMS

tipoFreteintegerOpcional

Tipo de Frete

codTransportadoraintegerOpcional

Código da Transportadora

pesoBrutonumberOpcional

Peso Bruto

pesoLiquidonumberOpcional

Peso Liquido

qtdVolumesintegerOpcional

Quantidade de Volumes

especieVolumesstringOpcional

Espécie dos Volumes

dataHoraSaidastring · date-timeOpcional

Data e Hora da Saída (YYYY-MM-DDTHH:mm:ss.sssZ)

codTabelaintegerOpcional

Código da Tabela de Preço

placaVeiculostringOpcional

Placa do Veículo

codEstPlacaVeicstringOpcional

Código do Estado da Placa do Veículo

consumidorFinalinteger · enumOpcional

É para Consumidor Final? (0 - Não, 1 - Sim)

Valores possíveis:

codPortadorintegerOpcional

Código do Portador

codTipoCobrancaintegerOpcional

Código do Tipo de Cobrança

marcastringOpcional

Marca

numeroVolumestringOpcional

Número do Volume

dataHoraGeracaoNFstring · date-timeOpcional

Data e Hora da Geração da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)

obsCancNF1stringOpcional

Observação do Cancelamento da Nota Fiscal

obsCancNF2stringOpcional

Complemento da Observação do Cancelamento da Nota Fiscal

obsCancNF3stringOpcional

Complemento da Observação do Cancelamento da Nota Fiscal

dataGeracao1string · date-timeOpcional

Data e Hora do Cancelamento da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)

chaveAcessostringOpcional

Chave de acesso da NF-e

dataHoraNfestring · date-timeOpcional

Data do processamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)

protNfestringOpcional

Número do Protocolo da NF-e e NFS-e

statusNfestringOpcional

Código do status da resposta para a NF-e e NFS-e

codLotestringOpcional

Identificador de controle do envio do lote da NFe

dataHoraDanfestring · date-timeOpcional

Data e Hora da Emissão do DANFE (YYYY-MM-DDTHH:mm:ss.sssZ)

dataHoraCancelaNfestring · date-timeOpcional

Data e Hora do Cancelamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)

protCancelaNfestringOpcional

Número do Protocolo de Cancelamento da NF-e e NFS-e

statusCancelaNfestringOpcional

Código do status do Cancelamento NF-e e NFS-e

tipoEmissaoNfeinteger · enumOpcional

Tipo de Emissão (1 - Normal, 2 - Contingência FS (Formulário Segurança), 3 - Contingência SCAN (Sistema de Contingência Ambiente Nacional), 4 - Contingência EPEC (Evento Prévio de Emissão em Contingência), 5 - Contingência FS-DA, 6 - Contingencia SVC-AN, 7 - Contingencia SVC-RS)

Valores possíveis:

emailNfestringOpcional

E-mail Destinatario que foi enviado arquivo distribuição NF-e

flagReplicadobooleanOpcional

Flag se foi Replicado

baseComissaoAtendentenumberOpcional

Base de Cálculo de Comissão do Atendente

valorComissaoAtendentenumberOpcional

Valor de Comissão do Atendente

valorDescEspecPropCapanumberOpcional

Valor do Desconto Especial Proporcional Capa

valorComissaoRepresentantenumberOpcional

Valor de Comissão do Representante

percComissaoRepresentantenumberOpcional

Percentual de Comissão do Representante

baseComissaoRepresentantenumberOpcional

Base de Comissão do Representante

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/notaFiscalSaidaPedido/{codPedido}

HTTPcURLJavaScriptPython

GET /comercial/v10/notaFiscalSaidaPedido/{codPedido} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

[
  {
    "dataEmissao": "2026-05-08",
    "codNumNota": 1,
    "serie": 1,
    "codTipoDeNota": 1,
    "codCliente": 1,
    "codRepresentante": 1,
    "codPedido": "text",
    "percDesconto": 1,
    "valorFrete": 1,
    "valorSeguro": 1,
    "valorLiquido": 1,
    "valorIPI": 1,
    "valorTotal": 1,
    "valorDescNormal": 1,
    "codNatOperacao": 1,
    "situacao": 1,
    "baseCalcIPI": 1,
    "valorICMSnaoPagoReduc": 1,
    "valorICMSSubstit": 1,
    "valorICMSIsentas": 1,
    "valorIPIIsentas": 1,
    "valorOutrasDespesas": 1,
    "baseICMSSubs": 1,
    "deducICMSNFManaus": 1,
    "percISS": 1,
    "valorISS": 1,
    "valorPIS": 1,
    "valorCOFINS": 1,
    "basePIS": 1,
    "baseCofins": 1,
    "baseRetPIS": 1,
    "valorRetPIS": 1,
    "baseRetCOFINS": 1,
    "valorRetCOFINS": 1,
    "valorPISZF": 1,
    "valorCOFINSZF": 1,
    "valorDifAliq": 1,
    "baseRetCSSL": 1,
    "valorRetCSSL": 1,
    "baseRetIR": 1,
    "valorRetIR": 1,
    "baseRet": 1,
    "valorFECP": 1,
    "percRetencaoPIS": 1,
    "percRetencaoCOFINS": 1,
    "percRetencaoCSSL": 1,
    "percRetencaoIR": 1,
    "baseISS": 1,
    "valorReducaoISS": 1,
    "codCnae": "text",
    "atendimentoPresencial": 0,
    "valFCP": 1,
    "valICMSDest": 1,
    "valICMSRem": 1,
    "IPIDevol": 1,
    "valorFCPST": 1,
    "valorFCPICMS": 1,
    "tipoFrete": 1,
    "codTransportadora": 1,
    "pesoBruto": 1,
    "pesoLiquido": 1,
    "qtdVolumes": 1,
    "especieVolumes": "text",
    "dataHoraSaida": "2026-05-08T23:26:48.877Z",
    "codTabela": 1,
    "placaVeiculo": "text",
    "codEstPlacaVeic": "text",
    "consumidorFinal": 0,
    "codPortador": 1,
    "codTipoCobranca": 1,
    "marca": "text",
    "numeroVolume": "text",
    "dataHoraGeracaoNF": "2026-05-08T23:26:48.877Z",
    "obsCancNF1": "text",
    "obsCancNF2": "text",
    "obsCancNF3": "text",
    "dataGeracao1": "2026-05-08T23:26:48.877Z",
    "chaveAcesso": "text",
    "dataHoraNfe": "2026-05-08T23:26:48.877Z",
    "protNfe": "text",
    "statusNfe": "text",
    "codLote": "text",
    "dataHoraDanfe": "2026-05-08T23:26:48.877Z",
    "dataHoraCancelaNfe": "2026-05-08T23:26:48.877Z",
    "protCancelaNfe": "text",
    "statusCancelaNfe": "text",
    "tipoEmissaoNfe": 1,
    "emailNfe": "text",
    "flagReplicado": true,
    "baseComissaoAtendente": 1,
    "valorComissaoAtendente": 1,
    "valorDescEspecPropCapa": 1,
    "valorComissaoRepresentante": 1,
    "percComissaoRepresentante": 1,
    "baseComissaoRepresentante": 1,
    "itensNotaFiscalSaida": [
      {
        "codItem": 1,
        "codProduto": "text",
        "qtdFaturada": 1,
        "precoUnitario": 1,
        "valorItem": 1,
        "valorIPI": 1,
        "valorDesconto": 1,
        "codItemPedido": 1,
        "codClassifFiscal": "text",
        "codGrupo": "text",
        "percICMS": 1,
        "valorICMS": 1,
        "percICMSSubst": 1,
        "valorICMSSubstituto": 1,
        "margemLucro": 1,
        "percReducICMS": 1,
        "pesoLiquido": 1,
        "codSitTributICMS": "text",
        "percIPI": 1,
        "codNatOperacao": 1,
        "vlrDescICMSZonaFranca": 1,
        "baseCalcICMS": 1,
        "baseCalcICMSIsenta": 1,
        "baseCalcICMSOutra": 1,
        "baseCalcIPI": 1,
        "baseCalcIPIIsenta": 1,
        "baseCalcIPIOutra": 1,
        "codSitTributIPI": "text",
        "valorDescNaoIncideICMS": 1,
        "baseCalcSTPIS": 1,
        "valorSTPIS": 1,
        "baseCalcSTCOFINS": 1,
        "valorSTCOFINS": 1,
        "valorFreteProp": 1,
        "valorSeguroProp": 1,
        "valorDespAcesProp": 1,
        "valorPISProp": 1,
        "valorCOFINSProp": 1,
        "percPIS": 1,
        "percCOFINS": 1,
        "baseCalcICMSSubst": 1,
        "basePIS": 1,
        "baseCofins": 1,
        "valorPISZF": 1,
        "valorCOFINSZF": 1,
        "valorIPIDescAcess": 1,
        "situaICMS": 0,
        "codCSTPis": "text",
        "codCSTCofins": "text",
        "valorBaseSTRetAnt": 1,
        "valorSTRetAnt": 1,
        "perCreditoIcms": 1,
        "valorCreditoIcms": 1,
        "perReducaoPis": 1,
        "perReducaoCofins": 1,
        "valorDiferencaPis": 1,
        "valorDiferencaCofins": 1,
        "reducaoBaseIcmsST": 1,
        "codCSTCSOSN": "text",
        "numeroPedidoCompra": "text",
        "itemPedidoCompra": 1,
        "aliquotaPIS": 1,
        "aliquotaCOFINS": 1,
        "valorDespesasBaseIcms": 1,
        "codEnquadramentoIPI": 1,
        "baseICMSUFDestino": 1,
        "percFCP": 1,
        "aliqUFDest": 1,
        "aliICMSInt": 1,
        "valorICMSInterestUFDest": 1,
        "valorFCP": 1,
        "valorDescPropTroca": 1,
        "valorDescEspecPropCapa": 1,
        "valorAcrescimo": 1,
        "baseComissaoAtendente": 1,
        "percComissaoAtendente": 1,
        "valorComissaoAtendente": 1,
        "baseComissaoRepresentante": 1,
        "percComissaoRepresentante": 1,
        "valorComissaoRepresentante": 1,
        "cBenef": "text",
        "cCredPresumido": "text",
        "pCredPresumido": 1,
        "vCredPresumido": 1,
        "valorBaseIBSCBS": 1,
        "aliquotaIBSEstadual": 1,
        "valorIBSEstadual": 1,
        "aliquotaIBSMunicipal": 1,
        "valorIBSMunicipal": 1,
        "aliquotaCBS": 1,
        "valorCBS": 1,
        "cClassTribIBSCBS": "text",
        "cstIBSCBS": "text",
        "valorBaseIS": 1,
        "aliquotaIS": 1,
        "valorIS": 1,
        "itemPedidoAgrupado": [
          {
            "codPedido": "text",
            "itemPedido": 1,
            "qtdFaturadaItemPedido": 1
          }
        ],
        "dadosCustomizados": [
          {
            "campo": "text",
            "valor": "text"
          }
        ]
      }
    ],
    "dadosCustomizados": [
      {
        "campo": "text",
        "valor": "text"
      }
    ]
  }
]

Obter uma Nota Fiscal de Saída

get

https://localhost/comercial/v10http://localhost/comercial/v10

/notaFiscalSaida/{id}

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Chave da Nota Fiscal de Saída

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

OK

application/json

dataEmissaostring · dateOpcional

Data de Emissão da Nota Fiscal (YYYY-MM-DD)

codNumNotaintegerOpcional

Código Numérico da Nota

serieintegerOpcional

Série da Nota Fiscal

codTipoDeNotaintegerOpcional

Código do Tipo de Nota

codClienteintegerOpcional

Código do Cliente

codRepresentanteintegerOpcional

Código do Representante

codPedidostringOpcional

Código do Pedido de Venda

percDescontonumberOpcional

Percentual de Desconto

valorFretenumberOpcional

Valor do Frete

valorSeguronumberOpcional

Valor do Seguro

valorLiquidonumberOpcional

Valor Liquido da Nota Fiscal

valorIPInumberOpcional

Valor do IPI

valorTotalnumberOpcional

Valor Total da Nota Fiscal

valorDescNormalnumberOpcional

Valor do Desconto Normal

codNatOperacaointeger · máx: 99999Opcional

Código da Natureza de Operação

situacaointeger · enumOpcional

Situação da Nota Fiscal (1 - Gerada, 2 - Emitidade, 3 - Cancelada)

Valores possíveis:

baseCalcIPInumberOpcional

Base de Cálculo do IPI

valorICMSnaoPagoReducnumberOpcional

Valor do ICMS não Pago Redução

valorICMSSubstitnumberOpcional

Valor do ICMS Substituto

valorICMSIsentasnumberOpcional

Valor do ICMS Isentas

valorIPIIsentasnumberOpcional

Valor do IPI Isentas

valorOutrasDespesasnumberOpcional

Valor de Outras Despesas

baseICMSSubsnumberOpcional

Base do ICMS Substituto

deducICMSNFManausnumberOpcional

Dedução do ICMS para Manaus

percISSnumberOpcional

Percentual do ISS

valorISSnumberOpcional

Valor do ISS

valorPISnumberOpcional

Valor do PIS

valorCOFINSnumberOpcional

Valor do COFINS

basePISnumberOpcional

Base do PIS

baseCofinsnumberOpcional

Base do COFINS

baseRetPISnumberOpcional

Base de Retenção do PIS

valorRetPISnumberOpcional

Valor de Retenção do PIS

baseRetCOFINSnumberOpcional

Base de Retenção do COFINS

valorRetCOFINSnumberOpcional

Valor de Retenção do COFINS

valorPISZFnumberOpcional

Valor do PISZF

valorCOFINSZFnumberOpcional

Valor do COFINSZF

valorDifAliqnumberOpcional

Valor diferença da Aliquota

baseRetCSSLnumberOpcional

Base de Retenção do CSSL

valorRetCSSLnumberOpcional

Valor de Retenção do CSSL

baseRetIRnumberOpcional

Base de Retenção do IR

valorRetIRnumberOpcional

Valor de Retenção do IR

baseRetnumberOpcional

Base de Retenção

valorFECPnumberOpcional

Valor de Retenção do FECP

percRetencaoPISnumberOpcional

Percentual de Retenção do PIS

percRetencaoCOFINSnumberOpcional

Percentual de Retenção do COFINS

percRetencaoCSSLnumberOpcional

Percentual de Retenção do CSSL

percRetencaoIRnumberOpcional

Percentual de Retenção do IR

baseISSnumberOpcional

Base do ISS

valorReducaoISSnumberOpcional

Valor Redução do ISS

codCnaestringOpcional

Código do Cnae

atendimentoPresencialinteger · enumOpcional

Atendimento Presencial (0 - Não se aplica, 1 - Operação presencial, 2 - Operação não presencial, pela internet, 3 - Operação não presencial, Teleatendimento, 5 - Operação presencial fora do estabelecimento, 9 - Operação não presencial outros)

Valores possíveis:

valFCPnumberOpcional

Valor do FCP

valICMSDestnumberOpcional

Valor do ICMS Interestadual para a UF de Destino

valICMSRemnumberOpcional

Valor total do ICMS Interestadual para a UF do Remetente

IPIDevolnumberOpcional

Valor total do IPI Devolvido

valorFCPSTnumberOpcional

Valor do FCP/FECOEP do ST

valorFCPICMSnumberOpcional

Valor FCP ICMS

tipoFreteintegerOpcional

Tipo de Frete

codTransportadoraintegerOpcional

Código da Transportadora

pesoBrutonumberOpcional

Peso Bruto

pesoLiquidonumberOpcional

Peso Liquido

qtdVolumesintegerOpcional

Quantidade de Volumes

especieVolumesstringOpcional

Espécie dos Volumes

dataHoraSaidastring · date-timeOpcional

Data e Hora da Saída (YYYY-MM-DDTHH:mm:ss.sssZ)

codTabelaintegerOpcional

Código da Tabela de Preço

placaVeiculostringOpcional

Placa do Veículo

codEstPlacaVeicstringOpcional

Código do Estado da Placa do Veículo

consumidorFinalinteger · enumOpcional

É para Consumidor Final? (0 - Não, 1 - Sim)

Valores possíveis:

codPortadorintegerOpcional

Código do Portador

codTipoCobrancaintegerOpcional

Código do Tipo de Cobrança

marcastringOpcional

Marca

numeroVolumestringOpcional

Número do Volume

dataHoraGeracaoNFstring · date-timeOpcional

Data e Hora da Geração da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)

obsCancNF1stringOpcional

Observação do Cancelamento da Nota Fiscal

obsCancNF2stringOpcional

Complemento da Observação do Cancelamento da Nota Fiscal

obsCancNF3stringOpcional

Complemento da Observação do Cancelamento da Nota Fiscal

dataGeracao1string · date-timeOpcional

Data e Hora do Cancelamento da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)

chaveAcessostringOpcional

Chave de acesso da NF-e

dataHoraNfestring · date-timeOpcional

Data do processamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)

protNfestringOpcional

Número do Protocolo da NF-e e NFS-e

statusNfestringOpcional

Código do status da resposta para a NF-e e NFS-e

codLotestringOpcional

Identificador de controle do envio do lote da NFe

dataHoraDanfestring · date-timeOpcional

Data e Hora da Emissão do DANFE (YYYY-MM-DDTHH:mm:ss.sssZ)

dataHoraCancelaNfestring · date-timeOpcional

Data e Hora do Cancelamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)

protCancelaNfestringOpcional

Número do Protocolo de Cancelamento da NF-e e NFS-e

statusCancelaNfestringOpcional

Código do status do Cancelamento NF-e e NFS-e

tipoEmissaoNfeinteger · enumOpcional

Tipo de Emissão (1 - Normal, 2 - Contingência FS (Formulário Segurança), 3 - Contingência SCAN (Sistema de Contingência Ambiente Nacional), 4 - Contingência EPEC (Evento Prévio de Emissão em Contingência), 5 - Contingência FS-DA, 6 - Contingencia SVC-AN, 7 - Contingencia SVC-RS)

Valores possíveis:

emailNfestringOpcional

E-mail Destinatario que foi enviado arquivo distribuição NF-e

flagReplicadobooleanOpcional

Flag se foi Replicado

baseComissaoAtendentenumberOpcional

Base de Cálculo de Comissão do Atendente

valorComissaoAtendentenumberOpcional

Valor de Comissão do Atendente

valorDescEspecPropCapanumberOpcional

Valor do Desconto Especial Proporcional Capa

valorComissaoRepresentantenumberOpcional

Valor de Comissão do Representante

percComissaoRepresentantenumberOpcional

Percentual de Comissão do Representante

baseComissaoRepresentantenumberOpcional

Base de Comissão do Representante

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/notaFiscalSaida/{id}

HTTPcURLJavaScriptPython

GET /comercial/v10/notaFiscalSaida/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

[
  {
    "dataEmissao": "2026-05-08",
    "codNumNota": 1,
    "serie": 1,
    "codTipoDeNota": 1,
    "codCliente": 1,
    "codRepresentante": 1,
    "codPedido": "text",
    "percDesconto": 1,
    "valorFrete": 1,
    "valorSeguro": 1,
    "valorLiquido": 1,
    "valorIPI": 1,
    "valorTotal": 1,
    "valorDescNormal": 1,
    "codNatOperacao": 1,
    "situacao": 1,
    "baseCalcIPI": 1,
    "valorICMSnaoPagoReduc": 1,
    "valorICMSSubstit": 1,
    "valorICMSIsentas": 1,
    "valorIPIIsentas": 1,
    "valorOutrasDespesas": 1,
    "baseICMSSubs": 1,
    "deducICMSNFManaus": 1,
    "percISS": 1,
    "valorISS": 1,
    "valorPIS": 1,
    "valorCOFINS": 1,
    "basePIS": 1,
    "baseCofins": 1,
    "baseRetPIS": 1,
    "valorRetPIS": 1,
    "baseRetCOFINS": 1,
    "valorRetCOFINS": 1,
    "valorPISZF": 1,
    "valorCOFINSZF": 1,
    "valorDifAliq": 1,
    "baseRetCSSL": 1,
    "valorRetCSSL": 1,
    "baseRetIR": 1,
    "valorRetIR": 1,
    "baseRet": 1,
    "valorFECP": 1,
    "percRetencaoPIS": 1,
    "percRetencaoCOFINS": 1,
    "percRetencaoCSSL": 1,
    "percRetencaoIR": 1,
    "baseISS": 1,
    "valorReducaoISS": 1,
    "codCnae": "text",
    "atendimentoPresencial": 0,
    "valFCP": 1,
    "valICMSDest": 1,
    "valICMSRem": 1,
    "IPIDevol": 1,
    "valorFCPST": 1,
    "valorFCPICMS": 1,
    "tipoFrete": 1,
    "codTransportadora": 1,
    "pesoBruto": 1,
    "pesoLiquido": 1,
    "qtdVolumes": 1,
    "especieVolumes": "text",
    "dataHoraSaida": "2026-05-08T23:26:48.877Z",
    "codTabela": 1,
    "placaVeiculo": "text",
    "codEstPlacaVeic": "text",
    "consumidorFinal": 0,
    "codPortador": 1,
    "codTipoCobranca": 1,
    "marca": "text",
    "numeroVolume": "text",
    "dataHoraGeracaoNF": "2026-05-08T23:26:48.877Z",
    "obsCancNF1": "text",
    "obsCancNF2": "text",
    "obsCancNF3": "text",
    "dataGeracao1": "2026-05-08T23:26:48.877Z",
    "chaveAcesso": "text",
    "dataHoraNfe": "2026-05-08T23:26:48.877Z",
    "protNfe": "text",
    "statusNfe": "text",
    "codLote": "text",
    "dataHoraDanfe": "2026-05-08T23:26:48.877Z",
    "dataHoraCancelaNfe": "2026-05-08T23:26:48.877Z",
    "protCancelaNfe": "text",
    "statusCancelaNfe": "text",
    "tipoEmissaoNfe": 1,
    "emailNfe": "text",
    "flagReplicado": true,
    "baseComissaoAtendente": 1,
    "valorComissaoAtendente": 1,
    "valorDescEspecPropCapa": 1,
    "valorComissaoRepresentante": 1,
    "percComissaoRepresentante": 1,
    "baseComissaoRepresentante": 1,
    "itensNotaFiscalSaida": [
      {
        "codItem": 1,
        "codProduto": "text",
        "qtdFaturada": 1,
        "precoUnitario": 1,
        "valorItem": 1,
        "valorIPI": 1,
        "valorDesconto": 1,
        "codItemPedido": 1,
        "codClassifFiscal": "text",
        "codGrupo": "text",
        "percICMS": 1,
        "valorICMS": 1,
        "percICMSSubst": 1,
        "valorICMSSubstituto": 1,
        "margemLucro": 1,
        "percReducICMS": 1,
        "pesoLiquido": 1,
        "codSitTributICMS": "text",
        "percIPI": 1,
        "codNatOperacao": 1,
        "vlrDescICMSZonaFranca": 1,
        "baseCalcICMS": 1,
        "baseCalcICMSIsenta": 1,
        "baseCalcICMSOutra": 1,
        "baseCalcIPI": 1,
        "baseCalcIPIIsenta": 1,
        "baseCalcIPIOutra": 1,
        "codSitTributIPI": "text",
        "valorDescNaoIncideICMS": 1,
        "baseCalcSTPIS": 1,
        "valorSTPIS": 1,
        "baseCalcSTCOFINS": 1,
        "valorSTCOFINS": 1,
        "valorFreteProp": 1,
        "valorSeguroProp": 1,
        "valorDespAcesProp": 1,
        "valorPISProp": 1,
        "valorCOFINSProp": 1,
        "percPIS": 1,
        "percCOFINS": 1,
        "baseCalcICMSSubst": 1,
        "basePIS": 1,
        "baseCofins": 1,
        "valorPISZF": 1,
        "valorCOFINSZF": 1,
        "valorIPIDescAcess": 1,
        "situaICMS": 0,
        "codCSTPis": "text",
        "codCSTCofins": "text",
        "valorBaseSTRetAnt": 1,
        "valorSTRetAnt": 1,
        "perCreditoIcms": 1,
        "valorCreditoIcms": 1,
        "perReducaoPis": 1,
        "perReducaoCofins": 1,
        "valorDiferencaPis": 1,
        "valorDiferencaCofins": 1,
        "reducaoBaseIcmsST": 1,
        "codCSTCSOSN": "text",
        "numeroPedidoCompra": "text",
        "itemPedidoCompra": 1,
        "aliquotaPIS": 1,
        "aliquotaCOFINS": 1,
        "valorDespesasBaseIcms": 1,
        "codEnquadramentoIPI": 1,
        "baseICMSUFDestino": 1,
        "percFCP": 1,
        "aliqUFDest": 1,
        "aliICMSInt": 1,
        "valorICMSInterestUFDest": 1,
        "valorFCP": 1,
        "valorDescPropTroca": 1,
        "valorDescEspecPropCapa": 1,
        "valorAcrescimo": 1,
        "baseComissaoAtendente": 1,
        "percComissaoAtendente": 1,
        "valorComissaoAtendente": 1,
        "baseComissaoRepresentante": 1,
        "percComissaoRepresentante": 1,
        "valorComissaoRepresentante": 1,
        "cBenef": "text",
        "cCredPresumido": "text",
        "pCredPresumido": 1,
        "vCredPresumido": 1,
        "valorBaseIBSCBS": 1,
        "aliquotaIBSEstadual": 1,
        "valorIBSEstadual": 1,
        "aliquotaIBSMunicipal": 1,
        "valorIBSMunicipal": 1,
        "aliquotaCBS": 1,
        "valorCBS": 1,
        "cClassTribIBSCBS": "text",
        "cstIBSCBS": "text",
        "valorBaseIS": 1,
        "aliquotaIS": 1,
        "valorIS": 1,
        "itemPedidoAgrupado": [
          {
            "codPedido": "text",
            "itemPedido": 1,
            "qtdFaturadaItemPedido": 1
          }
        ],
        "dadosCustomizados": [
          {
            "campo": "text",
            "valor": "text"
          }
        ]
      }
    ],
    "dadosCustomizados": [
      {
        "campo": "text",
        "valor": "text"
      }
    ]
  }
]

Excluir uma Nota Fiscal de Saída

delete

https://localhost/comercial/v10http://localhost/comercial/v10

/notaFiscalSaida/{id}

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Chave da Nota Fiscal de Saída

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

OK

Sem conteúdo

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

delete

/notaFiscalSaida/{id}

HTTPcURLJavaScriptPython

DELETE /comercial/v10/notaFiscalSaida/{id} HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

Sem conteúdo

Obter Caixa com Tags(Confecção) de uma Nota Fiscal de Saída

get

https://localhost/comercial/v10http://localhost/comercial/v10

/notaFiscalSaida/{id}/caixaTag

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Chave da Nota Fiscal de Saída

Parâmetros de consulta

continuationTokenstring · anulávelOpcional

Identificador da Paginação da Consulta

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

OK

application/json

continuationTokenstringOpcional

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/notaFiscalSaida/{id}/caixaTag

HTTPcURLJavaScriptPython

GET /comercial/v10/notaFiscalSaida/{id}/caixaTag HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

[
  {
    "continuationToken": "text",
    "data": [
      {
        "codCaixa": "text",
        "situacao": 0,
        "dataEmissaoNF": "2026-05-08",
        "notaFiscal": 1,
        "transportadora": 1,
        "codCliente": 1,
        "tabelaPrecoKg": 1,
        "pesoLiquido": 1,
        "pesoBruto": 1,
        "codEmbalagem": "text",
        "pedido": [
          "text"
        ],
        "tag": [
          {
            "codProduto": "text",
            "codTag": "text"
          }
        ]
      }
    ]
  }
]

Replicar uma Nota Fiscal de Saída

put

https://localhost/comercial/v10http://localhost/comercial/v10

/notaFiscalSaida/replicar

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Corpo

application/json

dataEmissaostring · dateObrigatório

Data de Emissão da Nota Fiscal (YYYY-MM-DD)

codNumNotainteger · máx: 9999999Obrigatório

Código Numérico da Nota

codTipoDeNotainteger · máx: 9999Opcional

Código do Tipo de Nota

codClienteinteger · máx: 9999999Opcional

Código do Cliente

codRepresentanteinteger · máx: 9999Opcional

Código do Representante

percDescontonumberOpcional

Percentual de Desconto

valorFretenumberOpcional

Valor do Frete

valorSeguronumberOpcional

Valor do Seguro

valorLiquidonumberOpcional

Valor Liquido da Nota Fiscal

valorIPInumberOpcional

Valor do IPI

valorTotalnumberOpcional

Valor Total da Nota Fiscal

valorDescNormalnumberOpcional

Valor do Desconto Normal

codNatOperacaointeger · máx: 99999Opcional

Código da Natureza de Operação

situacaointeger · enumOpcional

Situação da Nota Fiscal (1 - Gerada, 2 - Emitida, 3 - Cancelada)

Valores possíveis:

baseCalcIPInumberOpcional

Base de Cálculo do IPI

valorICMSnaoPagoReducnumberOpcional

Valor do ICMS não Pago Redução

valorICMSSubstitnumberOpcional

Valor do ICMS Substituto

valorICMSIsentasnumberOpcional

Valor do ICMS Isentas

valorIPIIsentasnumberOpcional

Valor do IPI Isentas

valorOutrasDespesasnumberOpcional

Valor de Outras Despesas

baseICMSSubsnumberOpcional

Base do ICMS Substituto

deducICMSNFManausnumberOpcional

Dedução do ICMS para Manaus

percISSnumberOpcional

Percentual do ISS

valorISSnumberOpcional

Valor do ISS

valorPISnumberOpcional

Valor do PIS

valorCOFINSnumberOpcional

Valor do COFINS

basePISnumberOpcional

Base do PIS

baseCofinsnumberOpcional

Base do COFINS

baseRetPISnumberOpcional

Base de Retenção do PIS

valorRetPISnumberOpcional

Valor de Retenção do PIS

baseRetCOFINSnumberOpcional

Base de Retenção do COFINS

valorRetCOFINSnumberOpcional

Valor de Retenção do COFINS

valorPISZFnumberOpcional

Valor do PISZF

valorCOFINSZFnumberOpcional

Valor do COFINSZF

valorDifAliqnumberOpcional

Valor da Diferença da Aliquota

baseRetCSSLnumberOpcional

Base de Retenção do CSSL

valorRetCSSLnumberOpcional

Valor de Retenção do CSSL

baseRetIRnumberOpcional

Base de Retenção do IR

valorRetIRnumberOpcional

Valor de Retenção do IR

baseRetnumberOpcional

Base de Retenção

valorFECPnumberOpcional

Valor de Retenção do FECP

percRetencaoPISnumberOpcional

Percentual de Retenção do PIS

percRetencaoCOFINSnumberOpcional

Percentual de Retenção do COFINS

percRetencaoCSSLnumberOpcional

Percentual de Retenção do CSSL

percRetencaoIRnumberOpcional

Percentual de Retenção do IR

baseISSnumberOpcional

Base do ISS

valorReducaoISSnumberOpcional

Valor Redução do ISS

codCnaestring · máx: 7Opcional

Código do Cnae

atendimentoPresencialinteger · enumOpcional

Atendimento Presencial (0 - Não se aplica, 1 - Operação presencial, 2 - Operação não presencial, pela internet, 3 - Operação não presencial, Teleatendimento, 5 - Operação presencial fora do estabelecimento, 9 - Operação não presencial outros)

Valores possíveis:

valFCPnumberOpcional

Valor do FCP

valICMSDestnumberOpcional

Valor do ICMS Interestadual para a UF de Destino

valICMSRemnumberOpcional

Valor total do ICMS Interestadual para a UF do Remetente

IPIDevolnumberOpcional

Valor total do IPI Devolvido

valorFCPSTnumberOpcional

Valor do FCP/FECOEP do ST

valorFCPICMSnumberOpcional

Valor FCP ICMS

tipoFreteintegerOpcional

Tipo de Frete

codTransportadorainteger · máx: 9999Opcional

Código da Transportadora

pesoBrutonumberOpcional

Peso Bruto

pesoLiquidonumberOpcional

Peso Liquido

qtdVolumesinteger · máx: 9999999Opcional

Quantidade de Volumes

especieVolumesstring · máx: 10Opcional

Espécie dos Volumes

dataHoraSaidastring · date-timeOpcional

Data e Hora da Saída (YYYY-MM-DDTHH:mm:ss.sssZ)

codTabelainteger · máx: 99999Opcional

Código da Tabela de Preço

placaVeiculostring · máx: 10Opcional

Placa do Veículo

codEstPlacaVeicstring · máx: 10Opcional

Código do Estado da Placa do Veículo

consumidorFinalinteger · enumOpcional

É para Consumidor Final? (0 - Não, 1 - Sim)

Valores possíveis:

codPortadorinteger · máx: 9999Opcional

Código do Portador

codTipoCobrancainteger · máx: 99Opcional

Código do Tipo de Cobrança

marcastring · máx: 13Opcional

Marca

numeroVolumestring · máx: 10Opcional

Número do Volume

dataHoraGeracaoNFstring · date-timeOpcional

Data e Hora da Geração da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)

obsCancNF1string · máx: 35Opcional

Observação do Cancelamento da Nota Fiscal

obsCancNF2string · máx: 35Opcional

Complemento da Observação do Cancelamento da Nota Fiscal

obsCancNF3string · máx: 35Opcional

Complemento da Observação do Cancelamento da Nota Fiscal

dataGeracao1string · date-timeOpcional

Data e Hora do Cancelamento da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)

chaveAcessostring · mín: 44 · máx: 44Opcional

Chave de acesso da NF-e

dataHoraNfestring · date-timeOpcional

Data do processamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)

protNfestring · máx: 15Opcional

Número do Protocolo da NF-e e NFS-e

statusNfestring · máx: 3Opcional

Código do status da resposta para a NF-e e NFS-e

codLotestring · máx: 7Opcional

Identificador de Controle do Envio do Lote da NFe

dataHoraDanfestring · date-timeOpcional

Data e Hora da Emissão do DANFE (YYYY-MM-DDTHH:mm:ss.sssZ)

dataHoraCancelaNfestring · date-timeOpcional

Data e Hora do Cancelamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)

protCancelaNfestring · máx: 15Opcional

Número do Protocolo de Cancelamento da NF-e e NFS-e

statusCancelaNfestring · máx: 3Opcional

Código do status do Cancelamento NF-e e NFS-e

tipoEmissaoNfeinteger · enumOpcional

Tipo de Emissão (1 - Normal, 2 - Contingência FS (Formulário Segurança), 3 - Contingência SCAN (Sistema de Contingência Ambiente Nacional), 4 - Contingência EPEC (Evento Prévio de Emissão em Contingência), 5 - Contingência FS-DA, 6 - Contingencia SVC-AN, 7 - Contingencia SVC-RS)

Valores possíveis:

emailNfestring · máx: 50Opcional

E-mail Destinatario que foi enviado arquivo distribuição NF-e

flagReplicadobooleanOpcional

Flag se foi Replicado

CEPEntregastring · máx: 8Opcional

CEP da Entrega

codCondicaoVendaintegerOpcional

Código da Condição de Venda

msgNotaFiscalstring · máx: 1000Opcional

Mensagem para a Nota Fiscal

valorBaseCalcIPIIsentasnumberOpcional

Valor de Base de Cálculo IPI Isentas

valorBaseCalcIPIOutrasnumberOpcional

Valor de Base de Cálculo IPI Outras

valorICMSOutrasnumberOpcional

Valor de Base de Cálculo ICMS Outras

baseCalcComisRepnumberOpcional

Base de Comissão do Representante

percComissaonumberOpcional

Percentual de Comissão do Representante

valorComissaonumberOpcional

Valor da Comissão do Representante

valorDescontoEspecialCapanumberOpcional

Valor do Desconto Especial da Capa

baseComissaoAtendentenumberOpcional

Base de Cálculo de Comissão do Atendente

valorComissaoAtendentenumberOpcional

Valor de Comissão do Atendente

Respostas

200

OK

application/json

dataEmissaostring · dateOpcional

Data de Emissão da Nota Fiscal (YYYY-MM-DD)

codNumNotaintegerOpcional

Código Numérico da Nota

serieintegerOpcional

Série da Nota Fiscal

codTipoDeNotaintegerOpcional

Código do Tipo de Nota

codClienteintegerOpcional

Código do Cliente

codRepresentanteintegerOpcional

Código do Representante

codPedidostringOpcional

Código do Pedido de Venda

percDescontonumberOpcional

Percentual de Desconto

valorFretenumberOpcional

Valor do Frete

valorSeguronumberOpcional

Valor do Seguro

valorLiquidonumberOpcional

Valor Liquido da Nota Fiscal

valorIPInumberOpcional

Valor do IPI

valorTotalnumberOpcional

Valor Total da Nota Fiscal

valorDescNormalnumberOpcional

Valor do Desconto Normal

codNatOperacaointeger · máx: 99999Opcional

Código da Natureza de Operação

situacaointeger · enumOpcional

Situação da Nota Fiscal (1 - Gerada, 2 - Emitidade, 3 - Cancelada)

Valores possíveis:

baseCalcIPInumberOpcional

Base de Cálculo do IPI

valorICMSnaoPagoReducnumberOpcional

Valor do ICMS não Pago Redução

valorICMSSubstitnumberOpcional

Valor do ICMS Substituto

valorICMSIsentasnumberOpcional

Valor do ICMS Isentas

valorIPIIsentasnumberOpcional

Valor do IPI Isentas

valorOutrasDespesasnumberOpcional

Valor de Outras Despesas

baseICMSSubsnumberOpcional

Base do ICMS Substituto

deducICMSNFManausnumberOpcional

Dedução do ICMS para Manaus

percISSnumberOpcional

Percentual do ISS

valorISSnumberOpcional

Valor do ISS

valorPISnumberOpcional

Valor do PIS

valorCOFINSnumberOpcional

Valor do COFINS

basePISnumberOpcional

Base do PIS

baseCofinsnumberOpcional

Base do COFINS

baseRetPISnumberOpcional

Base de Retenção do PIS

valorRetPISnumberOpcional

Valor de Retenção do PIS

baseRetCOFINSnumberOpcional

Base de Retenção do COFINS

valorRetCOFINSnumberOpcional

Valor de Retenção do COFINS

valorPISZFnumberOpcional

Valor do PISZF

valorCOFINSZFnumberOpcional

Valor do COFINSZF

valorDifAliqnumberOpcional

Valor diferença da Aliquota

baseRetCSSLnumberOpcional

Base de Retenção do CSSL

valorRetCSSLnumberOpcional

Valor de Retenção do CSSL

baseRetIRnumberOpcional

Base de Retenção do IR

valorRetIRnumberOpcional

Valor de Retenção do IR

baseRetnumberOpcional

Base de Retenção

valorFECPnumberOpcional

Valor de Retenção do FECP

percRetencaoPISnumberOpcional

Percentual de Retenção do PIS

percRetencaoCOFINSnumberOpcional

Percentual de Retenção do COFINS

percRetencaoCSSLnumberOpcional

Percentual de Retenção do CSSL

percRetencaoIRnumberOpcional

Percentual de Retenção do IR

baseISSnumberOpcional

Base do ISS

valorReducaoISSnumberOpcional

Valor Redução do ISS

codCnaestringOpcional

Código do Cnae

atendimentoPresencialinteger · enumOpcional

Atendimento Presencial (0 - Não se aplica, 1 - Operação presencial, 2 - Operação não presencial, pela internet, 3 - Operação não presencial, Teleatendimento, 5 - Operação presencial fora do estabelecimento, 9 - Operação não presencial outros)

Valores possíveis:

valFCPnumberOpcional

Valor do FCP

valICMSDestnumberOpcional

Valor do ICMS Interestadual para a UF de Destino

valICMSRemnumberOpcional

Valor total do ICMS Interestadual para a UF do Remetente

IPIDevolnumberOpcional

Valor total do IPI Devolvido

valorFCPSTnumberOpcional

Valor do FCP/FECOEP do ST

valorFCPICMSnumberOpcional

Valor FCP ICMS

tipoFreteintegerOpcional

Tipo de Frete

codTransportadoraintegerOpcional

Código da Transportadora

pesoBrutonumberOpcional

Peso Bruto

pesoLiquidonumberOpcional

Peso Liquido

qtdVolumesintegerOpcional

Quantidade de Volumes

especieVolumesstringOpcional

Espécie dos Volumes

dataHoraSaidastring · date-timeOpcional

Data e Hora da Saída (YYYY-MM-DDTHH:mm:ss.sssZ)

codTabelaintegerOpcional

Código da Tabela de Preço

placaVeiculostringOpcional

Placa do Veículo

codEstPlacaVeicstringOpcional

Código do Estado da Placa do Veículo

consumidorFinalinteger · enumOpcional

É para Consumidor Final? (0 - Não, 1 - Sim)

Valores possíveis:

codPortadorintegerOpcional

Código do Portador

codTipoCobrancaintegerOpcional

Código do Tipo de Cobrança

marcastringOpcional

Marca

numeroVolumestringOpcional

Número do Volume

dataHoraGeracaoNFstring · date-timeOpcional

Data e Hora da Geração da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)

obsCancNF1stringOpcional

Observação do Cancelamento da Nota Fiscal

obsCancNF2stringOpcional

Complemento da Observação do Cancelamento da Nota Fiscal

obsCancNF3stringOpcional

Complemento da Observação do Cancelamento da Nota Fiscal

dataGeracao1string · date-timeOpcional

Data e Hora do Cancelamento da Nota Fiscal (YYYY-MM-DDTHH:mm:ss.sssZ)

chaveAcessostringOpcional

Chave de acesso da NF-e

dataHoraNfestring · date-timeOpcional

Data do processamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)

protNfestringOpcional

Número do Protocolo da NF-e e NFS-e

statusNfestringOpcional

Código do status da resposta para a NF-e e NFS-e

codLotestringOpcional

Identificador de controle do envio do lote da NFe

dataHoraDanfestring · date-timeOpcional

Data e Hora da Emissão do DANFE (YYYY-MM-DDTHH:mm:ss.sssZ)

dataHoraCancelaNfestring · date-timeOpcional

Data e Hora do Cancelamento da NF-e e NFS-e (YYYY-MM-DDTHH:mm:ss.sssZ)

protCancelaNfestringOpcional

Número do Protocolo de Cancelamento da NF-e e NFS-e

statusCancelaNfestringOpcional

Código do status do Cancelamento NF-e e NFS-e

tipoEmissaoNfeinteger · enumOpcional

Tipo de Emissão (1 - Normal, 2 - Contingência FS (Formulário Segurança), 3 - Contingência SCAN (Sistema de Contingência Ambiente Nacional), 4 - Contingência EPEC (Evento Prévio de Emissão em Contingência), 5 - Contingência FS-DA, 6 - Contingencia SVC-AN, 7 - Contingencia SVC-RS)

Valores possíveis:

emailNfestringOpcional

E-mail Destinatario que foi enviado arquivo distribuição NF-e

flagReplicadobooleanOpcional

Flag se foi Replicado

baseComissaoAtendentenumberOpcional

Base de Cálculo de Comissão do Atendente

valorComissaoAtendentenumberOpcional

Valor de Comissão do Atendente

valorDescEspecPropCapanumberOpcional

Valor do Desconto Especial Proporcional Capa

valorComissaoRepresentantenumberOpcional

Valor de Comissão do Representante

percComissaoRepresentantenumberOpcional

Percentual de Comissão do Representante

baseComissaoRepresentantenumberOpcional

Base de Comissão do Representante

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

put

/notaFiscalSaida/replicar

HTTPcURLJavaScriptPython

PUT /comercial/v10/notaFiscalSaida/replicar HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 4528

{
  "dataEmissao": "2026-05-08",
  "codNumNota": 1,
  "codTipoDeNota": 1,
  "codCliente": 1,
  "codRepresentante": 1,
  "percDesconto": 1,
  "valorFrete": 1,
  "valorSeguro": 1,
  "valorLiquido": 1,
  "valorIPI": 1,
  "valorTotal": 1,
  "valorDescNormal": 1,
  "codNatOperacao": 1,
  "situacao": 1,
  "baseCalcIPI": 1,
  "valorICMSnaoPagoReduc": 1,
  "valorICMSSubstit": 1,
  "valorICMSIsentas": 1,
  "valorIPIIsentas": 1,
  "valorOutrasDespesas": 1,
  "baseICMSSubs": 1,
  "deducICMSNFManaus": 1,
  "percISS": 1,
  "valorISS": 1,
  "valorPIS": 1,
  "valorCOFINS": 1,
  "basePIS": 1,
  "baseCofins": 1,
  "baseRetPIS": 1,
  "valorRetPIS": 1,
  "baseRetCOFINS": 1,
  "valorRetCOFINS": 1,
  "valorPISZF": 1,
  "valorCOFINSZF": 1,
  "valorDifAliq": 1,
  "baseRetCSSL": 1,
  "valorRetCSSL": 1,
  "baseRetIR": 1,
  "valorRetIR": 1,
  "baseRet": 1,
  "valorFECP": 1,
  "percRetencaoPIS": 1,
  "percRetencaoCOFINS": 1,
  "percRetencaoCSSL": 1,
  "percRetencaoIR": 1,
  "baseISS": 1,
  "valorReducaoISS": 1,
  "codCnae": "text",
  "atendimentoPresencial": 0,
  "valFCP": 1,
  "valICMSDest": 1,
  "valICMSRem": 1,
  "IPIDevol": 1,
  "valorFCPST": 1,
  "valorFCPICMS": 1,
  "tipoFrete": 1,
  "codTransportadora": 1,
  "pesoBruto": 1,
  "pesoLiquido": 1,
  "qtdVolumes": 1,
  "especieVolumes": "text",
  "dataHoraSaida": "2026-05-08T23:26:48.877Z",
  "codTabela": 1,
  "placaVeiculo": "text",
  "codEstPlacaVeic": "text",
  "consumidorFinal": 0,
  "codPortador": 1,
  "codTipoCobranca": 1,
  "marca": "text",
  "numeroVolume": "text",
  "dataHoraGeracaoNF": "2026-05-08T23:26:48.877Z",
  "obsCancNF1": "text",
  "obsCancNF2": "text",
  "obsCancNF3": "text",
  "dataGeracao1": "2026-05-08T23:26:48.877Z",
  "chaveAcesso": "text",
  "dataHoraNfe": "2026-05-08T23:26:48.877Z",
  "protNfe": "text",
  "statusNfe": "text",
  "codLote": "text",
  "dataHoraDanfe": "2026-05-08T23:26:48.877Z",
  "dataHoraCancelaNfe": "2026-05-08T23:26:48.877Z",
  "protCancelaNfe": "text",
  "statusCancelaNfe": "text",
  "tipoEmissaoNfe": 1,
  "emailNfe": "text",
  "flagReplicado": true,
  "CEPEntrega": "text",
  "codCondicaoVenda": 1,
  "msgNotaFiscal": "text",
  "valorBaseCalcIPIIsentas": 1,
  "valorBaseCalcIPIOutras": 1,
  "valorICMSOutras": 1,
  "baseCalcComisRep": 1,
  "percComissao": 1,
  "valorComissao": 1,
  "valorDescontoEspecialCapa": 1,
  "baseComissaoAtendente": 1,
  "valorComissaoAtendente": 1,
  "duplicatas": [
    {
      "tipoPagamento": "boleto",
      "dataEmissao": "2026-05-08",
      "qtdParcela": 1,
      "codPortador": 1,
      "tipoCobranca": 1,
      "condicaoVenda": 1,
      "parcela": [
        {
          "valor": 1,
          "dataVencimento": "2026-05-08",
          "dataPagamento": "2026-05-08",
          "numeroBancario": "text",
          "codAutorizacao": "text",
          "codNSU": "text",
          "baseComissaoAtendente": 1,
          "valorComissaoAtendente": 1,
          "baseComissaoRepresentante": 1,
          "percComissaoRepresentante": 1,
          "valorComissaoRepresentante": 1
        }
      ]
    }
  ],
  "itensNotaFiscalSaida": [
    {
      "codItem": 1,
      "codProduto": "text",
      "qtdFaturada": 1,
      "precoUnitario": 1,
      "valorItem": 1,
      "valorIPI": 1,
      "valorDesconto": 1,
      "codItemPedido": 1,
      "codClassifFiscal": "text",
      "codGrupo": "text",
      "percICMS": 1,
      "valorICMS": 1,
      "percICMSSubst": 1,
      "valorICMSSubstituto": 1,
      "margemLucro": 1,
      "percReducICMS": 1,
      "pesoLiquido": 1,
      "codSitTributICMS": "text",
      "percIPI": 1,
      "codNatOperacao": 1,
      "vlrDescICMSZonaFranca": 1,
      "baseCalcICMS": 1,
      "baseCalcICMSIsenta": 1,
      "baseCalcICMSOutra": 1,
      "baseCalcIPI": 1,
      "baseCalcIPIIsenta": 1,
      "baseCalcIPIOutra": 1,
      "codSitTributIPI": "text",
      "valorDescNaoIncideICMS": 1,
      "baseCalcSTPIS": 1,
      "valorSTPIS": 1,
      "baseCalcSTCOFINS": 1,
      "valorSTCOFINS": 1,
      "valorFreteProp": 1,
      "valorSeguroProp": 1,
      "valorDespAcesProp": 1,
      "valorPISProp": 1,
      "valorCOFINSProp": 1,
      "percPIS": 1,
      "percCOFINS": 1,
      "baseCalcICMSSubst": 1,
      "basePIS": 1,
      "baseCofins": 1,
      "valorPISZF": 1,
      "valorCOFINSZF": 1,
      "valorIPIDescAcess": 1,
      "situaICMS": 0,
      "codCSTPis": "text",
      "codCSTCofins": "text",
      "valorBaseSTRetAnt": 1,
      "valorSTRetAnt": 1,
      "perCreditoIcms": 1,
      "valorCreditoIcms": 1,
      "perReducaoPis": 1,
      "perReducaoCofins": 1,
      "valorDiferencaPis": 1,
      "valorDiferencaCofins": 1,
      "reducaoBaseIcmsST": 1,
      "codCSTCSOSN": "text",
      "numeroPedidoCompra": "text",
      "itemPedidoCompra": 1,
      "aliquotaPIS": 1,
      "aliquotaCOFINS": 1,
      "valorDespesasBaseIcms": 1,
      "codEnquadramentoIPI": 1,
      "baseICMSUFDestino": 1,
      "percFCP": 1,
      "aliqUFDest": 1,
      "aliICMSInt": 1,
      "valorICMSInterestUFDest": 1,
      "valorFCP": 1,
      "valorDescPropTroca": 1,
      "valorDescEspecPropCapa": 1,
      "valorAcrescimo": 1,
      "baseComissaoAtendente": 1,
      "percComissaoAtendente": 1,
      "valorComissaoAtendente": 1,
      "baseComissaoRepresentante": 1,
      "percComissaoRepresentante": 1,
      "valorComissaoRepresentante": 1,
      "cBenef": "text",
      "cCredPresumido": "text",
      "pCredPresumido": 1,
      "vCredPresumido": 1,
      "valorBaseIBSCBS": 1,
      "aliquotaIBSEstadual": 1,
      "valorIBSEstadual": 1,
      "aliquotaIBSMunicipal": 1,
      "valorIBSMunicipal": 1,
      "aliquotaCBS": 1,
      "valorCBS": 1,
      "cClassTribIBSCBS": "text",
      "cstIBSCBS": "text",
      "valorBaseIS": 1,
      "aliquotaIS": 1,
      "valorIS": 1,
      "itemPedidoAgrupado": [
        {
          "codPedido": "text",
          "itemPedido": 1,
          "qtdFaturadaItemPedido": 1
        }
      ],
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

{
  "dataEmissao": "2026-05-08",
  "codNumNota": 1,
  "serie": 1,
  "codTipoDeNota": 1,
  "codCliente": 1,
  "codRepresentante": 1,
  "codPedido": "text",
  "percDesconto": 1,
  "valorFrete": 1,
  "valorSeguro": 1,
  "valorLiquido": 1,
  "valorIPI": 1,
  "valorTotal": 1,
  "valorDescNormal": 1,
  "codNatOperacao": 1,
  "situacao": 1,
  "baseCalcIPI": 1,
  "valorICMSnaoPagoReduc": 1,
  "valorICMSSubstit": 1,
  "valorICMSIsentas": 1,
  "valorIPIIsentas": 1,
  "valorOutrasDespesas": 1,
  "baseICMSSubs": 1,
  "deducICMSNFManaus": 1,
  "percISS": 1,
  "valorISS": 1,
  "valorPIS": 1,
  "valorCOFINS": 1,
  "basePIS": 1,
  "baseCofins": 1,
  "baseRetPIS": 1,
  "valorRetPIS": 1,
  "baseRetCOFINS": 1,
  "valorRetCOFINS": 1,
  "valorPISZF": 1,
  "valorCOFINSZF": 1,
  "valorDifAliq": 1,
  "baseRetCSSL": 1,
  "valorRetCSSL": 1,
  "baseRetIR": 1,
  "valorRetIR": 1,
  "baseRet": 1,
  "valorFECP": 1,
  "percRetencaoPIS": 1,
  "percRetencaoCOFINS": 1,
  "percRetencaoCSSL": 1,
  "percRetencaoIR": 1,
  "baseISS": 1,
  "valorReducaoISS": 1,
  "codCnae": "text",
  "atendimentoPresencial": 0,
  "valFCP": 1,
  "valICMSDest": 1,
  "valICMSRem": 1,
  "IPIDevol": 1,
  "valorFCPST": 1,
  "valorFCPICMS": 1,
  "tipoFrete": 1,
  "codTransportadora": 1,
  "pesoBruto": 1,
  "pesoLiquido": 1,
  "qtdVolumes": 1,
  "especieVolumes": "text",
  "dataHoraSaida": "2026-05-08T23:26:48.877Z",
  "codTabela": 1,
  "placaVeiculo": "text",
  "codEstPlacaVeic": "text",
  "consumidorFinal": 0,
  "codPortador": 1,
  "codTipoCobranca": 1,
  "marca": "text",
  "numeroVolume": "text",
  "dataHoraGeracaoNF": "2026-05-08T23:26:48.877Z",
  "obsCancNF1": "text",
  "obsCancNF2": "text",
  "obsCancNF3": "text",
  "dataGeracao1": "2026-05-08T23:26:48.877Z",
  "chaveAcesso": "text",
  "dataHoraNfe": "2026-05-08T23:26:48.877Z",
  "protNfe": "text",
  "statusNfe": "text",
  "codLote": "text",
  "dataHoraDanfe": "2026-05-08T23:26:48.877Z",
  "dataHoraCancelaNfe": "2026-05-08T23:26:48.877Z",
  "protCancelaNfe": "text",
  "statusCancelaNfe": "text",
  "tipoEmissaoNfe": 1,
  "emailNfe": "text",
  "flagReplicado": true,
  "baseComissaoAtendente": 1,
  "valorComissaoAtendente": 1,
  "valorDescEspecPropCapa": 1,
  "valorComissaoRepresentante": 1,
  "percComissaoRepresentante": 1,
  "baseComissaoRepresentante": 1,
  "itensNotaFiscalSaida": [
    {
      "codItem": 1,
      "codProduto": "text",
      "qtdFaturada": 1,
      "precoUnitario": 1,
      "valorItem": 1,
      "valorIPI": 1,
      "valorDesconto": 1,
      "codItemPedido": 1,
      "codClassifFiscal": "text",
      "codGrupo": "text",
      "percICMS": 1,
      "valorICMS": 1,
      "percICMSSubst": 1,
      "valorICMSSubstituto": 1,
      "margemLucro": 1,
      "percReducICMS": 1,
      "pesoLiquido": 1,
      "codSitTributICMS": "text",
      "percIPI": 1,
      "codNatOperacao": 1,
      "vlrDescICMSZonaFranca": 1,
      "baseCalcICMS": 1,
      "baseCalcICMSIsenta": 1,
      "baseCalcICMSOutra": 1,
      "baseCalcIPI": 1,
      "baseCalcIPIIsenta": 1,
      "baseCalcIPIOutra": 1,
      "codSitTributIPI": "text",
      "valorDescNaoIncideICMS": 1,
      "baseCalcSTPIS": 1,
      "valorSTPIS": 1,
      "baseCalcSTCOFINS": 1,
      "valorSTCOFINS": 1,
      "valorFreteProp": 1,
      "valorSeguroProp": 1,
      "valorDespAcesProp": 1,
      "valorPISProp": 1,
      "valorCOFINSProp": 1,
      "percPIS": 1,
      "percCOFINS": 1,
      "baseCalcICMSSubst": 1,
      "basePIS": 1,
      "baseCofins": 1,
      "valorPISZF": 1,
      "valorCOFINSZF": 1,
      "valorIPIDescAcess": 1,
      "situaICMS": 0,
      "codCSTPis": "text",
      "codCSTCofins": "text",
      "valorBaseSTRetAnt": 1,
      "valorSTRetAnt": 1,
      "perCreditoIcms": 1,
      "valorCreditoIcms": 1,
      "perReducaoPis": 1,
      "perReducaoCofins": 1,
      "valorDiferencaPis": 1,
      "valorDiferencaCofins": 1,
      "reducaoBaseIcmsST": 1,
      "codCSTCSOSN": "text",
      "numeroPedidoCompra": "text",
      "itemPedidoCompra": 1,
      "aliquotaPIS": 1,
      "aliquotaCOFINS": 1,
      "valorDespesasBaseIcms": 1,
      "codEnquadramentoIPI": 1,
      "baseICMSUFDestino": 1,
      "percFCP": 1,
      "aliqUFDest": 1,
      "aliICMSInt": 1,
      "valorICMSInterestUFDest": 1,
      "valorFCP": 1,
      "valorDescPropTroca": 1,
      "valorDescEspecPropCapa": 1,
      "valorAcrescimo": 1,
      "baseComissaoAtendente": 1,
      "percComissaoAtendente": 1,
      "valorComissaoAtendente": 1,
      "baseComissaoRepresentante": 1,
      "percComissaoRepresentante": 1,
      "valorComissaoRepresentante": 1,
      "cBenef": "text",
      "cCredPresumido": "text",
      "pCredPresumido": 1,
      "vCredPresumido": 1,
      "valorBaseIBSCBS": 1,
      "aliquotaIBSEstadual": 1,
      "valorIBSEstadual": 1,
      "aliquotaIBSMunicipal": 1,
      "valorIBSMunicipal": 1,
      "aliquotaCBS": 1,
      "valorCBS": 1,
      "cClassTribIBSCBS": "text",
      "cstIBSCBS": "text",
      "valorBaseIS": 1,
      "aliquotaIS": 1,
      "valorIS": 1,
      "itemPedidoAgrupado": [
        {
          "codPedido": "text",
          "itemPedido": 1,
          "qtdFaturadaItemPedido": 1
        }
      ],
      "dadosCustomizados": [
        {
          "campo": "text",
          "valor": "text"
        }
      ]
    }
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Obter Etiquetas Tinto de uma Nota Fiscal de Saída

get

https://localhost/comercial/v10http://localhost/comercial/v10

/notaFiscalSaida/{id}/etiquetaTinto

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de rota

idstringObrigatório

Chave da Nota Fiscal de Saída

Parâmetros de consulta

continuationTokenstring · anulávelOpcional

Identificador da Paginação da Consulta

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

OK

application/json

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/notaFiscalSaida/{id}/etiquetaTinto

HTTPcURLJavaScriptPython

GET /comercial/v10/notaFiscalSaida/{id}/etiquetaTinto HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

[
  {
    "data": [
      {
        "dataEmissaoNF": "2026-05-08",
        "notaFiscal": 1,
        "itemNota": 1,
        "etiquetas": [
          {
            "codProduto": "text",
            "codEtiqueta": "text"
          }
        ]
      }
    ]
  }
]

Obter a Segunda via de Notas Fiscais de Saída Emitidas em Determinado Período

get

https://localhost/comercial/v10http://localhost/comercial/v10

/notaFiscalDanfe

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de consulta

clientestringObrigatório

CPF/CNPJ do Cliente

dataIniciostringObrigatório

Data de Início de um Intervalo de Tempo (YYYY-MM-DD)

dataFimstringObrigatório

Data de Término de um Intervalo de Tempo (YYYY-MM-DD)

mascarasinteger[] · anulávelOpcional

Código da Máscara do Produto

tipoFiltroMascarainteger · anulávelOpcional

Tipo do Filtro da Máscara do Produto: 1 - Desconsiderar Nota Fiscal, 2 - Considerar Nota Fiscal

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

OK

application/json

arquivostring · byteOpcional

Arquivo com a DANFE da Nota Fiscal

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/notaFiscalDanfe

HTTPcURLJavaScriptPython

GET /comercial/v10/notaFiscalDanfe?cliente=text&dataInicio=text&dataFim=text HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "arquivo": "Ynl0ZXM="
}

Obter a Segunda via de uma Nota Fiscal

get

https://localhost/comercial/v10http://localhost/comercial/v10

/danfeNotaFiscal

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de consulta

dataEmissaostringObrigatório

Data de Emissão da Nota Fiscal (YYYY-MM-DD)

codNotastringObrigatório

Código da Nota Fiscal

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

OK

application/json

arquivostring · byteOpcional

Arquivo com a DANFE da Nota Fiscal

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/danfeNotaFiscal

HTTPcURLJavaScriptPython

GET /comercial/v10/danfeNotaFiscal?dataEmissao=text&codNota=text HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "arquivo": "Ynl0ZXM="
}

Obter XML de Nota Fiscal

get

https://localhost/comercial/v10http://localhost/comercial/v10

/notaFiscalXML

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de consulta

dataEmissaostringObrigatório

Data de Emissão da Nota Fiscal (YYYY-MM-DD)

codNotastringObrigatório

Código da Nota Fiscal

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

OK

application/json

arquivostring · byteOpcional

Arquivo com o XML da Nota Fiscal

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/notaFiscalXML

HTTPcURLJavaScriptPython

GET /comercial/v10/notaFiscalXML?dataEmissao=text&codNota=text HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "arquivo": "Ynl0ZXM="
}

Obter a Segunda via de Notas Fiscais de Saída pelo ID do Evento

get

https://localhost/comercial/v10http://localhost/comercial/v10

/notaFiscalEvento

Autorizações

csw_auth

AuthorizationstringObrigatório

Parâmetros de consulta

idEventostringObrigatório

id da nota obtido na api de eventos

Parâmetros de cabeçalho

empresastringObrigatório

Código da Empresa

Respostas

200

OK

application/json

arquivostring · byteOpcional

Obtem uma Nota Fiscal pelo ID do Evento

400

Bad Request

application/json

429

Too Many Requests

500

Internal Server Error

application/json

get

/notaFiscalEvento

HTTPcURLJavaScriptPython

GET /comercial/v10/notaFiscalEvento?idEvento=text HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Accept: */*

{
  "arquivo": "Ynl0ZXM="
}