Geral

API (Application Programming Interface) é um conjunto de padrões de programação que permite a troca de informações entre o banco de dados do sistema de ERP Axis Focus e o banco de dados de seu site. As informações abaixo são utilizadas por programadores para realizar este intercâmbio.

Utilize FORM POST na URL da API protegida por SSL (https://) para todos os métodos listados ao lado.

A identificação da empresa, campos: "empresa" e "senha", podem ser enviados de forma não segura pela url ou utilizar Authorization Basic Auth com username e password criptografado em Base 64, sendo esta a forma recomendada.

Todos os campos podem ser enviados tanto por url como por form post. Como o comprimento máximo padrão adotado para urls é de até 2048 caracteres o ideal é passar os valores das variáveis via form post.

Consulta: tabelas

Listagem de todas as tabelas que podem ser exportadas do sistema. Realize este consulta periodicamente porque estamos permanentemente incluindo novos recursos no sistema.

Post

/api/v1/exportar.aspx?empresa={nome da empresa}&senha={senha}&procedimento=importar&conteudo=tabelas&zip=N

{"tabelas": "atributos, atributos_itens, categorias_produtos, categorias_servicos, crm_fases_oportunidade, crm_oportunidades_origem, listas_precos, marcas, produtos, produtos_categorias, produtos_modelos, produtos_modelos_atributos, produtos_modelos_precos, produtos_unidades, segmentos, servicos, servicos_categorias, servicos_modelos, servicos_modelos_atributos, servicos_modelos_precos, servicos_unidades, templates_atributos, templates_atributos_itens, templates_producao, templates_producao_itens, unidades, produtos_imagens, produtos_modelos_imagens, servicos_imagens, servicos_modelos_imagens, atributos_itens_imagens"}

Consulta: schema

Retorna a estrutura completa da tabela bem como a configuração de todas as colunas.

Post

/api/v1/exportar.aspx?empresa={nome da empresa}&senha={senha}&procedimento=schema&conteudo={tabela}&zip=N

Exemplo para a tabela atributos

[
  {
    "column_name": "atributo_id",
    "title": "",
    "description": "",
    "column_key": "PRI",
    "column_type": "int(11)",
    "is_nullable": "NO"
  },
  {
    "column_name": "nome",
    "title": "Nome",
    "description": "Nome",
    "column_key": "",
    "column_type": "varchar(50)",
    "is_nullable": "NO"
  },
  {
    "column_name": "CreatedOn",
    "title": null,
    "description": null,
    "column_key": "",
    "column_type": "datetime",
    "is_nullable": "YES"
  },
  {
    "column_name": "ModifiedOn",
    "title": null,
    "description": null,
    "column_key": "",
    "column_type": "datetime",
    "is_nullable": "YES"
  }
]

POST - Tabela

Retorna todos os registros da tabela informada. Múltiplas tabelas podem ser informadas, bastando separá-las por ",".

Post

/api/v1/exportar.aspx?empresa={nome da empresa}&senha={senha}&procedimento=importar&conteudo={tabela}&zip=N

Exemplo de resultado para a tabela atributos

[
  {
    "atributo_id": 1,
    "nome": "Nome do atributo 1",
    "CreatedOn": "2017-02-06 15:14:13",
    "ModifiedOn": null
  },
  {
    "atributo_id": 2,
    "nome": "Nome do atributo 2",
    "CreatedOn": "2017-02-06 15:15:37",
    "ModifiedOn": null
  }
]

POST - Tabela Unificado

Retorna todos os registros da tabela informada e todas as tabelas filhas relacionadas.

Post

/api/v1/exportar.aspx?empresa={nome da empresa}&senha={senha}&procedimento=importar_unificado&modulo={modulo}

ParâmetroDescriçãoExemploObrigatório
moduloMódulos disponíveis: produtosmodulo=produtosSim
conteudoRelação de até 100 produto_id separados por ","conteudo=1,2,3Não
indice_inicialPosição inicial dos registros desejados.
Valor default: 0		indice_inicial=1050Não
quantidadeQuantidade de registros desejados, limitado em até 100 registros por consulta.
Valor default: 100		quantidade=60Não
deData inicial. Retorna todos os registros que foram alterados após a data inicial.
Formato: ddmmyyyy (12/10/2016 = 12102016) 		de=12102016Não
atéData final. Retorna todos os registros que foram alterados desde a data inicial, até a data final.
Formato: ddmmyyyy (12/10/2016 = 12102016) 		ate=12102016Não
zipCompacta o arquivo em formato zip (S | N).
Valor default: S		zip=NNão

Exemplo de resultado para a tabela produtos

{
  "produtos": [
    {
      "produto_id": "1",
      "nome": "Nome do produto",
      "descricao": "Descrição curta",
      "descricao_completa": "Descrição completa em formato html",
      "referencia": "referência do produto",
      "marca_id": "0",
      "marca_nome": "",
      "template_atributo_produto_modelo_id": "1",
      "template_producao_id": "1",
      "customizavel": "S",
      "aceita_encomenda": "S",
      "destaque": "N",
      "video_url": "",
      "seo_title": "Nome do produto",
      "seo_description": "Descrição",
      "seo_keywords": "",
      "seo_url": "url",
      "isdeleted": "0",
      "createdon": "12/09/2017 09:32:00",
      "modifiedon": "04/11/2017 10:28:51",
      "categorias_produto": [
        {
          "categoria_produto_id": "1",
          "nome": "Nome da categoria",
          "descricao": "",
          "categoria_antecessora_id": "1",
          "dt_inclusao": "21/08/2016 00:00:00",
          "insumo": "N",
          "seo_title": "",
          "seo_description": "",
          "seo_url": "url"
        }
      ],
      "produto_imagens": [
        {
          "nome": "{nome da imagem}",
          "pathLocal": "{endereco https da imagem}",
          "ordem": "1",
          "tamanho": "1",
          "modifiedon": "21/02/2017 13:51:53"
        },
        {
          "nome": "{nome da imagem}",
          "pathLocal": "{endereco https da imagem}",
          "ordem": "1",
          "tamanho": "2",
          "modifiedon": "21/02/2017 13:51:53"
        }
      ],
      "produtos_modelos": [
        {
          "produto_modelo_id": "1",
          "nome": "Nome do modelo",
          "descricao": "",
          "referencia": "referencia do modelo",
          "produto_unidade_id": "1",
          "produto_unidade_nome": "Unidade",
          "produto_unidade_sigla": "Un",
          "disponivel": "D",
          "altura": "0",
          "largura": "0",
          "comprimento": "0",
          "peso": "0",
          "valor": "0,00",
          "ean": "",
          "produtos_modelos_atributos": [
            {
              "atributo_id": "1",
              "nome": "Nome do atributo",
              "atributo_item_id": "1",
              "atributo_item_nome": "Nome do item do atributo",
              "atributo_item_imagem": [
                {
                  "nome": "{nome da imagem do atributo}",
                  "pathLocal": "{endereco https da imagem}",
                  "ordem": "1",
                  "tamanho": "1",
                  "modifiedon": "27/02/2017 11:19:07"
                }
              ]
            }
          ],
          "modelo_precos": [],
          "template_producao": [
            {
              "categorias_produto": []
            },
            {
              "categorias_servico": []
            },
            {
              "atributos": []
            },
            {
              "produtos": []
            },
            {
              "servicos": [
                {
                  "template_producao_item_id": "1",
                  "ordem": "1",
                  "nome": "Nome do serviço - Nome do modelo",
                  "prod_servico_id": "1",
                  "prod_servico_nome": "Nome do serviço",
                  "prod_servico_modelo_id": "1",
                  "prod_servico_modelo_nome": "Nome do modelo",
                  "prod_servico_quantidade": "0,000"
                },
                {
                  "template_producao_item_id": "2",
                  "ordem": "2",
                  "nome": "Nome do serviço - Nome do modelo",
                  "prod_servico_id": "2",
                  "prod_servico_nome": "Nome do serviço",
                  "prod_servico_modelo_id": "2",
                  "prod_servico_modelo_nome": "Nome do modelo",
                  "prod_servico_quantidade": "1,000"
                }
              ]
            }
          ],
          "produto_modelo_imagens": [
            {
              "nome": "{nome da imagem do atributo}",
              "pathLocal": "{endereco https da imagem}",
              "ordem": "1",
              "tamanho": "1",
              "modifiedon": "27/02/2017 16:33:44"
            },
            {
              "nome": "{nome da imagem do atributo}",
              "pathLocal": "{endereco https da imagem}",
              "ordem": "1",
              "tamanho": "2",
              "modifiedon": "27/02/2017 16:33:44"
            }
          ]
        }
      ]
    }
  ]
}

POST - Login

Valida o login de uma pessoa física.

Post

/api/v1/exportar.aspx?empresa={nome da empresa}&senha={senha}&procedimento=login&username={nome de usuário}&password={senha}

ParâmetroDescriçãoExemploObrigatório
usernameNome de usuáriousername=joaoSim
passwordSenha do usuáriopassword=1234Sim
zipCompacta o arquivo em formato zip (S | N).
Valor default: S		zip=NNão

Exemplo de resultado

{
  "pf": [
    {
      "pf_id": "1",
      "pj_id": "0"
    }
  ]
}

POST - Busca PJ PF

Pesquisa pessoa física ou jurídica.

Post

/api/v1/exportar.aspx?empresa={nome da empresa}&senha={senha}&procedimento=busca_pj_pf&email={email da pj/pf}

ParâmetroDescriçãoExemploObrigatório
emailE-mailemail=nome@empresa.com.brSim
zipCompacta o arquivo em formato zip (S | N).
Valor default: S		zip=NNão

Exemplo de resultado

{  
   "pj_pf":[  
      {  
         "pj":[  
            {  
               "pj_id":"1",
               "razao_social":"Empresa",
               "nome_fantasia":"Razão Social",
               "pj_unidades":[  
                  {  
                     "pj_unidade_id":"1",
                     "nome":"Matriz",
                     "logradouro":"",
                     "numero":"",
                     "complemento":"",
                     "bairro":"",
                     "cidade":"",
                     "estado":"",
                     "cep":"",
                     "pais":"Brasil",
                     "cnpj":""
                  }
               ],
               "pf":[  
                  {  
                     "pf_id":"1",
                     "nome":"João da Silva",
                     "nome_mais_conhecido":"João"
                  }
               ]
            }
         ]
      }
   ]
}

POST - pfs

Retorna uma listagem de pessoas físicas

Post

/api/v1/exportar.aspx?empresa={nome da empresa}&senha={senha}&procedimento=pfs

ParâmetroDescriçãoExemploObrigatório
pf_idRealiza uma pesquisa com base na pf_idpf_id=1Não
cpfRealiza uma pesquisa com base no cpfcpf=11122233344Não
emailRealiza uma pesquisa com base no e-mailemail=nome@empresa.com.brNão
zipCompacta o arquivo em formato zip (S | N).
Valor default: S		zip=NNão

Exemplo de resultado

{
  "pfs": [
    {
      "pf_id": "1",
      "nome": "João da Silva",
      "nome_mais_conhecido": "João",
      "rg": "",
      "cpf": "",
      "isdeleted": "0",
      "createdon": "05/08/2016 16:59:44",
      "modifiedon": "11/05/2017 14:24:22"
    },
    {
      "pf_id": "2",
      "nome": "José Pereira Costa",
      "nome_mais_conhecido": "José Pereira Costa",
      "rg": "",
      "cpf": "",
      "isdeleted": "0",
      "createdon": "16/12/2016 10:07:07",
      "modifiedon": "11/05/2017 16:37:32"
  ]
}

POST - pf

Retorna detalhes de uma pessoa física

Post

/api/v1/exportar.aspx?empresa={nome da empresa}&senha={senha}&procedimento=pf

ParâmetroDescriçãoExemploObrigatório
pf_idRetorna o detalhe de uma pessoa física com base no seu idpf_id=1Sim
zipCompacta o arquivo em formato zip (S | N).
Valor default: S		zip=NNão

Exemplo de resultado

{
  "pf": [
    {
      "pf_id": "1",
      "pj_id": "0",
      "pj_nome_fantasia": "",
      "pj_unidade_id": "0",
      "pj_unidade_nome": "",
      "unidade_id": "2",
      "nome": "João da Silva",
      "nome_mais_conhecido": "João",
      "username": "joao",
      "cargo": "Administrador",
      "rg": "",
      "cpf": "",
      "doc_estrangeiro": "",
      "sexo": "M",
      "dt_nascimento": "",
      "website": "",
      "lista_preco_produto_id": "0",
      "lista_preco_servico_id": "0",
      "area_atuacao_id": "0",
      "vendedor_id": "0",
      "ativo": "S",
      "notas": "",
      "isdeleted": "0",
      "createdon": "05/08/2016 16:59:44",
      "modifiedon": "11/05/2017 14:24:22",
      "pf_unidades": [
        {
          "pf_unidade_id": "1",
          "nome": "Matriz",
          "logradouro": "",
          "numero": "",
          "complemento": "",
          "bairro": "",
          "cidade": "",
          "estado": "",
          "pais": "Brasil",
          "cep": "",
          "telefone_1": "",
          "telefone_2": "",
          "telefone_3": "",
          "telefone_4": "",
          "email_1": "",
          "email_2": "",
          "notas": "",
          "ativo": "S",
          "isdeleted": "0",
          "createdon": "26/05/2017 10:22:36",
          "modifiedon": "11/05/2017 11:58:40"
        }
      ]
    }
  ]
}

POST - pjs

Retorna uma listagem de pessoas jurídicas

Post

/api/v1/exportar.aspx?empresa={nome da empresa}&senha={senha}&procedimento=pjs

ParâmetroDescriçãoExemploObrigatório
pj_idRealiza uma pesquisa com base na pj_idpj_id=1Não
cnpjRealiza uma pesquisa com base no cnpjcnpj=11122233344Não
emailRealiza uma pesquisa com base no e-mailemail=nome@empresa.com.brNão
zipCompacta o arquivo em formato zip (S | N).
Valor default: S		zip=NNão

Exemplo de resultado

{
  "pjs": [
    {
      "pj_id": "1",
      "nome_fantasia": "Empresa",
      "razao_social": "Razão Social",
      "isdeleted": "0",
      "createdon": "17/04/2017 16:58:32",
      "modifiedon": "20/01/2017 11:19:22"
    }
  ]
}

POST - pj

Retorna detalhes de uma pessoa jurídica

Post

/api/v1/exportar.aspx?empresa={nome da empresa}&senha={senha}&procedimento=pj

ParâmetroDescriçãoExemploObrigatório
pf_idRetorna o detalhe de uma pessoa física com base no seu idpf_id=1Sim
zipCompacta o arquivo em formato zip (S | N).
Valor default: S		zip=NNão

Exemplo de resultado

{
  "pj": [
    {
      "pj_id": "1",
      "nome_fantasia": "Empresa",
      "razao_social": "Razão Social",
      "website": "",
      "lista_preco_produto_id": "0",
      "lista_preco_servico_id": "0",
      "area_atuacao_id": "0",
      "vendedor_id": "1",
      "ativo": "S",
      "notas": "Notas",
      "isdeleted": "0",
      "createdon": "17/04/2017 16:58:32",
      "modifiedon": "20/01/2017 11:19:22",
      "pj_unidades": [
        {
          "pj_unidade_id": "1",
          "nome": "Matriz",
          "logradouro": "",
          "numero": "",
          "complemento": "",
          "bairro": "",
          "cidade": "",
          "estado": "",
          "pais": "",
          "cep": "",
          "telefone_1": "",
          "telefone_2": "",
          "telefone_3": "",
          "telefone_4": "",
          "email_1": "",
          "email_2": "",
          "cnpj": "",
          "inscricao_estadual": "",
          "inscricao_estadual_indicador": "1",
          "inscricao_municipal": "",
          "doc_estrangeiro": "",
          "notas": "",
          "ativo": "S",
          "isdeleted": "0",
          "createdon": "10/03/2017 10:19:17",
          "modifiedon": "10/03/2017 10:19:17"
        }
      ]
    }
  ]
}

POST - Orçamentos

Retorna uma listagem de orçamentos com base nos critérios de busca

Post

/api/v1/exportar.aspx?empresa={nome da empresa}&senha={senha}&procedimento=orcamentos

ParâmetroDescriçãoExemploObrigatório
indice_inicialPosição inicial dos registros desejados.
Valor default: 0		indice_inicial=1050Não
quantidadeQuantidade de registros desejados, limitado em até 100 registros por consulta.
Valor default: 100		quantidade=60Não
deData inicial. Retorna todos os registros que foram alterados após a data inicial.
Formato: ddmmyyyy (12/10/2016 = 12102016) 		de=12102016Não
atéData final. Retorna todos os registros que foram alterados desde a data inicial, até a data final.
Formato: ddmmyyyy (12/10/2016 = 12102016) 		ate=12102016Não
pj_idRetorna os orçamentos da pj_id informadapj_id=1Não
pf_idRetorna os orçamentos da pf_id informada.
Atenção: 		pf_id=1Não
zipCompacta o arquivo em formato zip (S | N).
Valor default: S		zip=NNão

Exemplo de resultado

{
  "orcamentos": [
    {
      "orcamento_id": "1",
      "dt_solicitacao": "2017-01-04 08:25:59",
      "dt_envio": ""
    },
    {
      "orcamento_id": "2",
      "dt_solicitacao": "2017-01-10 16:06:52",
      "dt_envio": "2017-01-10 17:03:27"
    },
    {
      "orcamento_id": "3",
      "dt_solicitacao": "2017-01-19 11:55:09",
      "dt_envio": ""
    }
  ]
}

POST - Orçamento

Retorna o detalhamento de um orçamento

Post

/api/v1/exportar.aspx?empresa={nome da empresa}&senha={senha}&procedimento=orcamento

ParâmetroDescriçãoExemploObrigatório
orcamento_idId do orçamento que deseja consultarorcamento=1Sim
zipCompacta o arquivo em formato zip (S | N).
Valor default: S		zip=NNão

Exemplo de resultado

{
  "orcamento": [
    {
      "unidade_nome": "Matriz",
      "unidade_nome_fantasia": "Matriz",
      "unidade_razao_social": "Matriz",
      "unidade_logradouro": "",
      "unidade_numero": "",
      "unidade_complemento": "",
      "unidade_bairro": "",
      "unidade_cidade": "",
      "unidade_estado": "",
      "unidade_pais": "",
      "unidade_cep": "",
      "unidade_cnpj": "",
      "unidade_inscricao_estadual": "",
      "unidade_website": "",
      "unidade_telefone_1": "",
      "unidade_email_1": "",
      "cliente_nome": "",
      "cliente_nome_fantasia": "",
      "cliente_unidade_nome": "Matriz",
      "cliente_unidade_logradouro": "",
      "cliente_unidade_numero": "",
      "cliente_unidade_complemento": "",
      "cliente_unidade_bairro": "",
      "cliente_unidade_cidade": "",
      "cliente_unidade_estado": "",
      "cliente_unidade_cep": "",
      "cliente_unidade_pais": "Brasil",
      "cliente_unidade_cnpj_cpf": "",
      "cliente_unidade_ie_rg": "",
      "cliente_unidade_email_1": "",
      "cliente_unidade_telefone_1": "",
      "cliente_unidade_telefone_2": "",
      "cliente_unidade_telefone_3": "",
      "contato_nome": "",
      "contato_cargo": "",
      "contato_email_1": "",
      "contato_telefone_1": "",
      "contato_telefone_2": "",
      "contato_telefone_3": "",
      "orcamento_id": "1",
      "finalidade_pedido": "",
      "prazo_entrega": "",
      "condicoes_pagamento": "",
      "frete_responsavel": "Sem frete / Não incluso / Retira",
      "frete_valor": "",
      "dt_solicitacao": "2017-01-04 08:25:59",
      "dt_envio": "",
      "informacoes_do_cliente_orcamento": "",
      "informacoes_ao_cliente_orcamento": "",
      "funcionario_nome": "João da Silva",
      "funcionario_cargo": "Administrador",
      "funcionario_email_1": "",
      "funcionario_telefone_1": "",
      "funcionario_telefone_2": "",
      "orcamento_itens": [
        {
          "produto_id": "",
          "servico_id": "1",
          "prod_serv_nome": "",
          "prod_serv_descricao": "",
          "prod_serv_descricao_completa": "",
          "prod_serv_modelo_id": "1",
          "prod_serv_modelo": "",
          "prod_serv_modelo_descricao": "",
          "prod_serv_modelo_referencia": "",
          "prod_serv_info_do_cliente": "",
          "prod_serv_info_ao_cliente": "",
          "prod_serv_prazo_entrega": "",
          "prod_serv_quantidade_solicitada": "0,000",
          "prod_serv_preco_unitario_base": "0,00",
          "prod_serv_preco_desconto": "0,0000",
          "prod_serv_quantidade": "0,000",
          "prod_serv_preco_unitario": "0,00",
          "conjunto": "1"
        },
        {
          "produto_id": "1",
          "servico_id": "",
          "prod_serv_nome": "",
          "prod_serv_descricao": "",
          "prod_serv_descricao_completa": "",
          "prod_serv_modelo_id": "1",
          "prod_serv_modelo": "",
          "prod_serv_modelo_descricao": "",
          "prod_serv_modelo_referencia": "",
          "prod_serv_info_do_cliente": "",
          "prod_serv_info_ao_cliente": "",
          "prod_serv_prazo_entrega": "",
          "prod_serv_quantidade_solicitada": "0,000",
          "prod_serv_preco_unitario_base": "0,00",
          "prod_serv_preco_desconto": "0,0000",
          "prod_serv_quantidade": "0,000",
          "prod_serv_preco_unitario": "0,00",
          "conjunto": "2"
        }
      ]
    }
  ]
}

POST - Incluir Orçamento

Insere no banco de dados orçamento e oportunidade

Post

/api/v1/importar.aspx?empresa={nome da empresa}&senha={senha}&procedimento=incluir_orcamento

NívelChaveTipoTamanhoObrigatórioComentário
1orcamentoSim
1.1unidade_idint11SimId da empresa que recebe o orçamento.
1.2segmento_idint11SimSegmento da empresa, exemplo: Corporativo, Loja Virtual, Revenda.
1.3pjSimAo informar uma pessoa física, o campo pj será a empresa e o campo pf será o representante/contato desta empresa.
1.3.1nome_fantasiavarchar100Sim
1.3.2razao_socialvarchar100Sim
1.3.3websitevarchar50Não
1.3.4area_atuacao_idint11Não
1.3.5pj_unidadeNãoTodos os campos da unidade da pj são opcionais, porém, se for informado o grupo, é necessário informar o nome da unidade. O nome da unidade pode ser: Matriz, Filião São Paulo, Depósito ou qualquer outro.
1.3.5.1nomevarchar50Sim
1.3.5.2logradourovarchar50Não
1.3.5.3numerovarchar20Não
1.3.5.4complementovarchar60Não
1.3.5.5bairrovarchar50Não
1.3.5.6cidadevarchar50Não
1.3.5.7estadovarchar50Não
1.3.5.8paisvarchar50Não
1.3.5.9cepvarchar20Não
1.3.5.10telefone_1varchar20Não
1.3.5.11telefone_2varchar20Não
1.3.5.12telefone_3varchar20Não
1.3.5.13telefone_4varchar20Não
1.3.5.14email_1varchar50Não
1.3.5.15email_2varchar50Não
1.3.5.16cnpjvarchar20Não
1.4pfSimSe o grupo pj não for informado, o cliente será cadastrado somente como pessoa física, sem ficar associado a alguma empresa.
1.4.1nomevarchar100Sim
1.4.2nome_mais_conhecidovarchar50Sim
1.4.3usernamevarchar50Não
1.4.4senhavarchar20Não
1.4.5cargovarchar50Não
1.4.6rgvarchar20Não
1.4.7cpfvarchar20Não
1.4.8sexochar1Não(S | N)
1.4.9dt_nascimentodatetimeNão
1.4.10area_atuacao_idint11Não
1.4.11pf_unidadeSim
1.4.11.1nomevarchar50Sim
1.4.11.2logradourovarchar50Não
1.4.11.3numerovarchar20Não
1.4.11.4complementovarchar60Não
1.4.11.5bairrovarchar50Não
1.4.11.6cidadevarchar50Não
1.4.11.7estadovarchar50Não
1.4.11.8paisvarchar50Não
1.4.11.9cepvarchar20Não
1.4.11.10telefone_1varchar20Não
1.4.11.11telefone_2varchar20Não
1.4.11.12telefone_3varchar20Não
1.4.11.13telefone_4varchar20Não
1.4.11.14email_1varchar50Não
1.4.11.15email_2varchar50Não
1.5crm_oportunidadeNãoSe for informado o grupo de oportunidades, todos os campos são obrigatórios.
1.5.1nomevarchar100Sim
1.5.2descricaotextSim
1.5.3crm_oportunidade_origem_idint11Sim
1.5.4crm_fase_oportunidade_idint11Sim
1.5.5valor_esperadodecimal16,2Sim
1.5.6probabilidade_fechamentoint11Sim
1.6orcamento_itensSim
1.6.1produto_modelo_idint11SimEnviar somente o item utilizado, produto_modelo_id ou servico_modelo_id.
1.6.2servico_modelo_idint11Sim
1.6.3informacoes_do_clientetextNão
1.6.4modelo_precosSimObrigatório quando informado um produto_modelo_id.
1.6.4.1quantidadeint11SimPode ser qualquer valor acima da quantidade mínima, quando existir. Se não houver quantidade mínima, o valor mínimo deve ser 1. Pode ser enviado qualquer valor, 100, 200, 300 (correspondentes as faixas de preço) ou valores que não existam na faixa de preço como 157, 234.
1.6.5servicos_modelos_precosSimObrigatório quando informado um servico_modelo_id.
1.6.5.1quantidadeint11SimPode ser qualquer valor acima da quantidade mínima, quando existir. Se não houver quantidade mínima, o valor mínimo deve ser 1. Pode ser enviado qualquer valor, 100, 200, 300 (correspondentes as faixas de preço) ou valores que não existam na faixa de preço como 157, 234.
1.6.6producao_componentesNão
1.6.6.1producao_componentes_itensSim
1.6.6.1.1template_producao_item_idint11Sim
1.6.6.1.2produto_modelo_idint11SimO produto pode ter como componente um produto/modelo ou serviço/modelo ou atributo. Neste caso, enviar somente o correspondente. Se é um produto_modelo_id, omitir os campos servico_modelo_id e atributo_item_id. Se for um servico_modelo_id, omitir o produto_modelo_id e o atributo_item_id e assim sucessivamente.
1.6.6.1.3servico_modelo_idint11Sim
1.6.6.1.4atributo_item_idint11Sim
1.6.6.1.5quantidadeint11Sim/NãoSe produto_modelo_id ou servico_modelo_id, o campo quantidade deve ser preenchido com um valor diferente de 0. Para atributo o campo quantidade deve ser omitido.

Exemplo de json

{
  "orcamento":[
    {
      "unidade_id":"1",
      "segmento_id":"1",
      "pj":[
        {
          "nome_fantasia":"Teste de Empresa",
          "razao_social":"Teste de Empresa Ltda - EPP",
          "website":"www.teste.com.br",
          "area_atuacao_id":"0",
          "pj_unidade":[
            {
              "nome":"Matriz",
              "logradouro":"Rua da Empresa Teste",
              "numero":"123",
              "complemento":"Sala 1",
              "bairro":"Centro",
              "cidade":"São Bernardo do Campo",
              "estado":"São Paulo",
              "pais":"Brasil",
              "cep":"09820-000",
              "telefone_1":"11-4567-9389",
              "telefone_2":"",
              "telefone_3":"",
              "telefone_4":"",
              "email_1":"contato@teste.com.br",
              "email_2":"comercial@teste.com.br",
              "cnpj":"",
              "inscricao_estadual":""}
          ]
        }
      ],
      "pf":[
        {
          "nome":"Pereira da Silva",
          "nome_mais_conhecido":"Pereira",
          "username":"pereira",
          "senha":"1234",
          "cargo":"Comprador",
          "rg":"23.123.123-1",
          "cpf":"231.221.123-06",
          "sexo":"M",
          "dt_nascimento":"20/10/1980",
          "area_atuacao_id":"0",
          "pf_unidade":[
            {
              "nome":"Matriz",
              "logradouro":"Rua da Empresa Teste",
              "numero":"123",
              "complemento":"Sala 1",
              "bairro":"Centro",
              "cidade":"São Bernardo do Campo",
              "estado":"São Paulo",
              "pais":"Brasil",
              "cep":"09820-000",
              "telefone_1":"11-4567-9389",
              "telefone_2":"",
              "telefone_3":"",
              "telefone_4":"",
              "email_1":"contato@teste.com.br",
              "email_2":"comercial@teste.com.br"
            }
          ]
        }
      ],
      "crm_oportunidade":[
        {
          "nome":"Orçamento solicitado via site",
          "descricao":"Orçamento solicitado via site",
          "crm_oportunidade_origem_id":"1",
          "crm_fase_oportunidade_id":"1",
          "valor_esperado":"48901,21",
          "probabilidade_fechamento":"50"
        }
      ],
      "orcamento_itens":[
        {
          "produto_modelo_id":"189",
          "servico_modelo_id":"0",
          "informacoes_do_cliente":"Incluir BV de 15%",
          "modelos_precos":[
            {
              "quantidade":"100"
            },
            {
              "quantidade":"200"
            },
            {
              "quantidade":"300"
            }
          ],
          "producao_componentes_itens":[
            {
              "template_producao_item_id":"1",
              "produto_modelo_id":"1",
              "servico_modelo_id":"0",
              "atributo_item_id":"0",
              "quantidade":"1"
            },
            {
              "template_producao_item_id":"11",
              "produto_modelo_id":"0",
              "servico_modelo_id":"1",
              "atributo_item_id":"0",
              "quantidade":"1"
            }
          ]
        },
        {
          "produto_modelo_id":"189",
          "informacoes_do_cliente":"Incluir BV de 15%",
          "modelos_precos":[
            {
              "quantidade":"100"
            },
            {
              "quantidade":"200"
            },
            {
              "quantidade":"300"
            }
          ],
          "producao_componentes_itens":[
            {
              "template_producao_item_id":"2",
              "produto_modelo_id":"2",
              "servico_modelo_id":"0",
              "atributo_item_id":"0",
              "quantidade":"1"
            },
            {
              "template_producao_item_id":"3",
              "produto_modelo_id":"0",
              "servico_modelo_id":"1",
              "atributo_item_id":"0",
              "quantidade":"1"
            }
          ]
        }
      ]
    }
  ]
}

POST - Incluir Pessoa Jurídica

Insere no banco de dados pessoas jurídicas e suas unidades/contatos

Post

/api/v1/importar.aspx?empresa={nome da empresa}&senha={senha}&procedimento=incluir_pj&json={arquivo com a estrutura abaixo}

NívelChaveTipoTamanhoObrigatórioComentário
1orcamentoSim

Exemplo de json

{
	"pessoaJuridica": [
		{
			"pj": [
				{
					"nome_fantasia": "Teste de Empresa",
					"razao_social": "Teste de Empresa Ltda - EPP",
					"website": "www.teste.com.br",
					"area_atuacao_id": "0",
					"pj_unidade": [
						{
							"nome": "Matriz",
							"logradouro": "Rua da Empresa Teste",
							"numero": "123",
							"complemento": "Sala 1",
							"bairro": "Centro",
							"cidade": "São Bernardo do Campo",
							"estado": "São Paulo",
							"pais": "Brasil",
							"cep": "00000-000",
							"telefone_1": "11-4567-9389",
							"telefone_2": "",
							"telefone_3": "",
							"telefone_4": "",
							"email_1": "contato@teste2.com.br",
							"email_2": "comercial@teste2.com.br",
							"cnpj": "",
							"inscricao_estadual": ""
						}
					]
				}
			],
			"pf": [
				{
					"nome": "Pereira da Silva",
					"nome_mais_conhecido": "Pereira",
					"username": "pereira",
					"senha": "1234",
					"cargo": "Comprador",
					"rg": "",
					"cpf": "",
					"sexo": "M",
					"dt_nascimento": "20/10/1980",
					"area_atuacao_id": "0",
					"pf_unidade": [
						{
							"nome": "Matriz",
							"logradouro": "Rua da Empresa Teste",
							"numero": "123",
							"complemento": "Sala 1",
							"bairro": "Centro",
							"cidade": "São Bernardo do Campo",
							"estado": "São Paulo",
							"pais": "Brasil",
							"cep": "00000-000",
							"telefone_1": "11-4567-9389",
							"telefone_2": "",
							"telefone_3": "",
							"telefone_4": "",
							"email_1": "contato@teste2.com.br",
							"email_2": "comercial@teste2.com.br"
						}
					]
				}
			]
		}
	]
}

POST - Incluir Pessoa Física

Insere no banco de dados pessoas físicas e suas unidades (endereços)

Post

/api/v1/importar.aspx?empresa={nome da empresa}&senha={senha}&procedimento=incluir_pf&json={arquivo com a estrutura abaixo}

NívelChaveTipoTamanhoObrigatórioComentário
1orcamentoSim

Exemplo de json

{
	"pessoaFisica": [
		{
			"pf": [
				{
					"nome": "Nome da Pessoa Física",
					"nome_mais_conhecido": "Nome mais conhecido",
					"username": "joao",
					"senha": "1234",
					"cargo": "Comprador",
					"rg": "",
					"cpf": "",
					"sexo": "M",
					"dt_nascimento": "20/10/1980",
					"area_atuacao_id": "0",
					"pf_unidade": [
						{
							"nome": "Residência",
							"logradouro": "Rua do João",
							"numero": "123",
							"complemento": "Apto 10",
							"bairro": "Centro",
							"cidade": "São Bernardo do Campo",
							"estado": "São Paulo",
							"pais": "Brasil",
							"cep": "00000-000",
							"telefone_1": "11-4567-9389",
							"telefone_2": "",
							"telefone_3": "",
							"telefone_4": "",
							"email_1": "email@provedor.com.br",
							"email_2": ""
						}
					]
				}
			]
		}
	]
}
PROMOÇÃO
por tempo limitado!
Encerra em...
Ganhe 50% de desconto por 3 meses
+ Consultoria gratuita
Solicitar meu acesso