Á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

/api/v1/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)
NumeroPedidoNúmero do pedido.integerNenhum.
NumeroEmpresaNúmero da empresa.integer

Nenhum.

CNPJEmpresaÉ o número do CNPJ da empresa. Formato: 00000000000000 (14 dígitos). stringObrigatório
CNPJFornecedorÉ o número do CNPJ fornecedor. Formato: 00000000000000 (14 dígitos).stringNenhum.
DataInicioEmissaoData início da emissão do pedido Formato: yyyy-MM-dd Obrigatório.stringObrigatório.
DataFimEmissaoData fim da emissão do pedido Formato: yyyy-MM-dd stringObrigatório.
_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)



NameDescriptionTypeAdittional Information
Topo




NumeroPedidoNúmero do pedido Integer

NumeroEmpresaNúmero da empresaInteger

CnpjEmpresaCNPJ da empresa
Formato: 00000000000000 (14 dígitos)
string

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

DunCódigo DUN referente a embalagem do produtosample string

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

DescricaoDescrição do Produtosample string

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

[
  {
    "cpfCliente": "sample string 1",
    "numeroNota": 2,
    "numeroEmpresa": 3,
    "CNPJ": "sample string 4",
    "numeroPDV": 1,
"numeroSerieEcf": string optional,
"serieNota": string optional,
"codigoVendedor": 1,
"codigoOperador": 1, "valorTotal": 7.0, "dataVenda": "2020-05-13T10:42:46.7840029-03:00", "valorDesconto": 1.0, "valorAcrescimo": 1.0, "situacao": "sample string 9", "tipoVenda": "sample string 10",
"origemPedido": "sample string 10", "itens": [ { "codigoProduto": 1, "EAN": "sample string 2", "descricao": "sample string 3", "sequencia": 4, "quantidade": 5.1, "valorUnitario": 6.1, "valorTotalItem": 7.0, "valorDescontoItem": 1.0, "valorAcrescimoItem": 1.0,
"custoLiquidoFiscal":1.0, "situacaoItem": "sample string 8"
}, { "codigoProduto": 1, "EAN": "sample string 2", "descricao": "sample string 3", "sequencia": 4, "quantidade": 5.1, "valorUnitario": 6.1, "valorTotalItem": 7.0, "valorDescontoItem": 1.0, "valorAcrescimoItem": 1.0,
"custoLiquidoFiscal":1.0, "situacaoItem": "sample string 8" } ], "finalizadoras": [ { "tipoPagamento": "sample string 1", "valorPagamentoRealizado": 1.0 }, { "tipoPagamento": "sample string 1", "valorPagamentoRealizado": 1.0
} ],
"pessoasFidelidade": [
{
"codParceiro": "integer",
"CNPJCPF": "string"
}
] }, { "cpfCliente": "sample string 1", "numeroNota": 2, "numeroEmpresa": 3, "CNPJ": "sample string 4", "numeroPDV": 1,
"numeroSerieEcf": string optional,
"serieNota": string optional,
"codigoVendedor": 1,
"codigoOperador": 1, "valorTotal": 7.0, "dataVenda": "2020-05-13T10:42:46.7840029-03:00", "valorDesconto": 1.0, "valorAcrescimo": 1.0, "situacao": "sample string 9", "tipoVenda": "sample string 10",
"origemPedido": "sample string 10", "itens": [ { "codigoProduto": 1, "EAN": "sample string 2", "descricao": "sample string 3", "sequencia": 4, "quantidade": 5.1, "valorUnitario": 6.1, "valorTotalItem": 7.0, "valorDescontoItem": 1.0, "valorAcrescimoItem": 1.0,
"custoLiquidoFiscal":1.0, "situacaoItem": "sample string 8" }, { "codigoProduto": 1, "EAN": "sample string 2", "descricao": "sample string 3", "sequencia": 4, "quantidade": 5.1, "valorUnitario": 6.1, "valorTotalItem": 7.0, "valorDescontoItem": 1.0, "valorAcrescimoItem": 1.0,
"custoLiquidoFiscal":1.0, "situacaoItem": "sample string 8" } ], "finalizadoras": [ { "tipoPagamento": "sample string 1", "valorPagamentoRealizado": 1.0 }, { "tipoPagamento": "sample string 1", "valorPagamentoRealizado": 1.0
}
],
"pessoasFidelidade": [
{
"codParceiro": "integer",
"CNPJCPF": "string"
}
]
}
{
"cpfCliente": "string",
"numeroNota": "string"
}
]

application/xml, text/xml

Exemplo (Sample):

<Inline Model>
<cpfCliente>string</cpfCliente>
<numeroNota>1</numeroNota>
<numeroEmpresa>1</numeroEmpresa>
<CNPJ>string</CNPJ>
<numeroPDV>1</numeroPDV>
<numeroSerieEcf>string</numeroSerieEcf>
<serieNota>string</serieNota>
<codigoVendedor>1</codigoVendedor>
<codigoOperador>1</codigoOperador>
<valorTotal>1.1</valorTotal>
<dataVenda>1970-01-01T00:00:00.001Z</dataVenda>
<valorDesconto>1.1</valorDesconto>
<valorAcrescimo>1.1</valorAcrescimo>
<situacao>string</situacao>
<tipoVenda>string</tipoVenda>
<origemPedido>string</origemPedido>
<itens>
<codigoProduto>1</codigoProduto>
<EAN>string</EAN>
<descricao>string</descricao>
<sequencia>1</sequencia>
<quantidade>1.1</quantidade>
<valorUnitario>1.1</valorUnitario>
<valorTotalItem>1.1</valorTotalItem>
<valorDescontoItem>1.1</valorDescontoItem>
<valorAcrescimoItem>1.1</valorAcrescimoItem>
<custoLiquidoFiscal>1.1</custoLiquidoFiscal>
<situacaoItem>string</situacaoItem>
</itens>
<finalizadoras>
<tipoPagamento>string</tipoPagamento>
<valorPagamentoRealizado>1.1</valorPagamentoRealizado>
</finalizadoras>
<pessoasFidelidade>
<codParceiro>integer</codParceiro>
<CNPJCPF>string</CNPJCPF>
</pessoasFidelidade>
</Inline Model>