Versão 1.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 em que a entidade foi cadastrada
descricao	2	Texto(80)	Nome da entidade
ativa	2	Lógico	Determina se entidade está ativa
logradouro	2	Texto(80)	Logradouro da entidade
bairro	2	Texto(40)	Bairro do cadastro da entidade
cidade	2	Texto(40)	Cidade do cadastro de entidade
estado	2	Texto(2)	Estado do cadastro da entidade
cep	2	Texto(9)	CEP do cadastro da entidade
cgc	2	Texto(20)	CGC da entidade
ie	2	Texto(20)	Inscrição Estatual da entidade
email	2	Texto(255)	E-mail da entidade
site	2	Texto(80)	URL da entidade
segmento	2	Texto(40)	Segmento da entidade
tabela	2	Texto(20)	Tabela de preço padrão da entidade
condicao_pgto	2	Texto(40)	Condição de pagamento padrão da entidade
logradouro_cobranca	2	Texto(80)	Logradouro de cobrança
bairro_cobranca	2	Texto(40)	Bairro de cobrança
cidade_cobranca	2	Texto(40)	Cidade de cobrança
estado_cobranca	2	Texto(2)	Estado de cobrança
cep_cobranca	2	Texto(9)	CEP para cobrança
fantasia	2	Texto(80)	Nome fantasia da entidade
logradouro_entrega	2	Texto(80)	Logradouro de entrega
cep_entrega	2	Texto(9)	CEP para entrega
bairro_entrega	2	Texto(40)	Bairro de entrega
cidade_entrega	2	Texto(40)	Cidade de entrega
estado_entrega	2	Texto(2)	Estado de entrega
transportadora	2	Inteiro	Id da transportadora
insc_municipal	2	Texto(15)	Inscrição Municipal da entidade
caixa_postal	2	Texto(9)	Caixa postal da entidade
contribuinte	2	Lógico	Define a entidade como contribuinte
forma_entrega	2	Inteiro	Id da forma de entrega
empresa	2	Texto(80)	Empresa onde a entidade trabalha
logradouro_comercial	2	Texto(80)	Logradouro comercial
cep_comercial	2	Texto(9)	CEP comercial
bairro_comercial	2	Texto(40)	Bairro comercial
cidade_comercial	2	Texto(40)	Cidade comercial
estado_comercial	2	Texto(2)	Estado comercial
numero	2	Texto(10)	Número do endereço principal
numero_cobranca	2	Texto(10)	Número do endereço de cobrança
numero_entrega	2	Texto(10)	Número do endereço de entrega
numero_comercial	2	Texto(10)	Número do endereço comercial
classificacao	2	Inteiro	Classificação da entidade
endereco	2	Texto(80)	Endereço principal
endereco_cobranca	2	Texto(80)	Endereço de cobrança
endereco_comercial	2	Texto(80)	Endereço comercial
endereco_entrega	2	Texto(80)	Endereço de entrega
forn_condicao_pgto	2	Texto(40)	Condição de pagamento para compras
crea	2	Texto(20)	Dados CREA
cnpj_escritorio	2	Texto(20)	Cnpj do escritório de contabilidade caso entidade seja contador
inscr_suframa	2	Texto(14)	Inscrição do SUFRAMA
complemento	2	Texto(80)	Complemento do endereço principal
complemento_cobranca	2	Texto(80)	Complemento de endereço de cobrança
complemento_entrega	2	Texto(80)	Complemento de endereço de entrega
cnae	2	Texto(15)	CNAE da entidade
orgao_expedidor	2	Texto(10)	Órgão expedidor
uf_expedidor	2	Texto(2)	Estado expedidor
sexo	2	Texto(1)	Gênero da entidade
data_nascimento	2	Data	Data de nascimento da entidade
pessoa_fisica	2	Lógico	Determina se entidade é pessoa física
categorias	2	Estrutural
categoria	3	Estrutural
id	4	Inteiro	Id da categoria
contatos	2	Estrutural
contato	3	Estrutural
id	4	Inteiro	Id do contato da entidade
tipo_contato	4	Texto(1)	Tipo de contato da entidade(cliente ou transportadora)
id_cliente	4	Inteiro	Id da entidade do contato
nome_contato	4	Texto(80)	Nome do contato da entidade
data_nascimento	4	Data	Data de nascimento do contato da entidade
telefone	4	Texto(32)	Número de telefone do contato da entidade
fax	4	Texto(32)	Número de fax do contato da entidade
celular	4	Texto(32)	Número de celular do contato da entidade
departamento	4	Texto(40)	Departamento do contato da entidade
ramal	4	Texto(16)	Ramal do contato da entidade
email	4	Texto(253)	E-mail do contato da entidade
numero_radio	4	Texto(30)	Número de rádio do contato de entidade
data_cadastro	4	Data	Data de cadastro do contato da entidade
padrao	4	Lógico	Determina se contato da entidade é padrão
padrao_nfe	4	Lógico	Determina se contato da entidade é padrão para nota fiscal eletrônica
padrao_financeiro	4	Lógico	Determina se contato de entidade é padrão para assuntos financeiros
origem_web	4	Lógico	Determina se contato de entidade tem origem web

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="1.00">
	<entidade>
		<id>2</id>
		<id_empresa>0</id_empresa>
		<descricao>CONSUMIDOR FINAL 2</descricao>
		<ativa>true</ativa>
		<logradouro>RUA SENADOR</logradouro>
		<bairro>CENTRO</bairro>
		<cidade>CAMPINAS</cidade>
		<estado>SP</estado>
		<cep>13800-900</cep>
		<cgc>   .   .   -  </cgc>
		<ie>.   .   -</ie>
		<email>lorem.testes@lorem.com.br</email>
		<site/>
		<segmento/>
		<tabela>NORMAL</tabela>
		<condicao_pgto/>
		<logradouro_cobranca>RUA SENADOR</logradouro_cobranca>
		<bairro_cobranca>CENTRO</bairro_cobranca>
		<cidade_cobranca>CAMPINAS</cidade_cobranca>
		<estado_cobranca>SP</estado_cobranca>
		<cep_cobranca>13800-060</cep_cobranca>
		<fantasia>CONSUMIDOR FINAL</fantasia>
		<logradouro_entrega/>
		<cep_entrega/>
		<bairro_entrega/>
		<cidade_entrega/>
		<estado_entrega/>
		<transportadora>0</transportadora>
		<insc_municipal/>
		<caixa_postal/>
		<contribuinte>true</contribuinte>
		<forma_entrega>0</forma_entrega>
		<empresa/>
		<logradouro_comercial/>
		<cep_comercial/>
		<bairro_comercial/>
		<cidade_comercial/>
		<estado_comercial/>
		<numero>354</numero>
		<numero_cobranca>354</numero_cobranca>
		<numero_entrega/>
		<numero_comercial/>
		<classificacao>0</classificacao>
		<endereco>RUA SENADOR, nº 354</endereco>
		<endereco_cobranca>RUA SENADOR, nº 354</endereco_cobranca>
		<endereco_comercial/>
		<endereco_entrega/>
		<forn_condicao_pgto/>
		<crea/>
		<inscr_suframa/>
		<complemento/>
		<complemento_cobranca/>
		<complemento_entrega/>
		<cnae/>
		<orgao_expedidor/>
		<uf_expedidor/>
		<sexo>F</sexo>
		<data_nascimento/>
		<pessoa_fisica>true</pessoa_fisica>
		<contatos>
			<contato>
				<id>2</id>
				<tipo_contato>C</tipo_contato>
				<id_cliente>2</id_cliente>
				<nome_contato/>
				<data_nascimento/>
				<telefone>(99)9999-9999</telefone>
				<fax/>
				<celular/>
				<departamento/>
				<ramal/>
				<email>vinhasoft@vinhasoft.com.br</email>
				<numero_radio/>
				<data_cadastro>2014-05-28</data_cadastro>
				<padrao>false</padrao>
				<padrao_nfe>false</padrao_nfe>
				<padrao_financeiro>false</padrao_financeiro>
				<origem_web>false</origem_web>
			</contato>
		</contatos>
		<categorias>
			<categoria>
				<id>1</id>
			</categoria>
		</categorias>
	</entidade>
</entidades>

XML de exemplo:

Download XSD