Seleção Especial

selecaoespecial

Gerar Seleção Especial

put
/selecaoespecial
Autorizações
AuthorizationstringObrigatório
Parâmetros de cabeçalho
empresastringObrigatório

Código da Empresa no ERP Consistem

Corpo
codClienteinteger · máx: 99999999999999Obrigatório

Código do Cliente

codRepresentanteinteger · máx: 9999Obrigatório

Código do Representante

codTipoNotainteger · máx: 9999Obrigatório

Tipo de Nota

consumoPropriointeger · enumObrigatório

Consumo Próprio (0 - Não, 1 - Sim)

Valores possíveis:
condicaoVendainteger · máx: 9999Obrigatório

Condição de Venda

codAtendenteinteger · máx: 9999Opcional

Atendente

cfopinteger · máx: 9Opcional

Primeiro Dígito da Cfop

codTransportadorainteger · máx: 9999Opcional

Código da Transportadora

tipoFreteinteger · máx: 9999Opcional

Código do Tipo de Frete

tabelaPrecointeger · máx: 9999Opcional

Código da Tablea de Preço

valorOutrasDespesasnumber · mín: 0.01 · máx: 9999999999.99Opcional

Valor de Outras Despesas

desconto1number · mín: 0.01 · máx: 99.99Opcional

Porcentagem de Desconto 1

desconto2number · mín: 0.01 · máx: 99.99Opcional

Porcentagem de Desconto 2

desconto3number · mín: 0.01 · máx: 99.99Opcional

Porcentagem de Desconto 3

desconto4number · mín: 0.01 · máx: 99.99Opcional

Porcentagem de Desconto 4

acrescimo1number · mín: 0.01 · máx: 99.99Opcional

Porcentagem de Acréscimo 1

acrescimo2number · mín: 0.01 · máx: 99.99Opcional

Porcentagem de Acréscimo 2

acrescimo3number · mín: 0.01 · máx: 99.99Opcional

Porcentagem de Acréscimo 3

acrescimo4number · mín: 0.01 · máx: 99.99Opcional

Porcentagem de Acréscimo 4

valorAntecipadonumber · mín: 0.01 · máx: 999999999999.99Opcional

Valor Antecipado

valorDescontonumber · mín: 0.01 · máx: 999999999999.99Opcional

Valor Desconto

pedidoClientestring · máx: 15Opcional

Código do Pedido do Cliente

pedidoRepresentantestring · máx: 10Opcional

Código do Pedido do Representante

atendimentoPresencialinteger · enumObrigatório

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,9-operação Não Presencial, Outros) (0 - NAO SE APLICA, 1 - OPERACAO PRESENCIAL, 2 - OPERACAO NAO PRESENCIAL PELA INTERNET, 3 - OPERACAO NAO PRESENCIAL TELEATENDIMENTO, 5 - OPERAÇÃO PRESENCIAL FORA DO ESTABELECIMENTO, 9 - OPERACAO NAO PRESENCIAL OUTROS)

Valores possíveis:
intermediadorTransacaointeger · máx: 999Opcional

Intermediador da Transação

retiraICMSbasePisCofinsinteger · enumObrigatório

Retirar Icms da Base Pis/cofins (0 - Não, 1 - Sim)

Valores possíveis:
processoRegimeEspecialstring · máx: 60Opcional

Processo/ato Concessório Regime Especial

origemProcessointeger · enumOpcional

Origem do Processo (0 - SEFAZ, 1 - Justiça Federal, 2 - Justiça Estadual, 3 - Secex/RFB, 9 - Outros)

Valores possíveis:
tipoAtointeger · enumOpcional

Tipo do Ato Concessório (8 - Termo de Acordo, 10 - Regime Especial, 12 - Autorização específica)

Valores possíveis:
obsRegimeEspecialinteger · máx: 9999Opcional

Observação Regime Especial

seguroSocialinteger · enumOpcional

Seguro Social (0 - Não, 1 - Sim)

Valores possíveis:
estruturaComercialintegerOpcional

Estrutura Comercial

codRedespachointegerOpcional

Transportadora de Redespacho

tipoFreteRedespachointeger · máx: 99Opcional

Tipo de Frete de Redespacho

valorFretenumber · mín: 0.001 · máx: 999999999999.99Opcional

Valor do Frete

valorSeguronumber · mín: 0.001 · máx: 999999999999.99Opcional

Valor do Seguro

calcPesointeger · enumOpcional

Calcular Peso Automaticamente (0 - Não, 1 - Sim)

Valores possíveis:
pesoLiquidonumber · máx: 99999999.999Opcional

Peso Líquido

pesoBrutonumber · máx: 99999999.999Opcional

Peso Bruto

qtdVolumesinteger · máx: 9999999999Opcional

Quantidade de Volumes

especieVolumesstring · máx: 60Opcional

Espécie de Volume

qtdPecasinteger · máx: 999Opcional

Quantidade de Peças da Seleção Especial

dataSaidastring · dateOpcional

Data de Saída (YYYY-MM-DD)

horaSaidastring · mín: 5 · máx: 5Opcional

Hora do Cálculo (HH:MM)

Example: 00:00Pattern: ^([01]\d|2[0-3]):[0-5]\d$
placastring · máx: 7Opcional

Placa do Veículo

ufPlacastring · máx: 2Opcional

uf da Placa

cpfMotoristastring · mín: 1 · máx: 14Opcional

Cpf do Motorista (sem formatação

nomeMotoristastring · máx: 20Opcional

Nome do Motorista

vencimentoEspstring · date[] · máx: 18Opcional

Dias de Vencimento Especial (Obrigatório para condição de venda 99)

codPortadorinteger · máx: 9999Opcional

Código do Portador

tipoCobrancainteger · máx: 9999Opcional

Código do Tipo de Cobrança

percDescDuplicatanumber · máx: 99.99Opcional

Porcentagem de Desconto da Duplicata

diasDescDuplicatainteger · máx: 99Opcional

Dias de Desconto da Duplicata

ajustaValorManualintegerOpcional

Ajustar Valor/Vencimento Manualmente (0 - Não, 1 - Sim)

formaPagamentostring · enumOpcional

Forma de Pagamento (01 - Dinheiro, 02 - Cheque, 03 - Cartão de Crédito, 04 - Cartão de Débito, 05 - Crédito Loja, 10 - Vale Alimentação, 11 - Vale Refeição, 12 - Vale Presente, 13 - Vale Combustível, 15 - Boleto Bancário, 16 - Depósito Bancário, 17 - Pagamento Instantâneo (Pix) QR-Code - Estático, 18 - Transferência bancária, 19 - Carteira Digital, 20 - Pagamento Instantâneo (Pix) - Estático, 21 - Crédito em Loja, 22 - Pagamento Eletrônico não Informado - falha de hardware do sistema emissor, 90 - Sem pagamento, 99 - Outros)

Valores possíveis:
dataPagamentostring · dateOpcional

Data de Saída (YYYY-MM-DD)

cnpjLocalPagamentostring · @'?.12AN2NOpcional

CNPJ Local do Pagamento

ufLocalPagamentostring · máx: 2Opcional

UF do Local do Pagamento

tipoIntegracaointeger · enumOpcional

Tipo de Integração com a Máquina de Cartão (1 - Pagamento integrado com o sistema de automação da empresa, 2 - Pagamento não integrado com o sistema de automação da empresa)

Valores possíveis:
cnpjCredenciadorastring · @'?.12AN2NOpcional

CNPJ da Credenciadora

bandeiraOperadorastring · enumOpcional

Bandeira da Operadora (1 - Visa, 2 - Mastercard, 3 - American Express, 4 - Sorocred, 5 - Diners Club, 6 - Elo, 7 - Hipercard, 8 - Aura, 9 - Cabal, 99 - Outros)

Valores possíveis:
autorizacaoOpCartaostring · máx: 20Opcional

Código da Autorização da Operação

cnpjBeneficiarioPagamentostring · @'?.12AN2NOpcional

CNPJ Beneficiário do Pagamento

terminalPagamentostring · máx: 40Opcional

Terminal de Pagamento

codMensagemNotainteger · máx: 999Opcional

Código da Mensagem

obsNotastring · máx: 1000Opcional

Observações Para Nota

nomeTagstring · máx: 20Opcional

Nome da Tag

conteudoTagstring · máx: 60Opcional

Conteúdo da TAG

motivoEstornostring · máx: 55Opcional

Motivo do estorno - nota fiscal de ajuste

outraIEClientestring · máx: 15Opcional

Cliente Inscrição Estadual

outraIETransportadorastring · máx: 15Opcional

Transportadora Inscrição Estadual

localEntregastring · máx: 40Opcional

Nome do Local de Entrega

enderecoEntregastring · máx: 40Opcional

Endereco do Local de Entrega

numeroCasastring · máx: 10Opcional

Número do Endereço

complementoEntregastring · máx: 60Opcional

Complemento do Endereço

bairroEntregastring · máx: 60Opcional

Bairro de Entrega

cepEntregainteger · máx: 99999999Opcional

Cep do Local de Entrega

cnpjcpfEntregainteger · máx: 99999999999999Opcional

Cgc do Local de Entrega

ieEntregastring · máx: 18Opcional

Incricao Estadual do Local de Entrega

foneEntregastring · máx: 20Opcional

Telefone de Entrega

horaEntregastring · mín: 5 · máx: 5Opcional

Horario de Entrega (HH:MM)

Example: 00:00Pattern: ^([01]\d|2[0-3]):[0-5]\d$
codLocalColetainteger · máx: 99999Opcional

Código do Local de Coleta

ufEmbarquestring · máx: 2Opcional

UF de Embarque

localEmbarquestring · máx: 50Opcional

Local de Embarque

recintoAlfandegadostring · máx: 50Opcional

Recinto Alfandegado

Respostas
200

OK

application/json
put
/selecaoespecial
PUT /selecaoespecial/v10/selecaoespecial HTTP/1.1
Host: localhost
Authorization: YOUR_API_KEY
empresa: text
Content-Type: application/json
Accept: */*
Content-Length: 2642

{
  "codCliente": 1,
  "codRepresentante": 1,
  "codTipoNota": 1,
  "consumoProprio": 0,
  "condicaoVenda": 1,
  "codAtendente": 1,
  "cfop": 1,
  "codTransportadora": 1,
  "tipoFrete": 1,
  "tabelaPreco": 1,
  "valorOutrasDespesas": 1,
  "desconto1": 1,
  "desconto2": 1,
  "desconto3": 1,
  "desconto4": 1,
  "acrescimo1": 1,
  "acrescimo2": 1,
  "acrescimo3": 1,
  "acrescimo4": 1,
  "valorAntecipado": 1,
  "valorDesconto": 1,
  "pedidoCliente": "text",
  "pedidoRepresentante": "text",
  "atendimentoPresencial": 0,
  "intermediadorTransacao": 1,
  "retiraICMSbasePisCofins": 0,
  "processoRegimeEspecial": "text",
  "origemProcesso": 0,
  "tipoAto": 8,
  "obsRegimeEspecial": 1,
  "seguroSocial": 0,
  "estruturaComercial": 1,
  "codRedespacho": 1,
  "tipoFreteRedespacho": 1,
  "valorFrete": 1,
  "valorSeguro": 1,
  "calcPeso": 0,
  "pesoLiquido": 1,
  "pesoBruto": 1,
  "qtdVolumes": 1,
  "especieVolumes": "text",
  "qtdPecas": 1,
  "dataSaida": "2025-11-29",
  "horaSaida": "00:00",
  "placa": "text",
  "ufPlaca": "text",
  "cpfMotorista": "text",
  "nomeMotorista": "text",
  "vencimentoEsp": [
    "2025-11-29"
  ],
  "codPortador": 1,
  "tipoCobranca": 1,
  "percDescDuplicata": 1,
  "diasDescDuplicata": 1,
  "ajustaValorManual": 1,
  "formaPagamento": "01",
  "dataPagamento": "2025-11-29",
  "cnpjLocalPagamento": "text",
  "ufLocalPagamento": "text",
  "tipoIntegracao": 1,
  "cnpjCredenciadora": "text",
  "bandeiraOperadora": "01",
  "autorizacaoOpCartao": "text",
  "cnpjBeneficiarioPagamento": "text",
  "terminalPagamento": "text",
  "codMensagemNota": 1,
  "obsNota": "text",
  "nomeTag": "text",
  "conteudoTag": "text",
  "motivoEstorno": "text",
  "outraIECliente": "text",
  "outraIETransportadora": "text",
  "localEntrega": "text",
  "enderecoEntrega": "text",
  "numeroCasa": "text",
  "complementoEntrega": "text",
  "bairroEntrega": "text",
  "cepEntrega": 1,
  "cnpjcpfEntrega": 1,
  "ieEntrega": "text",
  "foneEntrega": "text",
  "horaEntrega": "00:00",
  "codLocalColeta": 1,
  "ufEmbarque": "text",
  "localEmbarque": "text",
  "recintoAlfandegado": "text",
  "docReferenciados": [
    {
      "chaveNFeReferenciada": "text"
    }
  ],
  "ItensSelecaoEspecial": [
    {
      "codProduto": 1,
      "descricaoProduto": "text",
      "unidade": "text",
      "quantidade": 1,
      "precoUnitario": 1,
      "percentualIPI": 1,
      "ncm": 1,
      "percentualICMS": 1,
      "percentualComissaoRepresentante": 1,
      "percentualComissaoAtendente": 1,
      "origemMercadoria": 0,
      "classificacaoFinalidade": 1,
      "percentualReducaoIcms": 1,
      "codMsgRedIcms": 1,
      "baseST": 1,
      "valorST": 1,
      "aliquotaST": 1,
      "percentualMVAST": 1,
      "percentualFCPST": 1,
      "valorFCPST": 1,
      "itemPedidoCliente": 1,
      "valorIPIDevolvido": 1,
      "cBenef": "text",
      "transacaoEstoque": 1,
      "codCest": 1,
      "codFinalidade": 1,
      "codigoANP": 1,
      "percentualDifalDevolucao": 1,
      "qtdTributadaRetida": 1,
      "aliquotaADRemRetido": 1,
      "valorIcmsRetido": 1,
      "percentualBiodiesel": 1,
      "ExportacaoIndireta": [
        {
          "registroExportacao": 1,
          "chaveNFe": "text",
          "qtdExportada": 1
        }
      ],
      "Drawback": [
        {
          "atoConsessorioDrawback": 1
        }
      ]
    }
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}
{
  "codSelecaoGerada": 1,
  "codCliente": 1,
  "codRepresentante": 1,
  "codTipoNota": 1,
  "consumoProprio": 0,
  "condicaoVenda": 1,
  "codAtendente": 1,
  "cfop": 1,
  "codTransportadora": 1,
  "tipoFrete": 1,
  "tabelaPreco": 1,
  "valorOutrasDespesas": 1,
  "desconto1": 1,
  "desconto2": 1,
  "desconto3": 1,
  "desconto4": 1,
  "acrescimo1": 1,
  "acrescimo2": 1,
  "acrescimo3": 1,
  "acrescimo4": 1,
  "valorAntecipado": 1,
  "valorDesconto": 1,
  "pedidoCliente": "text",
  "pedidoRepresentante": "text",
  "atendimentoPresencial": 0,
  "intermediadorTransacao": 1,
  "retiraICMSbasePisCofins": 0,
  "processoRegimeEspecial": "text",
  "origemProcesso": 0,
  "tipoAto": 8,
  "obsRegimeEspecial": 1,
  "seguroSocial": 0,
  "estruturaComercial": 1,
  "codRedespacho": 1,
  "tipoFreteRedespacho": 1,
  "valorFrete": 1,
  "valorSeguro": 1,
  "calcPeso": 0,
  "pesoLiquido": 1,
  "pesoBruto": 1,
  "qtdVolumes": 1,
  "especieVolumes": "text",
  "qtdPecas": 1,
  "dataSaida": "2025-11-29",
  "horaSaida": "00:00",
  "placa": "text",
  "ufPlaca": "text",
  "cpfMotorista": "text",
  "nomeMotorista": "text",
  "vencimentoEsp": [
    "2025-11-29"
  ],
  "codPortador": 1,
  "tipoCobranca": 1,
  "percDescDuplicata": 1,
  "diasDescDuplicata": 1,
  "ajustaValorManual": 0,
  "formaPagamento": "01",
  "dataPagamento": "2025-11-29",
  "cnpjLocalPagamento": "text",
  "ufLocalPagamento": "text",
  "tipoIntegracao": 1,
  "cnpjCredenciadora": "text",
  "bandeiraOperadora": 1,
  "autorizacaoOpCartao": "text",
  "cnpjBeneficiarioPagamento": "text",
  "terminalPagamento": "text",
  "codMensagemNota": 1,
  "obsNota": "text",
  "nomeTag": "text",
  "conteudoTag": "text",
  "motivoEstorno": "text",
  "outraIECliente": "text",
  "outraIETransportadora": "text",
  "localEntrega": "text",
  "enderecoEntrega": "text",
  "numeroCasa": "text",
  "complementoEntrega": "text",
  "bairroEntrega": "text",
  "cepEntrega": 1,
  "cnpjcpfEntrega": 1,
  "ieEntrega": "text",
  "foneEntrega": "text",
  "horaEntrega": "00:00",
  "codLocalColeta": 1,
  "ufEmbarque": "text",
  "localEmbarque": "text",
  "recintoAlfandegado": "text",
  "docReferenciados": [
    {
      "chaveNFeReferenciada": "text"
    }
  ],
  "ItensSelecaoEspecial": [
    {
      "codProduto": 1,
      "descricaoProduto": "text",
      "unidade": "text",
      "quantidade": 1,
      "precoUnitario": 1,
      "percentualIPI": 1,
      "ncm": 1,
      "percentualICMS": 1,
      "percentualComissaoRepresentante": 1,
      "percentualComissaoAtendente": 1,
      "origemMercadoria": 0,
      "classificacaoFinalidade": 1,
      "percentualReducaoIcms": 1,
      "codMsgRedIcms": 1,
      "baseST": 1,
      "valorST": 1,
      "aliquotaST": 1,
      "percentualMVAST": 1,
      "percentualFCPST": 1,
      "valorFCPST": 1,
      "itemPedidoCliente": 1,
      "valorIPIDevolvido": 1,
      "cBenef": "text",
      "transacaoEstoque": 1,
      "codCest": 1,
      "codFinalidade": 1,
      "codigoANP": 1,
      "percentualDifalDevolucao": 1,
      "qtdTributadaRetida": 1,
      "aliquotaADRemRetido": 1,
      "valorIcmsRetido": 1,
      "percentualBiodiesel": 1,
      "ExportacaoIndireta": [
        {
          "registroExportacao": 1,
          "chaveNFe": "text",
          "qtdExportada": 1
        }
      ],
      "Drawback": [
        {
          "atoConsessorioDrawback": 1
        }
      ]
    }
  ],
  "dadosCustomizados": [
    {
      "campo": "text",
      "valor": "text"
    }
  ]
}

Atualizado