Histórico da Página

CONTEÚDO

Visão Geralgeral
Exemplo de utilização
Tela XXX
1. Outras Ações / Ações relacionadas
Tela XXX
1. Principais Campos e Parâmetros
1. Caminho
2. Parâmetros dinâmicos
3. Pré-requisitos, restrições e parametrizações
4. Pré-requisitos técnicos
5. Passo a passo
Tecnologias homologadas
Documentação e assuntos relacionados
Documentação de versões e atualizaçõesTabelas utilizadas

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

Image Added

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

03. TELA XXXXX

Outras Ações / Ações relacionadas

...

04. TELA XXXXX

Principais Campos e Parâmetros

...

Card documentos

Informacao	Use esse box para destacar informações relevantes e/ou de destaque.
Titulo	IMPORTANTE!

...

/api/v1/PedidoCompras/consulta-pedido-compra

Parâmetros URI (URI Parameters)

Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
NroPedido	Número interno do pedido.	integer($int64)	Não há.
NroPedFornecedor	Número do pedido do fornecedor.	string	Nã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á.
DtaEmissaoTermino	Data 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á.
DtaReceberInicio	Data 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á.
DtaReceberTermino	Data de termino em que o pedido será recebido. Não pode ser menor que a Data Receber Inicio.	string($date-time)	Não há.
Lote	Número do lote gerado pelo Gerenciador de Compras e Abastecimento Automático.	integer($int64)	Não há.
Empresa	Nú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á.
TipoPedido	Tipo 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á.
LocalEmissao	Indica qual foi o local de emissão do pedido, se foi em uma central ou loja: C - Central; L - Loja.	string	Não há.
NroFornecedor	Número único do fornecedor no módulo Compras - Linha Consinco	integer($int64)	Não há.
DocumentoFornecedor	É o número do CNPJ ou CPF do fornecedor do pedido.	string	Não há.
Comprador	Nú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)
NumeroPedido	Número do pedido.	integer	Nenhum.
NumeroPedidoFornecedor	Número do pedido do fornecedor.	integer	Nenhum.
Empresa	Número da empresa do pedido.	string	Nenhum
DocumentoEmpresa	Número do CNPJ da empresa compradora. Formato: 00000000000000 (14 dígitos).	string	Nenhum.
TipoPedido	Tipo 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.	string	Nenhum.
DocumentoFornecedor	Número do CNPJ do fornecedor. Formato: 00000000000000 (14 dígitos).	string	Nenhum.
RazaoSocialFornecedor	Nome da razão social do fornecedor do pedido	string	Nenhum.
FantasiaFornecedor	Nome fantasia do fornecedor do pedido	string	Nenhum.
DataEmissão	Data início da emissão do pedido Formato: yyyy-MM-dd	string	Nenhum.
DataRecebimento	Data de recebimento do pedido Formato: yyyy-MM-dd	string	Nenhum.
ValorTotal	Valor total do pedido	decimal number	Nenhum.
ValorCancelado	Valor cancelado total do pedido	decimal number	Nenhum.
Lote	Número do lote referente a esse pedido	integer	Nenhum.
NomeComprador	Nome do comprador do pedido	string	Nenhum.

Bloco de código

language	js
title	Formato de Resposta

[
 {
   "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)
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.

Informações de resposta (Response Information)

	Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
Topo
	NumeroPedido	Número do pedido	Integer	Nenhum.
	NumeroEmpresa	Número da empresa	Integer	Nenhum.
	CnpjEmpresa	CNPJ da empresa Formato: 00000000000000 (14 dígitos)	string	Nenhum.
	RazaoSocialEmpresa	Razão social da empresa que fez o pedido para o fornecedor	sample string	Nenhum.
	TipoPedido	Tipo do Pedido. C - Compra	string	Nenhum.
	CnpjFornecedor	CNPJ do fornecedor Formato: 00000000000000 (14 dígitos)	string	Nenhum.
	RazaoFornecedor	Razão social do fornecedor	sample string	Nenhum.
	Frete	Tipo de frete do pedido. (CIF, FOB)	string	Nenhum.
	DataEmissão	Data de emissão do pedido	Date	Nenhum.
	DataRecebimento	Data de recebimento do pedido	Date	Nenhum.
	DataLimiteRecebimento	Data limite para recebimento do pedido	Date	Nenhum.
	PrazoPagamento	Prazo de pagamento ao fornecedor	string	Nenhum.
	Comprador	Nome do comprador do pedido	sample string	Nenhum.
Itens
	codigoProduto	Código sequencial do produto no ERP	integer	Nenhum.
	Dun	Código DUN referente a embalagem do produto	sample string	Nenhum.
	Ean	Código ean cadastrado no produto, retornar sempre o maior	sample string	Nenhum.
	Descricao	Descrição do Produto	sample string	Nenhum.
	Embalagem	Embalagem do produto. Ex: CX	sample string	Nenhum.
	Qtdembalagem	Quantidade constante na embalagem do produto Ex: 12	sample string	Nenhum.
	Quantidade	Quantidade comprada do produto	sample string	Nenhum.
	ValorUnitario	Valor unitário do item	decimal number	Nenhum.
	ValorItem	Valor unitário multiplicado pela quantidade	decimal number	Nenhum.
	ValorBruto	Custo bruto com os impostos	decimal number	Nenhum.
	ValorIpi	Valor do IPI	decimal number	Nenhum.
	ValorIcmsst	Valor do ICMSST	decimal number	Nenhum.
	ValorFcpst	Valor do FCP ST	decimal number	Nenhum.
	ValorDespesas	Valor das despesas	decimal number	Nenhum.
	PercDesctoFinanceiro	Percentual de desconto financeiro	decimal number	Nenhum.

Bloco de código

language	js
title	Formato de Resposta

[
    {
        "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

A finalidade deste método é realizar a inclusão de pedidos de compras no ERP.

Caminho

POST [URLAPI]/PedidoComprasApi/api/v1/PedidoCompras/incluir-pedido-compra

Parâmetros do Corpo (Body Parameters)

	Nome (Name)	Descrição (Description)	Tipo (Type)	Informações Adicionais (Adittional Information)
Topo
	nroPedFornecedor	Número do pedido no fornecedor.	integer	Não há.
	nroEmpresa	Número identificador da empresa	integer	Opcional quando informado o campo cnpjEmpresa
	cnpjEmpresa	CNPJ da empresa compradora.	string	Opcional quando informado o campo nroEmpresa
	nroEmpresaFat	Número identificador da empresa de faturamento	integer	Opcional quando informado o campo cnpjEmpresaFat
	cnpjEmpresaFat	CNPJ da empresa que faturou o pedido.	string	Opcional quando informado o campo nroEmpresaFat
	cnpjFornecedor	CNPJ do Fornecedor.	string	Não há.
	apelidoComprador	Apelido do Comprador.	string	Não há.
	tipoPedido	Tipo do pedido, 'C' = Compra, 'B' = Bonificação com incidência, 'E' = Bonificação sem incidência	string	Não há.
	dtaEmissao	Data que o pedido foi emitido.	string	Não há.
	dtaRecebimento	Data em que o pedido será recebido.	string	Não há.
	dtaLimiteRecebto	Data limite para recebimento do pedido.	string	Não há.
	tipoFrete	Indica o tipo de frete praticado pelo fornecedor, 'C' = CIF, 'F' = FOB, 'S' = CSP ou 'R' = RETIRA.	string	Não há.
Itens
	nroPedFornecedor	Número do pedido no fornecedor	string	Não há.
	cnpjEmpresa	CNPJ da empresa compradora.	string	Não há.
	codProduto	EAN, DUN ou código interno do produto.	integer	Para considerar '0' (zeros) a esquerda do EAN, utilizar PD UTIL_EAN_ALFANUMERICO (EDI_PEDCOMPRA) = 'S' PD IND_TIP_COD_PRODUTO (EDI_PEDCOMPRA) = 'C'
	qtdSolicitada	Quantidade solicitada.	number	Não há.
	qtdEmbalagem	Quantidade da embalagem de compra.	number	Não há.
	vlrEmbItem	Valor do Item.	number	Não há.
	vlrEmbIPI	Valor do IPI vinculado ao item.	number	Não há.
	vlrEmbICMSST	Valor do ICMSST vinculado ao item.	number	Não há.
	vlrEmbDespesa	Valor de despesa sobre o produto.	number	Não há.
	vlrEmbVerbaCompra	Valor de verba de compra.	number	Não há.
	dtaRecebtoItem	Data de recebimento do item.	string	Não há.
	percDescFinancItem	Percentual do desconto financeiro do item.	number	Não há.
	vlrEmbICMS	Valor do ICMS vinculado ao item.	number	Não há.
	vlrEmbISS	Valor do ISS vinculado ao item.	number	Não há.
	vlrEmbIRRF	Valor do IRRF vinculado ao item.	number	Não há.
	vlrEmbFrete	Valor do Frete.	number	Não há.
	vlrEmbVendor	Valor vendor do produto.	number	Não há.
	vlrEmbDesconto	Valor do desconto sobre o produto.	number	Não há.
	perDescDf	Percentual de desconto financeiro.	number	Não há.
	vlrEmbVerbaComprAcr	Valor de verba de compra de acréscimo.	number	Não há.

Bloco de código

language	js
title	Formato de Resposta

{
  "nroPedido": 9999
}

06. TECNOLOGIAS HOMOLOGADAS

Informações
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 produto	ERP / ERP Web
Sistema Operacional	Windows Desktop
Plataforma	Web
Navegador	N/A
Utilização/Experiência	Aplicações Web em geral

07. DOCUMENTOS E ASSUNTOS RELACIONADOS,

Ação	Descrição
Publica Web	Processo de instalação utilizando o Publica Web

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

Clique para expandir

Expandir

title	Inovação

Service pack	Documentação
25.07.013	DT Adição do campo NROEMPRESA para inclusão de pedidos na API Pedido de Compras
25.07.030	DT Adição do campo NROEMPRESAFAT para inclusão de pedidos na API Pedido de Compras

Expandir

title	Legislação

Service pack	Documentação

Expandir

title	Manutenção

Service pack	Documentação

Árvore de páginas

Versões comparadas

Versão antiga 2

Nova versão Atual

Chave

CONTEÚDO

01. VISÃO GERAL

02. EXEMPLO DE UTILIZAÇÃO

Caminho

Parâmetros dinâmicos

Pré-Requisitos técnicos

03. Consulta de Pedido de Compra

03. TELA XXXXX

04. TELA XXXXX

Parâmetros URI (URI Parameters)

Informações de resposta (Response Information)

04. Consulta detalhada de Pedido de Compra

Parâmetros URI (URI Parameters)

Informações de resposta (Response Information)

05. Inclusão de Pedido de Compra

Parâmetros do Corpo (Body Parameters)

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.

07. DOCUMENTOS E ASSUNTOS RELACIONADOS,

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