CONTEÚDO

  1. Visão geral
  2. Exemplo de utilização
    1. Caminho
    2. Parâmetros dinâmicos
    3. Pré-requisitos, restrições e parametrizações
    4. Pré-requisitos técnicos
    5. Passo a passo 
  3. Tecnologias homologadas
  4. Documentação e assuntos relacionados
  5. Documentação de versões e atualizações

01. VISÃO GERAL

A aplicação API Pedido de Compras permite consultar e incluir pedidos de compras ao módulo de compras, servindo como um conector ao sistema.

02. EXEMPLO DE UTILIZAÇÃO

Caminho

[URLAPI]/PedidoComprasApi

Parâmetros dinâmicos

Não há.


Pré-Requisitos, Restrições e Parametrizações

Não há.

Pré-Requisitos técnicos

    

03. Consulta de Pedido de Compra

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

Caminho

GET [URLAPI]/PedidoComprasApi/api/v1/PedidoCompras/consulta-pedido-compra-detalhado

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.

Informações de resposta (Response Information)


Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional 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
[
    {
        "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"
            }
        ]
    }

]

04. Consulta detalhada de Pedido de Compra

Principais Campos e Parâmetros

CampoDescrição
Inclua o campo Inclua a descrição relacionada
Inclua o campo Inclua a descrição relacionada
Inclua o campo Inclua a descrição relacionada

05. Inclusão de Pedido de Compra


06. TECNOLOGIAS HOMOLOGADAS

O uso do Tipo de Produto em diferentes tecnologias não homologadas, como em Sistema Operacional, Plataforma, Navegadores e outros dispositivos, pode comprometer a segurança dos sistemas e está sujeito a situações não previstas, sem cobertura de suporte.
Tipo de produtoERP / ERP Web
Sistema OperacionalWindows Desktop
PlataformaWeb
NavegadorN/A
Utilização/ExperiênciaAplicações Web em geral

07. DOCUMENTOS E ASSUNTOS RELACIONADOS,

AçãoDescrição
Publica WebProcesso de instalação utilizando o Publica Web

08. DOCUMENTOS DE VERSÕES E ATUALIZAÇÕES

Clique para expandir

Service packDocumentação


Service packDocumentação


Service packDocumentação