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 para retornar uma lista de pedidos realizados no módulo de Compras do ERP.

Caminho

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

Parâmetros URI (URI Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
NroPedidoNúmero interno do pedido.

integer($int64)

Não há.
NroPedFornecedorNúmero do pedido do fornecedor.stringNão há.

DtaEmissaoInicio

Data de inicio em que o pedido foi emitido. Não pode ser maior que a Data Emissão Termino. Obrigatório.string($date-time)Não há.
DtaEmissaoTerminoData de termino em que o pedido foi emitido. Não pode ser menor que a Data Emissão Inicio. Obrigatório.string($date-time)Não há.
DtaReceberInicioData de inicio em que o pedido será recebido. Não pode ser maior do que a Data Receber Termino.string($date-time)Não há.
DtaReceberTerminoData de termino em que o pedido será recebido. Não pode ser menor que a Data Receber Inicio.string($date-time)Não há.
LoteNúmero do lote gerado pelo Gerenciador de Compras e Abastecimento Automático.

integer($int64)

Não há.
EmpresaNúmero da empresa do pedido, ou seja, empresa em que o pedido será entregue pelo fornecedor. Pode ser informada mais de uma empresa. Obrigatório.

array[integer]

Não há.
TipoPedidoTipo do pedido negociado com o fornecedor: 'C' = Compra, 'B' = Bonificação com incidência, 'E' = Bonificação sem incidência; 'T' = Transferência a receber; 'X' = Transferência a expedir; 'M' = Importação direta. Obrigatório.array[integer]Não há.
LocalEmissaoIndica qual foi o local de emissão do pedido, se foi em uma central ou loja: C - Central; L - Loja.stringNão há.
NroFornecedorNúmero único do fornecedor no módulo Compras - Linha Consincointeger($int64)Não há.
DocumentoFornecedorÉ o número do CNPJ ou CPF do fornecedor do pedido.stringNão há.
CompradorNúmero do comprador cadastrado no módulo Parâmetros - Linha Consinco.integer($int64)Não há.

Informações de resposta (Response Information)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
NumeroPedidoNúmero do pedido.integerNenhum.
NumeroPedidoFornecedorNúmero do pedido do fornecedor.integer

Nenhum.

EmpresaNúmero da empresa do pedido.stringNenhum
DocumentoEmpresaNúmero do CNPJ da empresa compradora. Formato: 00000000000000 (14 dígitos).stringNenhum.
TipoPedidoTipo do pedido negociado com o fornecedor: 'C' = Compra, 'B' = Bonificação com incidência, 'E' = Bonificação sem incidência; 'T' = Transferência a receber; 'X' = Transferência a expedir; 'M' = Importação direta.stringNenhum.
DocumentoFornecedorNúmero do CNPJ do fornecedor. Formato: 00000000000000 (14 dígitos).stringNenhum.
RazaoSocialFornecedor
Nome da razão social do fornecedor do pedidostringNenhum.
FantasiaFornecedorNome fantasia do fornecedor do pedidostringNenhum.
DataEmissãoData início da emissão do pedido Formato: yyyy-MM-ddstringNenhum.
DataRecebimentoData de recebimento do pedido Formato: yyyy-MM-ddstringNenhum.
ValorTotalValor total do pedidodecimal numberNenhum.
ValorCanceladoValor cancelado total do pedidodecimal numberNenhum.
LoteNúmero do lote referente a esse pedidointegerNenhum.
NomeCompradorNome do comprador do pedidostringNenhum.
[
 {
   "nroPedido": 22,
   "nroPedidoFornecedor": "1",
   "empresa": 1,
   "documentoEmpresa": "10010000000126",
   "tipoPedido": "C",
   "documentoFornecedor": "19900000000842",
   "razaoSocialFornecedor": "FORNECEDOR MODELO 1",
   "fantasiaFornecedor": "FORNECEDOR 1",
   "dataEmissao": "11/05/2019",
   "dataRecebimento": "13/05/2019",
   "valorTotal": "25,48",
   "valorCancelado": "0",
   "lote": 2,
   "nomeComprador": "COMPRADOR MODELO"
  }}}
 ]

04. Consulta detalhada 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 IntegerNenhum.

NumeroEmpresaNúmero da empresaIntegerNenhum.

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

RazaoSocialEmpresaRazão social da empresa que fez o pedido para o fornecedorsample stringNenhum.

TipoPedidoTipo do Pedido. C - ComprastringNenhum.

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

RazaoFornecedorRazão social do fornecedorsample stringNenhum.

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

DataEmissãoData de emissão do pedidoDateNenhum.

DataRecebimentoData de recebimento do pedidoDateNenhum.

DataLimiteRecebimentoData limite para recebimento do pedidoDateNenhum.

PrazoPagamentoPrazo de pagamento ao fornecedorstringNenhum.

CompradorNome do comprador do pedidosample stringNenhum.
Itens




codigoProdutoCódigo sequencial do produto no ERPintegerNenhum.

DunCódigo DUN referente a embalagem do produtosample stringNenhum.

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

DescricaoDescrição do Produtosample stringNenhum.

EmbalagemEmbalagem do produto. Ex: CXsample stringNenhum.

QtdembalagemQuantidade constante na embalagem do produto Ex: 12sample stringNenhum.

QuantidadeQuantidade comprada do produtosample stringNenhum.

ValorUnitarioValor unitário do item decimal numberNenhum.

ValorItemValor unitário multiplicado pela quantidadedecimal numberNenhum.

ValorBrutoCusto bruto com os impostosdecimal numberNenhum.

ValorIpiValor do IPIdecimal numberNenhum.

ValorIcmsstValor do ICMSSTdecimal numberNenhum.

ValorFcpstValor do FCP STdecimal numberNenhum.

ValorDespesasValor das despesasdecimal numberNenhum.

PercDesctoFinanceiroPercentual de desconto financeirodecimal numberNenhum.
[
    {
        "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"
            }
        ]
    }

]


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