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) |
| NumeroPedido | Número do pedido. | integer | Nenhum. |
| NumeroEmpresa | Número da empresa. | integer | Nenhum. |
| CNPJEmpresa | É o número do CNPJ da empresa. Formato: 00000000000000 (14 dígitos). | string | Obrigatório |
| CNPJFornecedor | É o número do CNPJ fornecedor. Formato: 00000000000000 (14 dígitos). | string | Nenhum. |
| DataInicioEmissao | Data início da emissão do pedido Formato: yyyy-MM-dd Obrigatório. | string | Obrigatório. |
| DataFimEmissao | Data fim da emissão do pedido Formato: yyyy-MM-dd | string | Obrigatório. |
| _pageNo |
| integer | Nenhum. |
| _pageSize |
| integer | Nenhum. |
Parâmetros do Corpo (Body Parameters)
Não há.
Informações para Resposta (Response Information)
Descrição do
...
Recurso (Resource Description)
Nome ()(Descrição )(Tipo )(Informações Adicionais ) |
|---|
| Topo |
|
|
|
|
| NumeroPedido | Número do pedido | Integer |
|
| NumeroEmpresa | Número da empresa | Integer |
Não há | UFEmpresa | UF
|
| CnpjEmpresa | CNPJ da empresa
|
String | Não há | | NumeroDivisao | Número da divisão da empresa | Integer | Não há |
| EmbalagemVenda | Embalagem padrão de venda (caixa fechada) | String | Não há |
| QtdeEmbVenda | Quantidade da embalagem padrão de compra | number <double> | Não há |
| EmbalagemCompra | Embalagem padrão de compra (caixa fechada) | String | Não há |
| QtdeEmbCompra | Quantidade da embalagem padrão de compra | number <double> | Não há |
| StatusCompra | Status de compra do produto na empresa (ativo, inativo ou suspenso) | String | Não há |
| StatusVenda | Status de venda do produto na empresa (ativo, inativo) | String | Não há |
| Comprador | Apelido do comprador | String | Não há |
| CodigoAcessoPrincipal | Código de acesso principal | String | Não há |
| IdProduto | Código sequencial do cadastro do produto | Integer | Não há |
| IdFamilia | Código sequencial do cadastro da família do produto | Integer | Não há |
| IdProdutoBase | Código sequencial do cadastro do produto base | Integer | Não há |
| Formato: 00000000000000 (14 dígitos) | string |
|
| RazaoSocialEmpresa | Razão social da empresa que fez o pedido para o fornecedor | sample string |
|
| TipoPedido | Tipo do Pedido. C - Compra | string |
|
| CnpjFornecedor | CNPJ do fornecedor
Formato: 00000000000000 (14 dígitos) | string |
|
| RazaoFornecedor | Razão social do fornecedor | sample string |
|
| Frete | Tipo de frete do pedido. (CIF, FOB) | string |
|
| DataEmissão | Data de emissão do pedido | Date |
|
| DataRecebimento | Data de recebimento do pedido | Date |
|
| DataLimiteRecebimento | Data limite para recebimento do pedido | Date |
|
| PrazoPagamento | Prazo de pagamento ao fornecedor | string |
|
| Comprador | Nome do comprador do pedido | sample string |
|
| Itens |
|
|
|
|
| codigoProduto | Código sequencial do produto no ERP | integer |
|
| Dun | Código DUN referente a embalagem do produto | sample string |
|
| Ean | Código ean cadastrado no produto, retornar sempre o maior | sample string |
|
| Descricao | Descrição do Produto | sample string |
|
| Embalagem | Embalagem do produto. Ex: CX | sample string |
|
| Qtdembalagem | Quantidade constante na embalagem do produto Ex: 12 | sample string |
|
| Quantidade | Quantidade comprada do produto | sample string |
|
| ValorUnitario | Valor unitário do item | decimal number |
|
| ValorItem | Valor unitário multiplicado pela quantidade | decimal number |
|
| ValorBruto | Custo bruto com os impostos | decimal number |
|
| ValorIpi | Valor do IPI | decimal number |
|
| ValorIcmsst | Valor do ICMSST | decimal number |
|
| ValorFcpst | Valor do FCP ST | decimal number |
|
| ValorDespesas | Valor das despesas | decimal number |
|
| PercDesctoFinanceiro | Percentual de desconto financeiro | decimal number |
DataUltimaAtualizacao | Data da ultima atualização | String | Não há
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"
}
]
}
]