Consultando uma Receita API V2


Consulta de Receitas

Para consultar uma receita, realize uma requisição HTTP usando método GET para o endereço: http://implantacaoapi.erpflex.com.br/api_v2/receita.

O GET irá trazer as 10 primeiras receitas, e como padrão página 1.

api

Exemplo:

{
“status”: true,
“message”: “Receitas”,
“receitas”: [
{
“receita_id”: “4428719”,
“data_emissao”: “01/07/2016”,
“documento”: “0000000011”,
“nfe”: “0”,
“cliente_id”: “2200004”,
“historico”: “”,
“nome_cliente”: “Loja X”
}
]
}

Consulta por Página Específica

A consulta por página específica permite informar em qual página deve ser realizada a consulta, para isso, utilize o comando P(seguido_do_número_da_página) ao final da URL de consulta.

Exemplo: http://implantacaoapi.erpflex.com.br/api_v2/receita/P2

No exemplo acima, o comando P2 corresponde que a consulta deve trazer as 10 primeiras receitas da página 2.

Ou seja, o comando P1 é referente a página 1, P2 é referente a página 2, P3 referente a página 3 e assim sucessivamente.

Consulta por Receita Específica por ID

Essa consulta tem o objetivo de trazer apenas uma receita específica, utilizando o ID da receita, para isso, informe o ID da receita em questão ao final da URL de consulta.

Exemplo: http://implantacao.erpflex.com.br/api_v2/receita/5698113

O exemplo corresponde a consulta de uma receita cujo o ID é o 5698113.

{
“status”: true,
“message”: “Receitas”,
“receitas”: [
{
“receita_id”: “5698113”,
“data_emissao”: “23/03/2017”,
“documento”: “API_DOC_1”,
“nfe”: “0”,
“cliente_id”: “2191342”,
“historico”: “TesteIntegracaoAPI”,
“nome_cliente”: “Maria”
}
]
}

Consulta de uma Receita por Itens

Essa consulta tem o objetivo de trazer apenas uma receita específica e os itens dessa receita, para isso utilize o comando itens/id_da_receita ao final da URL de consulta.

Exemplo: http://implantacao.erpflex.com.br/api_v2/receita/itens/5349262

O exemplo corresponde a consulta de uma receita e seus itens,  cujo o ID da receita é o 5349262.

{
“status”: true,
“message”: “Receitas”,
“receitas”: [
{
“receita_id”: “5349262”,
“data_emissao”: “20/12/2016”,
“documento”: “LV161220-13:55:52”,
“nfe”: “0”,
“cliente_id”: “2216113”,
“historico”: “Loja Virtual”,
“nome_cliente”: “Ricardo”,
“itens”: [
{
“item_id”: “15150237”,
“produto_id”: “1500665”,
“vendedor_id”: “16513”,
“despacho_data”: “”,
“despacho_qtd”: “0.00”,
“aviso_recebimento”: “”,
“EAN”: “”,
“desc_produto”: “Fone de Ouvido”,
“variante_chave”: “0”
},
{
“item_id”: “15150238”,
“produto_id”: “1500669”,
“vendedor_id”: “16513”,
“despacho_data”: “”,
“despacho_qtd”: “0.00”,
“aviso_recebimento”: “”,
“EAN”: “”,
“desc_produto”: “Mochila”,
“variante_chave”: “0”
}
]
}
]
}

Consulta de Receita por Data

Essa consulta tem o objetivo de trazer as receitas filtrando por data, para isso, utilize o comando d(seguido_da_data) ao final da URL de consulta.

Exemplo: http://implantacao.erpflex.com.br/api_v2/receita/d23-03-2017

O exemplo irá trazer todas as receitas com emissão em 23/03/2017.

{
“status”: true,
“message”: “Receitas”,
“receitas”: [
{
“receita_id”: “5698113”,
“data_emissao”: “23/03/2017”,
“documento”: “API_DOC1”,
“nfe”: “0”,
“cliente_id”: “2191342”,
“historico”: “TesteIntegracaoAPI”,
“nome_cliente”: “Maria”
},
{
“receita_id”: “5698114”,
“data_emissao”: “23/03/2017”,
“documento”: “API_DOC2”,
“nfe”: “0”,
“cliente_id”: “2191342”,
“historico”: “TesteIntegracaoAPI2”,
“nome_cliente”: “João”
}
]
}

Consulta por Número de Documento

Essa consulta tem o objetivo de trazer apenas uma receita, utilizando o campo Documento, para isso, informe ao final da URL de consulta (GET) o comando doc(seguido_do_documento).

Exemplo: http://implantacao.erpflex.com.br/api_v2/receita/doc0000000012

O exemplo corresponde a consulta de uma receita cujo o o campo documento  é o 0000000012.

{
“status”: true,
“message”: “Receitas”,
“receitas”: [
{
“receita_id”: “4429091”,
“data_emissao”: “01/07/2016”,
“documento”: “0000000012”,
“nfe”: “0”,
“cliente_id”: “2200004”,
“historico”: “”,
“nome_cliente”: “Maria”
}
]
}

Consulta por Número de Documento, Itens e Parcelas

Essa consulta tem o objetivo de trazer uma receita, utilizando o campo Documento, essa consulta também retornará os itens e as parcelas desse lançamento, para isso, informe ao final da URL de consulta (GET) o comando (itens/doc(numero_do_documento)).

Exemplo: http://implantacao.erpflex.com.br/api_v2/receita/itens/doc0000000060

O exemplo corresponde a consulta de uma receita cujo o o campo documento  é o 00000000060.

{
“status”: true,
“message”: “Receitas”,
“receitas”: [
{
“receita_id”: “6113080”,
“data_emissao”: “22/05/2017”,
“documento”: “0000000060”,
“nfe”: “0”,
“cliente_id”: “2642011”,
“historico”: “”,
“nome_cliente”: “Rodrigo”,
“itens”: [
{
“item_id”: “18035780”,
“produto_id”: “2163867”,
“OPOS_id”: “975769”,
“vendedor_id”: “17386”,
“quantidade”: “1.000”,
“preco_unitario”: “500.00000000”,
“preco_total_item”: “500.00”,
“frete_valor”: “0.00”,
“baixa_estoque”: “2”,
“despacho_data”: “”,
“despacho_qtd”: “0.00”,
“aviso_recebimento”: “”,
“EAN”: “”,
“desc_produto”: “Curso Engenharia”,
“variante_chave”: “0”
}
],
“parcelas”: [
{
“parcela_id”: “8580260”,
“cartao_id”: “”,
“historico”: “”,
“vencimento”: “2017-05-22 00:00:00”,
“pagamento_tipo”: “PRZ”,
“valor”: “500.00”,
“data_baixa”: “0000-00-00 00:00:00”,
“banco_id”: “0”,
“cheque_numero”: “”
}
]
}
]
}