Versão 2.00

Parâmetros padrões:

Nome	Obrigatório	Tipo de dado	Finalidade	Descrição
id	Não	Inteiro	Filtro	É utilizado para filtrar o registro a ser consultado. Indicado para pesquisas singulares.
descricao	Não	Texto	Filtro	É utilizado para filtrar o registro pela sua descrição. A consulta irá filtrar todos os resultados que possuem o valor em sua composição. Semelhante ao operador LIKE em consultas SQL.
cpf	Não	Texto	Filtro	É utilizado para filtrar o registro pelo seu cpf. Indicado para pesquisas singulares.
cnpj	Não	Texto	Filtro	É utilizado para filtrar o registro pelo seu cnpj. Indicado para pesquisas singulares.
id_inicial	Não	Inteiro	Filtro	Id inicial do registro a ser considerado.
id_final	Não	Inteiro	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
entidades	0	Estrutural
entidade	1	Estrutural
id	2	Inteiro	Id da entidade
id_empresa	2	Inteiro	Id da empresa
razao_social	2	Texto(80)	Razão social da entidade
nome_fantasia	2	Texto(80)	Nome fantasia da entidade
limite_credito	2	Real	Limite de crédito definido no cadastro da entidade
credito_disponivel	2	Real	Crédito disponível para entidade. (limite_crédito - valores em aberto
pendencias	2	Estrutural
pendencia	3	Estrutural
forma	4	Texto	Descritivo da forna de pagamento referente a pendência
vencido	4	Real	Valor total já com data de vencimento ultrapassada
vencer	4	Real	Total de valores ainda em aberto
total	4	Real	Soma total das pendências

Exemplos de consultas

// Mostra o registro da entidade 32
<servico versao="1.00" token="tkn-vinhasoft-001" id_empresa="1" id="32"/>

// Mostra todos o registros de entidades que tem relação a descrição "carlos"
<servico versao="1.00" token="tkn-vinhasoft-001" id_empresa="1" descricao="carlos"/>

Exemplo de retorno

<entidades versao="2.00">
	<entidade>
		<id>2</id>
		<id_empresa>0</id_empresa>
		<razao_social>CONSUMIDOR FINAL 2</razao_social>
		<nome_fantasia>CONSUMIDOR FINAL</nome_fantasia>
		<limite_credito>0,1</limite_credito>
		<credito_disponivel>-3852,32</credito_disponivel>
		<pendencias>
			<pendencia>
				<forma>Cheque</forma>
				<vencido>2313,34</vencido>
				<vencer>0</vencer>
				<total>2313,34</total>
			</pendencia>
		</pendencias>
	</entidade>
</entidades>

XML de exemplo:

Download XSD