Versão 1.00

Parâmetros padrões:

Nome	Obrigatório	Tipo de dado	Finalidade	Descrição
atualizar_dados	Sim	Lógico	Definição	Caso o CPF ou CNPJ do novo registro a ser inserido já exista no ERP: Se verdadeiro - Os dados serão atualizados. Se falso - Retorna uma mensagem de aviso e não completa a operação.

Estrutura de retorno

Nome	Nível	Obrigatório	Tipo de dado	Descrição
entidades	0	Sim	Estrutural
entidade	1	Sim	Estrutural
id	2	Sim	Inteiro	Id da entidade a ser inserida ou atualizada. Este campo é a referência do registro dentro do ERP. Enviar zero para inserção
id_externo	2	Não	Inteiro	Utilizado para fazer referência a um registro externo
id_empresa	2	Não	Inteiro	Id da empresa na qual a entidade será vinculada. Se não enviado, todas as empresas terão acesso
ativa	2	Não	Lógico	Determina se o cadastro da entidade está ativa
descricao	2	Não	Texto(80)	Nome da entidade
data_nascimento	2	Não	Data	Data de nascimento da entidade
logradouro	2	Não	Texto(80)	Logradouro do endereço principal da entidade
bairro	2	Não	Texto(40)	Bairro do endereço principal da entidade
cidade	2	Não	Texto(40)	Cidade do endereço principal da entidade
estado	2	Não	Texto(2)	Estado do endereço principal da entidade
cep	2	Não	Texto(9)	CEP do endereço principal da entidade. Formato (xxxxx-xxx)
ie	2	Não	Texto(20)	Inscrição Estatual ou RG da entidade. (Enviar com máscara)
cgc	2	Não	Texto(20)	CNPJ ou CPF da entidade. (Enviar com máscara)
email	2	Não	Texto(255)	E-mail da entidade
site	2	Não	Texto(80)	Site da entidade
segmento	2	Não	Texto(40)	Segmento da entidade cadastrada
tabela	2	Não	Texto(20)	Tabela de preço padrão para entidade
condicao_pgto	2	Não	Texto(40)	Condição de pagamento padrão para a entidade
logradouro_cobranca	2	Não	Texto(80)	Logradouro de cobrança da entidade
bairro_cobranca	2	Não	Texto(40)	Bairro de cobrança da entidade
cidade_cobranca	2	Não	Texto(40)	Cidade de cobrança da entidade
estado_cobranca	2	Não	Texto(2)	Estado de cobrança da entidade
cep_cobranca	2	Não	Texto(9)	CEP de cobrança da entidade. Formato (xxxxx-xxx)
fantasia	2	Não	Texto(80)	Nome fantasia da entidade
logradouro_entrega	2	Não	Texto(80)	Logradouro de entrega da entidade
cep_entrega	2	Não	Texto(9)	CEP de entrega da entidade. Formato (xxxxx-xxx)
bairro_entrega	2	Não	Texto(40)	Bairro de entrega da entidade
cidade_entrega	2	Não	Texto(40)	Cidade de entrega da entidade
estado_entrega	2	Não	Texto(2)	Estado da entrega da entidade
id_transportadora	2	Não	Inteiro	Id da transportadora padrão da entidade
categorias	2	Não	Estrutural	Apesar de não obrigatório, o ideal é que seja informado na inserção do registro. A categoria determina o comportamento do sistema em relação ao registro, como por exemplo, se é possível criar um pedido de venda para a entidade.
categoria	3	Sim	Estrutural
id	4	Sim	Inteiro	Id da categoria (tipo da entidade)
insc_municipal	2	Não	Texto(15)	Inscrição Municipal da entidade
caixa_postal	2	Não	Texto(9)	Caixa postal da entidade
contribuinte	2	Não	Lógico	Determina se a entidade é contribuinte
forma_entrega	2	Não	Inteiro	Id da forma de entrega padrão da entidade
logradouro_comercial	2	Não	Texto(80)	Logradouro comercial da entidade
cep_comercial	2	Não	Texto(9)	CEP comercial da entidade. Formato (xxxxx-xxx)
bairro_comercial	2	Não	Texto(40)	Bairro comercial da entidade
cidade_comercial	2	Não	Texto(40)	Cidade comercial da entidade
estado_comercial	2	Não	Texto(2)	Estado comercial da entidade
numero	2	Não	Texto(10)	Número de endereço principal da entidade
numero_comercial	2	Não	Texto(10)	Número de endereço comercial da entidade
numero_cobranca	2	Não	Texto(10)	Número de endereço de cobrança da entidade
numero_entrega	2	Não	Texto(10)	Número de endereço de entrega da entidade
crea	2	Não	Texto(20)	Número do CREA da entidade
cnpj_escritorio	2	Não	Texto(20)	CNPJ do escritório da entidade
inscr_suframa	2	Não	Texto(14)	Inscrição Suframa
complemento	2	Não	Texto(80)	Complemento do endereço principal
complemento_entrega	2	Não	Texto(80)	Complemento do endereço de entrega
complemento_cobranca	2	Não	Texto(80)	Complemento do endereço de cobrança
cnae	2	Não	Texto(15)	CNAE da entidade
orgao_expedidor	2	Não	Texto(10)	Órgão expedidor
uf_expedidor	2	Não	Texto(2)	Estado expedidor
data_cadastro	2	Não	Data	Data do cadastro
pessoa_fisica	2	Sim	Lógico	Determina se entidade é pessoa física
sexo	2	Sim	Texto(1)	Determina o sexo da entidade
id_pais	2	Não	Inteiro	ID do país da entidade.

 

Exemplo de utilização

<entidades versao="1.00" token="tkn-vinhasoft-001" id_empresa="1" atualizar_dados="true">
   <entidade id_externo="5152x">
      <id>0</id>
      <id_empresa>1</id_empresa>
      <ativa>true</ativa>
      <descricao>Vinhasoft</descricao>
      <data_nascimento>1992-09-19T00:00:00</data_nascimento>
      <logradouro>José Bonifácio</logradouro>
      <bairro>Campo Grande</bairro>
      <cidade>Sumaré</cidade>
      <estado>SP</estado>
      <cep>13054-788</cep>
      <ie>1023456789101154878</ie>
      <cgc>254.568.874-75</cgc>
      <email>vinhasoft@vinhasoft.com.br</email>
      <site>www.vinhasoft.com.br</site>
      <segmento>textil</segmento>
      <tabela>TABELA CLIENTE</tabela>
      <condicao_pgto>A VISTA</condicao_pgto>
      <logradouro_cobranca>José Bonifácio</logradouro_cobranca>
      <bairro_cobranca>Campo Grande</bairro_cobranca>
      <cidade_cobranca>Sumaré</cidade_cobranca>
      <estado_cobranca>SP</estado_cobranca>
      <cep_cobranca>13054-788</cep_cobranca>
      <fantasia>Vinhasoft</fantasia>
      <logradouro_entrega>José Bonifácio</logradouro_entrega>
      <cep_entrega>13054-788</cep_entrega>
      <bairro_entrega>Campo Grande</bairro_entrega>
      <cidade_entrega>Sumaré</cidade_entrega>
      <estado_entrega>SP</estado_entrega>
      <id_transportadora>12</id_transportadora>
      <categorias>
         <categoria>
            <id>8</id>
            <id>12</id>
         </categoria>
      </categorias>
      <insc_municipal>4446432165489</insc_municipal>
      <caixa_postal>876/caixa_postal>
      <contribuinte>true</contribuinte>
      <forma_entrega>4</forma_entrega>
      <logradouro_comercial>José Bonifácio</logradouro_comercial>
      <cep_comercial>13054-788</cep_comercial>
      <bairro_comercial>Campo Grande</bairro_comercial>
      <estado_comercial>SP</estado_comercial>
      <numero>345</numero>
      <numero_comercial>345</numero_comercial>
      <numero_cobranca>345</numero_cobranca>
      <numero_entrega>345</numero_entrega>
      <crea>5464456464</crea>
      <cnpj_escritorio>4645646545664</cnpj_escritorio>
      <inscr_suframa>5365555</inscr_suframa>
      <complemento>Bloco A</complemento>
      <complemento_entrega>Bloco A</complemento_entrega>
      <complemento_cobranca>Bloco A</complemento_cobranca>
      <cnae>565656882544</cnae>
      <orgao_expedidor>ssp</orgao_expedidor>
      <uf_expedidor>SP</uf_expedidor>
      <data_cadastro>12/15/2014</data_cadastro>
      <pessoa_fisica>true</pessoa_fisica>
      <sexo>M</sexo>
      <id_pais>1</id_pais>
   </entidade>
</entidades>