Consultando uma Despesa API V2


Consulta de Despesas

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

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

 

Exemplo:

{
“status”: true,
“message”: “Despesas”,
“despesas”: [
{
“despesa_id”: “2466111”,
“data_emissao”: “31/08/2016”,
“documento”: “GUIA”,
“nfe”: “0”,
“cliente_id”: “2154489”,
“historico”: “Guia de Retenção IRRF”,
“nome_cliente”: “Administradora Cartao”
}
]
}

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/despesa/P2

No exemplo acima, o comando P2 corresponde que a consulta deve trazer as 10 primeiras despesas 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 Despesa Específica

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

Exemplo: http://implantacaoapi.erpflex.com.br/api_v2/despesa/2463144

O exemplo corresponde a consulta de uma despesa cujo o ID é o 2463144.

{
“status”: true,
“message”: “Despesas”,
“despesas”: [
{
“despesa_id”: “2463144”,
“data_emissao”: “25/08/2016”,
“documento”: “0000000006”,
“nfe”: “0”,
“cliente_id”: “2551505”,
“historico”: “”,
“nome_cliente”: “Maria”
}
]
}

Consulta de uma Despesa por Itens

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

Exemplo: http://implantacaoapi.erpflex.com.br/api_v2/despesa/itens/2466111

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

{
“status”: true,
“message”: “Despesa”,
“despesa”: [
{
“despesa_id”: “2466111”,
“data_emissao”: “31/08/2016”,
“documento”: “GUIA”,
“nfe”: “0”,
“cliente_id”: “2154489”,
“historico”: “Guia de Retenção IRRF”,
“nome_cliente”: “Administradora Cartao”,
“itens”: [
{
“item_id”: “4929515”,
“produto_id”: “1499324”,
“quantidade”: “1.00”,
“preco_unitario”: “30.00000000”,
“preco_total_item”: “30.00”,
“frete_valor”: “0.00”,
“baixa_estoque”: “2”,
“EAN”: “”,
“desc_produto”: “IRRF Retido de Fronecedor”,
“variante_chave”: “0”
}
],
“parcelas”: [
{
“cartao_id”: “”,
“historico”: “Guia de Retenção IRRF”,
“vencimento”: “2016-09-28 00:00:00”,
“pagamento_tipo”: “PRZ”,
“valor”: “30.00”,
“data_baixa”: “0000-00-00 00:00:00”,
“banco_id”: “0”,
“cheque_numero”: “”
}
]
}
]
}

Consulta de Despesa por Data

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

Exemplo: http://implantacaoapi.erpflex.com.br/api_v2/despesa/d25-08-2016

O exemplo irá trazer todas as despesas com emissão em 25/08/2016.

{
“status”: true,
“message”: “Despesas”,
“despesas”: [
{
“despesa_id”: “2463144”,
“data_emissao”: “25/08/2016”,
“documento”: “0000000006”,
“nfe”: “0”,
“cliente_id”: “2551505”,
“historico”: “”,
“nome_cliente”: “Imobiliaria Santana”
},
{
“despesa_id”: “2463152”,
“data_emissao”: “25/08/2016”,
“documento”: “0000000007”,
“nfe”: “0”,
“cliente_id”: “2551509”,
“historico”: “”,
“nome_cliente”: “SABESP”
},
{
“despesa_id”: “2464720”,
“data_emissao”: “25/08/2016”,
“documento”: “0000000016”,
“nfe”: “0”,
“cliente_id”: “2551506”,
“historico”: “”,
“nome_cliente”: “VIVO TELEFONIA”
},
{
“despesa_id”: “2464818”,
“data_emissao”: “25/08/2016”,
“documento”: “0000000017”,
“nfe”: “0”,
“cliente_id”: “2200004”,
“historico”: “”,
“nome_cliente”: “Cris Reis”
}
]
}

Consulta de Despesa por Número de Documento

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

Exemplo: http://implantacaoapi.erpflex.com.br/api_v2/despesa/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”
}
]
}