Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Objetivo

Método que disponibiliza informações de Pedidos de Compras e os produtos constante nestes.

Chamada

GET /api/v1/vendas?
/PedidoCompras/consulta-pedido-compra-detalhado

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
NumeroCupom
NumeroPedidoNúmero do
cupom
pedido.integerNenhum.
NumeroEmpresaNúmero da empresa.integer

Nenhum.

CNPJ
CNPJEmpresaÉ o número do CNPJ da empresa. Formato: 00000000000000 (14 dígitos)string
Nenhum.
Obrigatório
numeroPDV
CNPJFornecedor
Número do PDV
É o número do CNPJ fornecedor. Formato: 00000000000000 (14 dígitos).string
integer
Nenhum.
dataInicioVendas
DataInicioEmissaoData início
das vendas – Obrigatório –
da emissão do pedido Formato: yyyy-MM-dd Obrigatório.stringObrigatório.

Tamanho máximo: 10

Tamanho mínimo: 10

DataFimEmissaoData fim da emissão do pedido
dataFimVendasData fim das vendas – Obrigatório –
Formato: yyyy-MM-
dd
dd stringObrigatório

Tamanho máximo: 10

Tamanho mínimo: 10

tipoVendaTipo da venda (Opções: P – PDV / E – ERP)stringNenhum
.
_pageNo
integerNenhum.
_pageSize
integerNenhum.

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Descrição do

...

Recurso (Resource Description)

...

VendasRespostaDTO – lista de vendas

...


Nome (

Name
)(
Descrição 
Description
)(
Tipo 
Type
)(
Informações Adicionais 
Adittional Information
)
cpfClienteCPF do ClientestringNenhum.numeroNotaNúmero do cupomintegerNenhum.numeroEmpresa
Topo




NumeroPedidoNúmero do pedido Integer

NumeroEmpresaNúmero da empresa
integerNenhum.
Integer

CnpjEmpresa
CNPJ
CNPJ da empresa
Formato: 00000000000000 (14 dígitos)
string
Nenhum.numeroPDVNúmero PDVintegerNenhum.numeroSerieEcf

Número de série do emissor de cupom fiscal

stringNenhum.serieNota

Série da nota

stringNenhum.CodigoVendedorCódigo do VendedorintegerNenhum.codigoOperadorCódigo do Operador de PDVintegerNenhum.valorTotalValor total da vendadecimal numberNenhum.dataVendaData da vendadateNenhum.valorDescontoValor de desconto da vendadecimal numberNenhum.valorAcrescimoValor de acréscimo da vendadecimal numberNenhum.situacaoSituação do cupomstringV=Valido; C=CanceladotipoVendaIndicador do tipo de venda (Opções: P – PDV / E – ERP)stringNenhum.chaveAcessoChave do cupomsample stringNenhum.itensLista de itens da vendaColeção de ItemVendaRespostaDtoNenhum.


RazaoSocialEmpresaRazão social da empresa que fez o pedido para o fornecedorsample string

TipoPedidoTipo do Pedido. C - Comprastring

CnpjFornecedorCNPJ do fornecedor
Formato: 00000000000000 (14 dígitos)
string

RazaoFornecedorRazão social do fornecedorsample string

FreteTipo de frete do pedido. (CIF, FOB)string

DataEmissãoData de emissão do pedidoDate

DataRecebimentoData de recebimento do pedidoDate

DataLimiteRecebimentoData limite para recebimento do pedidoDate

PrazoPagamentoPrazo de pagamento ao fornecedorstring

CompradorNome do comprador do pedidosample string
Itens




codigoProdutoCódigo sequencial do produto no ERPinteger
Nenhum.EAN


DunCódigo
de barras EAN ou DUN
DUN referente a embalagem do produtosample string
Nenhum.descricao


EanCódigo ean cadastrado no produto, retornar sempre o maiorsample string

DescricaoDescrição do
produto 
Produtosample string
Nenhum.sequenciaSequencia do item no cupomintegerNenhum.quantidadeQuantidade decimal numberNenhum.valorUnitarioValor unitário do item decimal numberNenhum.valorTotalItem

Valor total do item 

decimal numberNenhum.valorDescontoItemValor do desconto do itemdecimal numberNenhum.valorAcrescimoItemValor de acréscimo no itemdecimal numberNenhum.custoLiquidoFiscalCusto líquido fiscal do itemdecimal numberCusto Líquido Fiscal multiplicado pela quantidade de venda.situacaoItemSituação do item no cupomsample stringV=Valido; C=CanceladofinalizadorasLista de finalizadoras da vendaColeção de FinalizadoraVendaRespostaDtoNenhum.tipoPagamentoTipo de pagamentosample stringNenhum.valorPagamentoRealizadoValor do págamento realizado decimal numberNenhum.origemPedidoIndicador da origem do PedidostringOpções = P - PDV / E - Ecommerce / T - TelevendascustoLiquidoFiscalCusto líquido fiscal do item decimal numberCusto Líquido Fiscal multiplicado pela quantidade de venda.pessoasLista de pessoas da vendaDoctoPessoaDtoNenhum.pessoasFidelidadeLista de pessoas fidelizadasColeção de pessoasFidelidadeVendaRespostaDtoNenhum.codParceiroCódigo Parceiro do programa de fidelidadeintegerNenhum.CNPJCPFCNPJ ou CPF do parceirostringNenhum.


EmbalagemEmbalagem do produto. Ex: CXsample string

QtdembalagemQuantidade constante na embalagem do produto Ex: 12sample string

QuantidadeQuantidade comprada do produtosample string

ValorUnitarioValor unitário do item decimal number

ValorItemValor unitário multiplicado pela quantidadedecimal number

ValorBrutoCusto bruto com os impostosdecimal number

ValorIpiValor do IPIdecimal number

ValorIcmsstValor do ICMSSTdecimal number

ValorFcpstValor do FCP STdecimal number

ValorDespesasValor das despesasdecimal number

PercDesctoFinanceiroPercentual de desconto financeirodecimal number


Formatos de Resposta (Response Formats)

application/json, text/json

Exemplo (Sample):

[

...

application/xml, text/xml

Exemplo (Sample):

...


    {
        "numeroPedido"22,
        "numeroEmpresa"1,
        "cnpjEmpresa""10010000000126",
        "razaoSocialEmpresa""EMPRESA 001",
        "tipoPedido""C",
        "cnpjFornecedor""19900000000842",
        "razaoFornecedor""FORNECEDOR MODELO 1",
        "frete""CIF",
        "dataEmissao""07/05/2019",
        "dataRecebimento""11/05/2019",
        "dataLimiteRecebimento"null,
        "prazoPagamento""21",
        "comprador""ANTONIO COMPRADOR",
        "itens": [
            {
                "codigoProduto"321,
                "dun""",
                "ean""",
                "descricao""PRODUTO MODELO 100G MORANGO",
                "embalagem""UN",
                "qtdEmbalagem""1",
                "quantidade""15",
                "valorUnitario""1,50",
                "valorItem""22,50",
                "valorBruto""25,48",
                "valorIpi""0,00",
                "valorIcmsst""2,98",
                "valorFcpst""0,00",
                "valorDespesas""0,00",
                "percDesctoFinanceiro""0,00"
            },
            {
                "codigoProduto"361,
                "dun""",
                "ean""7897500600815",
                "descricao""PRODUTO MODELO 450G UVA",
                "embalagem""CX",
                "qtdEmbalagem""10",
                "quantidade""15",
                "valorUnitario""3,00",
                "valorItem""450,00",
                "valorBruto""509,62",
                "valorIpi""0,00",
                "valorIcmsst""59,62",
                "valorFcpst""0,00",
                "valorDespesas""0,00",
                "percDesctoFinanceiro""0,00"
            },
            {
                "codigoProduto"362,
                "dun""",
                "ean""",
                "descricao""FAMILIA SORTER C",
                "embalagem""PC",
                "qtdEmbalagem""240",
                "quantidade""15",
                "valorUnitario""12,50",
                "valorItem""45.000,00",
                "valorBruto""50.962,50",
                "valorIpi""0,00",
                "valorIcmsst""5.962,50",
                "valorFcpst""0,00",
                "valorDespesas""0,00",
                "percDesctoFinanceiro""0,00"
            },
            {
                "codigoProduto"363,
                "dun""",
                "ean""",
                "descricao""FAMILIA SORTER D",
                "embalagem""CJ",
                "qtdEmbalagem""12",
                "quantidade""15",
                "valorUnitario""1,67",
                "valorItem""299,88",
                "valorBruto""339,61",
                "valorIpi""0,00",
                "valorIcmsst""39,73",
                "valorFcpst""0,00",
                "valorDespesas""0,00",
                "percDesctoFinanceiro""0,00"
            }
        ]
    }

]