Consultando um Faturamento API V2


Consulta de Faturamento

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

O GET irá trazer os 10 primeiros faturamentos, e como padrão página 1.

 

Exemplo:

{
“status”: true,
“message”: “faturamentos”,
“faturamentos”: [
{
“faturamento_id”: “4305806”,
“data_emissao”: “06/06/2016”,
“documento”: “LV160606-15:58:21”,
“nr_nfe”: “1”,
“cliente_id”: “2200004”,
“orcamento_id”: “0”,
“cliente_relacionado_id”: “0”,
“nome_cliente”: “Maria”,
“dados_fiscais_id”: “3445239”,
“modelo_nf”: “55”,
“serie_nf”: “2”,
“valor_nf”: “153.15”,
“mod_frete”: “9”,
“placa”: ”       “,
“uf_placa”: ”  “,
“qtd_volume”: “0.00”,
“especie_volume”: “”,
“marca_volume”: “”,
“numero_volume”: “”,
“peso_liquido”: “0.000”,
“peso_bruto”: “0.000”,
“inf_adicional”: “”,
“inf_adicional_fisico”: “”}
]
}

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

No exemplo acima, o comando P2 corresponde que a consulta deve trazer os 10 primeiros faturamentos 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 Faturamento Específico

Essa consulta tem o objetivo de trazer apenas um faturamento específico, utilizando o ID do faturamento, para isso, informe o ID do faturamento em questão ao final da URL de consulta.

Exemplo: http://implantacaoapi.erpflex.com.br/api_v2/faturamento/5493348

O exemplo corresponde a consulta do faturamento cujo o ID é o 5493348.

{
“status”: true,
“message”: “faturamentos”,
“faturamentos”: [
{
“faturamento_id”: “5493348”,
“data_emissao”: “19/01/2017”,
“documento”: “0000000003”,
“nr_nfe”: “0”,
“cliente_id”: “2191342”,
“orcamento_id”: “0”,
“cliente_relacionado_id”: “0”,
“nome_cliente”: “Maria”,
“dados_fiscais_id”: “4307270”,
“modelo_nf”: “00”,
“serie_nf”: “”,
“valor_nf”: “3000.00”,
“mod_frete”: “”,
“placa”: “”,
“uf_placa”: “”,
“qtd_volume”: “0.00”,
“especie_volume”: “”,
“marca_volume”: “”,
“numero_volume”: “”,
“peso_liquido”: “0.000”,
“peso_bruto”: “0.000”,
“inf_adicional”: “”,
“inf_adicional_fisico”: “”
}
]
}

Consulta de um Faturamento por Itens

Essa consulta tem o objetivo de trazer apenas um faturamento específico e os itens desse faturamento, para isso utilize o comando itens/id_do_faturamento ao final da URL de consulta.

Exemplo: http://implantacaoapi.erpflex.com.br/api_v2/faturamento/itens/4305806

O exemplo corresponde a consulta de um faturamento e seus itens,  cujo o ID do faturamento é o 4305806.

{
“status”: true,
“message”: “faturamentos”,
“faturamentos”: [
{
“faturamento_id”: “4305806”,
“data_emissao”: “06/06/2016”,
“documento”: “LV160606-15:58:21”,
“nr_nfe”: “1”,
“cliente_id”: “2200004”,
“orcamento_id”: “0”,
“cliente_relacionado_id”: “0”,
“nome_cliente”: “Maria”,
“dados_fiscais_id”: “3445239”,
“modelo_nf”: “55”,
“serie_nf”: “2”,
“valor_nf”: “153.15”,
“mod_frete”: “9”,
“placa”: ”       “,
“uf_placa”: ”  “,
“qtd_volume”: “0.00”,
“especie_volume”: “”,
“marca_volume”: “”,
“numero_volume”: “”,
“peso_liquido”: “0.000”,
“peso_bruto”: “0.000”,
“inf_adicional”: “”,
“inf_adicional_fisico”: “”,
“itens”: [
{
“item_id”: “11921809”,
“produto_id”: “1500669”,
“vendedor_id”: “16513”,
“despacho_data”: “21/06/2016”,
“despacho_qtd”: “1.00”,
“aviso_recebimento”: “AR132”,
“EAN”: “”,
“desc_produto”: “Mochila”,
“variante_chave”: “0”
},
{
“item_id”: “12139554”,
“produto_id”: “1499320”,
“vendedor_id”: “16513”,
“despacho_data”: “”,
“despacho_qtd”: “0.00”,
“aviso_recebimento”: “”,
“EAN”: “”,
“desc_produto”: “IPI”,
“variante_chave”: “0”
}
]
}
]
}

Consulta de Faturamento por Data

Essa consulta tem o objetivo de trazer os faturamentos 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/faturamento/d30-11-2016

O exemplo irá trazer todos os faturamentos com emissão em 30/11/2016.

{
“status”: true,
“message”: “faturamentos”,
“faturamentos”: [
{
“faturamento_id”: “5236829”,
“data_emissao”: “30/11/2016”,
“documento”: “0000000032”,
“nr_nfe”: “0”,
“cliente_id”: “2200004”,
“orcamento_id”: “0”,
“cliente_relacionado_id”: “0”,
“nome_cliente”: “Maria”,
“dados_fiscais_id”: “4108169”,
“modelo_nf”: “00”,
“serie_nf”: “”,
“valor_nf”: “1000.00”,
“mod_frete”: “”,
“placa”: “”,
“uf_placa”: “”,
“qtd_volume”: “0.00”,
“especie_volume”: “”,
“marca_volume”: “”,
“numero_volume”: “”,
“peso_liquido”: “0.000”,
“peso_bruto”: “0.000”,
“inf_adicional”: “”,
“inf_adicional_fisico”: “”
},
{
“faturamento_id”: “5236830”,
“data_emissao”: “30/11/2016”,
“documento”: “0000000033”,
“nr_nfe”: “0”,
“cliente_id”: “2200004”,
“orcamento_id”: “0”,
“cliente_relacionado_id”: “0”,
“nome_cliente”: “Maria”,
“dados_fiscais_id”: “4108170”,
“modelo_nf”: “00”,
“serie_nf”: “”,
“valor_nf”: “500.00”,
“mod_frete”: “”,
“placa”: “”,
“uf_placa”: “”,
“qtd_volume”: “0.00”,
“especie_volume”: “”,
“marca_volume”: “”,
“numero_volume”: “”,
“peso_liquido”: “0.000”,
“peso_bruto”: “0.000”,
“inf_adicional”: “”,
“inf_adicional_fisico”: “”
},
{
“faturamento_id”: “5236831”,
“data_emissao”: “30/11/2016”,
“documento”: “0000000034”,
“nr_nfe”: “0”,
“cliente_id”: “2200004”,
“orcamento_id”: “0”,
“cliente_relacionado_id”: “0”,
“nome_cliente”: “Maria”,
“dados_fiscais_id”: “4108171”,
“modelo_nf”: “55”,
“serie_nf”: “1”,
“valor_nf”: “27.48”,
“mod_frete”: “”,
“placa”: “”,
“uf_placa”: “”,
“qtd_volume”: “0.00”,
“especie_volume”: “”,
“marca_volume”: “”,
“numero_volume”: “”,
“peso_liquido”: “0.000”,
“peso_bruto”: “0.000”,
“inf_adicional”: “”,
“inf_adicional_fisico”: “”
},
{
“faturamento_id”: “5236833”,
“data_emissao”: “30/11/2016”,
“documento”: “0000000035”,
“nr_nfe”: “0”,
“cliente_id”: “2200004”,
“orcamento_id”: “0”,
“cliente_relacionado_id”: “0”,
“nome_cliente”: “Maria”,
“dados_fiscais_id”: “4108173”,
“modelo_nf”: “00”,
“serie_nf”: “”,
“valor_nf”: “64.00”,
“mod_frete”: “”,
“placa”: “”,
“uf_placa”: “”,
“qtd_volume”: “0.00”,
“especie_volume”: “”,
“marca_volume”: “”,
“numero_volume”: “”,
“peso_liquido”: “0.000”,
“peso_bruto”: “0.000”,
“inf_adicional”: “”,
“inf_adicional_fisico”: “”
}
]
}

Consulta por Número de Documento

Essa consulta tem o objetivo de trazer apenas um faturamento, 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/faturamento/doc0000000041

O exemplo corresponde a consulta de um faturamento cujo o campo documento  é o 0000000041

{
“status”: true,
“message”: “faturamentos”,
“faturamentos”: [
{
“faturamento_id”: “5286573”,
“data_emissao”: “09/12/2016”,
“documento”: “0000000041”,
“nr_nfe”: “0”,
“cliente_id”: “2191342”,
“orcamento_id”: “0”,
“cliente_relacionado_id”: “0”,
“nome_cliente”: “Maria”,
“dados_fiscais_id”: “4146934”,
“modelo_nf”: “55”,
“serie_nf”: “1”,
“valor_nf”: “40.00”,
“mod_frete”: “9”,
“placa”: ”       “,
“uf_placa”: ”  “,
“qtd_volume”: “0.00”,
“especie_volume”: “”,
“marca_volume”: “”,
“numero_volume”: “”,
“peso_liquido”: “0.000”,
“peso_bruto”: “0.000”,
“inf_adicional”: “”,
“inf_adicional_fisico”: “”
}
]
}

Consulta por Nota Cancelada

Essa consulta tem o objetivo de trazer todas as notas de faturamento, inclusive as notas que foram canceladas, para isso, informe ao final da URL de consulta (GET) o comando ?nf_canceladas=S.

Exemplo: http://implantacaoapi.erpflex.com.br/api_v2/faturamento/?nf_canceladas=S

 

Para realizar a consulta por paginação, informe ao final da URL de consulta (GET) o comando p(numero_da_pagina)/?nf_canceladas=S.

Exemplo: http://implantacaoapi.erpflex.com.br/api_v2/faturamento/p3/?nf_canceladas=S

 

Para realizar uma consulta por nota especifica, é possível utilizando o ID do lançamento, para isso  informe ao final da URL de consulta (GET) o comando (ID)/?nf_canceladas=S.

Exemplo: http://implantacaoapi.erpflex.com.br/api_v2/faturamento/6488659/?nf_canceladas=S