Versão 1.00
Parâmetros padrões:
| Nome | Obrigatório | Tipo de dado | Finalidade | Descrição |
|---|---|---|---|---|
| id_empresa | Não | Inteiro | Filtro | É utilizado para filtrar a empresa do registro a ser consultado. |
| data_inicial | Não | Data | Filtro | Utilizado para determinar qual a data inicial que será considerada. Caso não informe a data será o dia atual. |
| data_final | Não | Data | Filtro | Utilizado para determinar qual a data final que será considerada. Caso não informe a data será o dia atual. |
| id_inicial | Não | Inteiro | Filtro | Id inicial do registro a ser considerado. |
| id_final | Não | Lógico | Filtro | Id final do registro a ser considerado. |
| max_registros | Não | Inteiro | Filtro | Determina a quantidade máxima de registros a serem retornados. |
Estrutura de retorno:
| Nome | Nível | Tipo de dado | Descrição |
|---|---|---|---|
| top_tipos_pagamentos | 0 | Estrutural | |
| top_tipo_pagamento | 1 | Estrutural | |
| id_empresa | 2 | Inteiro | Id da empresa |
| id_tipo_pagamento | 2 | Inteiro | Id do tipo de pagamento |
| descricao_tipo_pagamento | 2 | Texto(40) | Descrição do tipo de pagamento |
| valor_faturado | 2 | Real | Valor total do faturamento |
Exemplos de utilização
//Realizando uma consulta <servico versao="1.00" token="tkn-vinhasoft-001" data_inicial="2016-12-28T08:06:56-02:00" data_final="2016-12-28T08:06:56-02:00"/>
Exemplos de retorno
<top_tipos_pagamentos versao="1.00"> <top_tipo_pagamento> <id_empresa>1</id_empresa> <id_tipo_pagamento>4</id_tipo_pagamento> <descricao_tipo_pagamento>CHEQUE À VISTA</descricao_tipo_pagamento> <valor_faturado>146999,515625</valor_faturado> </top_tipo_pagamento> <top_tipo_pagamento> <id_empresa>1</id_empresa> <id_tipo_pagamento>2</id_tipo_pagamento> <descricao_tipo_pagamento>BOLETO despesas</descricao_tipo_pagamento> <valor_faturado>2010095,125</valor_faturado> </top_tipo_pagamento> <top_tipo_pagamento> <id_empresa>1</id_empresa> <id_tipo_pagamento>31</id_tipo_pagamento> <descricao_tipo_pagamento>CARTEIRA</descricao_tipo_pagamento> <valor_faturado>682995,25</valor_faturado> </top_tipo_pagamento> <top_tipo_pagamento> <id_empresa>1</id_empresa> <id_tipo_pagamento>251</id_tipo_pagamento> <descricao_tipo_pagamento>CARTÃO DE DÉBITO</descricao_tipo_pagamento> <valor_faturado>680425,75</valor_faturado> </top_tipo_pagamento> <top_tipo_pagamento> <id_empresa>1</id_empresa> <id_tipo_pagamento>3</id_tipo_pagamento> <descricao_tipo_pagamento>CARTÃO DE CRÉDITO</descricao_tipo_pagamento> <valor_faturado>695354,9375</valor_faturado> </top_tipo_pagamento> <top_tipo_pagamento> <id_empresa>1</id_empresa> <id_tipo_pagamento>151</id_tipo_pagamento> <descricao_tipo_pagamento>VG - CHEQUE PRÉ</descricao_tipo_pagamento> <valor_faturado>1690063,875</valor_faturado> </top_tipo_pagamento> <top_tipo_pagamento> <id_empresa>1</id_empresa> <id_tipo_pagamento>7</id_tipo_pagamento> <descricao_tipo_pagamento>DEPÓSITO EM CONTA BANCÁRIA</descricao_tipo_pagamento> <valor_faturado>342088,09375</valor_faturado> </top_tipo_pagamento> <top_tipo_pagamento> <id_empresa>1</id_empresa> <id_tipo_pagamento>201</id_tipo_pagamento> <descricao_tipo_pagamento>ACORDO - BOLETO</descricao_tipo_pagamento> <valor_faturado>35962,25</valor_faturado> </top_tipo_pagamento> <top_tipo_pagamento> <id_empresa>1</id_empresa> <id_tipo_pagamento>1</id_tipo_pagamento> <descricao_tipo_pagamento>DINHEIRO</descricao_tipo_pagamento> <valor_faturado>401520,25</valor_faturado> </top_tipo_pagamento> </top_tipos_pagamentos>