Manual da API de determinação de perfil

• Introdução
• Acesso
• API Busca de perfil
• Descrição dos campos de Entrada
• Descrição dos campos de retorno
• Exemplo de chamada
• API de inclusão de perfil
• Descrição dos campos de Entrada
• Descrição dos campos de retorno
• Exemplos de chamada e retorno
• API de consulta de perfil
• Descrição dos campos de Retorno
• Exemplos de chamada e retorno
• API de atualização de perfil
• Descrição dos campos de Entrada
• Descrição dos campos de retorno
• Exemplos de chamada e retorno
• API de desativação de perfil
• Descrição dos campos de Retorno
• Exemplos de chamada e retorno
• API de ativação de perfil
• Descrição dos campos de Retorno
• Exemplos de chamada e retorno

Introdução

O serviço de determinação de perfil foi criado para facilitar a interpretação da operação do cliente, chegando assim, aos códigos correspondentes da Systax.

Acesso

omunicação: REST/JSON

Para acessar a coleção de chamadas Clique Aqui.

Swagger
https://determinacao-perfil.systax.com.br/api/index.html

Listagem dos Endpoints que contemplam o manual de Determinação de Perfil.

Descrição	Versão	Grupo Swagger	Método	URL Endpoint	URL Token
API de Busca de Perfil	v1	Perfil	POST	http://determinacao-perfil.systax.com.br/api/v1/perfil/buscar/cliente/{id_cliente}	http://app.systax.com.br/platform/access-token
API de Inclusão de Perfil	v1	Perfil	POST	https://determinacao-perfil.systax.com.br/api/v1/perfil/cliente/{id_cliente}	http://app.systax.com.br/platform/access-token
API de Consulta de Perfil	v1	Perfil	GET	https://determinacao-perfil.systax.com.br/api/v1/perfil/{id_perfil}/cliente/{id_cliente}	http://app.systax.com.br/platform/access-token
API de Atualização de Perfil	v1	Perfil	PUT	https://determinacao-perfil.systax.com.br/api/v1/perfil/{id_perfil}/cliente/{id_cliente}	http://app.systax.com.br/platform/access-token
API de Desativação de Perfil	v1	Perfil	GET	https://determinacao-perfil.systax.com.br/api/v1/perfil/{id_perfil}/desativar/cliente/{id_cliente}	http://app.systax.com.br/platform/access-token
API de Ativação de Perfil	v1	Perfil	GET	https://determinacao-perfil.systax.com.br/api/v1/perfil/{id_perfil}/ativar/cliente/{id_cliente}	http://app.systax.com.br/platform/access-token

Observações:

• O parâmetro id_cliente deverá receber o código de cliente informado pela Systax. 
• O parâmetro id_perfil deverá receber o código do perfil da operação.

API Busca de perfil

Descrição dos campos de Entrada

Campo	Descrição
uf_origem	UF do remetente da operação
uf_destino	UF do destinatário da operação
ent_sai	Movimento da operação
cfop	Código CFOP
cnpj_orig	CNPJ do emitente
cnpj_dest	CNPJ do destinatário
crt_emit	Código de situação do Simples Nacional
ind_final	Indicador de operação com consumir final
mod	Modelo da NF-e
cpf_dest	CPF do destinatário
icms_mod_bcst	Modalidade da base de cálculo do ICMS-ST
cmun_dest	Código de município do destinatário
cnae_rem	Código CNAE do remetente
cnae_dest	Código CNAE do destinatário
cod_prod	Código do produto
ncm	NCM
ex	EX da TIPI
devolucao	Indicador de devolução da mercadoria

Para mais detalhes sobre os campos "nat_op","finalidade","perfil_rem","perfil_dest" acessar a última versão do documento no link: https://documentacao.systax.com.br/books/tabelas-auxiliares

 Tabela de referência para o campo "ent_sai"

Código	Descrição
0	Entrada
1	Saída

 Tabela de referência para o campo "crt_emit"

Código	Descrição
1	Simples
2	Simples, mas com sublimite atingido
3	Normal

 Tabela de referência para o campo "ind_final"

Código	Descrição
0	Normal
1	Consumidor final

Tabela de referência para o campo "devolução"

Código	Descrição
0	Não
1	Sim

Descrição dos campos de retorno

Campo	Pai	Descrição
data	/	Grupo com as informações do perfil
id	data	Código do perfil. Permite fazer a gestão das informações posteriormente
nat_op	data	Código da natuteza de operação
finalidade	data	Código de finalidade
perfil_rem	data	Código de perfil do remetente
perfil_dest	data	Código de perfil do destinatário
success	/	Status do retorno
message	/	Mensagem do retorno

Tabela de referência para os campos "success" e "message"

success	message
true	Perfil encontrado

Exemplo de chamada

{
            "uf_origem": "DE",
            "uf_destino": "gfd",
            "ent_sai": "0",
            "cfop": "",
            "cnpj_orig": "",
            "cnpj_dest": "",
            "crt_emit": "2",
            "ind_final": "0",
            "mod": "",
            "cpf_dest": false,
            "icms_mod_bcst": "",
            "cmun_dest": "",
            "cnae_rem": "",
            "cnae_dest": "",
            "cod_prod": "",
            "ncm": "",
            "ex": "",
            "devolucao": false
}

API de inclusão de perfil

Descrição dos campos de Entrada

Campo	Descrição
nat_op	Código de natureza de operação
finalidade	Finalidade
perfil_rem	Código de perfil do remetente
perfil_dest	Código de perfil do destinatário
prioridade	Critério de desempate na API de busca, caso duas ou mais regras tenham a mesma incidência. Há dois critérios de desempate: primeiro, pela regra que possui mais campos preenchidos, e depois pelo campo prioridade.

Descrição dos campos de retorno

Campo	Descrição
success	Status de retorno
message	Mensagem de retorno

Tabela de referência para os campos "success" e "message"

Código	Descrição
true	Perfil inserido com sucesso.

Exemplos de chamada e retorno

Chamada

{
  "uf_origem": "SP",
  "uf_destino": "RR",
  "ent_sai": "1",
  "cfop": "string",
  "cnpj_orig": "string",
  "cnpj_dest": "string",
  "crt_emit": "string",
  "ind_final": "string",
  "mod": "string",
  "cpf_dest": true,
  "icms_mod_bcst": "string",
  "cmun_dest": "string",
  "cnae_rem": "string",
  "cnae_dest": "string",
  "cod_prod": "string",
  "ncm": "string",
  "ex": "string",
  "devolucao": true,
  "nat_op": "string",
  "finalidade": "string",
  "perfil_rem": "string",
  "perfil_dest": "string",
  "prioridade": 0
}

 

Retorno

{
  "success": true,
  "message": "Perfil inserido com sucesso."
}

 

API de consulta de perfil

Descrição dos campos de Retorno

Campos específicos do retorno da API de consulta de perfil

Campo	PAI	Descrição
id_usuario		Identificador do usuário
data_criacao		Data de criação do perfil
data_alteracao		Data de alteração do perfil
success	/	Status de retorno
message	/	Mensagem de retorno

Tabela de referência para os campos "success" e "message"

success	message
true	null

Exemplos de chamada e retorno

Chamada

O código do cliente e o identificador do perfil, são informados na URL de requisição:

Retorno

{
  "data": {
    "id": 8717,
    "uf_origem": "SP",
    "uf_destino": "SP",
    "ent_sai": "0",
    "cfop": "5403",
    "cnpj_orig": "",
    "cnpj_dest": "",
    "crt_emit": "2",
    "ind_final": "0",
    "mod": "",
    "cpf_dest": false,
    "icms_mod_bcst": "",
    "cmun_dest": "",
    "cnae": null,
    "cod_prod": "",
    "ncm": "",
    "ex": "",
    "devolucao": false,
    "nat_op": "121",
    "finalidade": "569",
    "perfil_rem": "2,243",
    "perfil_dest": "138",
    "prioridade": 0,
    "id_usuario": 0,
    "data_criacao": "2021-01-21T17:31:04.5882121",
    "data_alteracao": "2021-01-21T17:31:04.5882105"
  },
  "success": true,
  "message": null
}

API de atualização de perfil

Descrição dos campos de Entrada

Campos específicos de entrada da API de atualização de perfil

Campo	Descrição
nat_op	Código de natureza de operação
finalidade	Finalidade
perfil_rem	Código de perfil do remetente
perfil_dest	Código de perfil do destinatário
prioridade	Critério de desempate na API de busca, caso duas ou mais regras tenham a mesma incidência. Há dois critérios de desempate: primeiro, pela regra que possui mais campos preenchidos, e depois pelo campo prioridade.
ativo	Status do perfil

Tabela de referência para o campo "ativo"

ativo

true

false

Descrição dos campos de retorno

success	message
success	Status de retorno
message	Mensagem de retorno

Tabela de referência para os campos "success" e "message"

success	message
true	Atualizado com sucesso
false	Não foi possível atualizar o perfil

Exemplos de chamada e retorno

Chamada

O código do cliente e o identificador do perfil, são informados na URL de requisição:

 

{
  "id": 8717,
  "uf_origem": "",
  "uf_destino": "",
  "ent_sai": "",
  "cfop": "",
  "cnpj_orig": "",
  "cnpj_dest": "",
  "crt_emit": "",
  "ind_final": "",
  "mod": "",
  "cpf_dest": true,
  "icms_mod_bcst": "",
  "cmun_dest": "",
  "cnae_rem": "",
  "cnae_dest": "",
  "cod_prod": "",
  "ncm": "",
  "ex": "",
  "devolucao": true,
  "nat_op": "",
  "finalidade": "",
  "perfil_rem": "",
  "perfil_dest": "",
  "prioridade": 0,
  "ativo": true
}

Retorno

{
  "success": true,
  "message": "Perfil atualizado com sucesso."
}

API de desativação de perfil

Descrição dos campos de Retorno

Campo	Descrição
success	Status de retorno
message	Mensagem de retorno

Tabela de referência dos campos "success" e "message"

success	message
true	Perfil desativado

Exemplos de chamada e retorno

Chamada

O código do cliente e o identificador do perfil, são informados na URL de requisição:

Retorno

{
  "success": true,
  "message": "Perfil desativado."
}

 

API de ativação de perfil

Descrição dos campos de Retorno

Campo	Descrição
success	Status de retorno
message	Mensagem de retorno

 

Tabela de referência dos campos "success" e "message"

success	message
true	Perfil ativado

Exemplos de chamada e retorno

Chamada

O código do cliente e o identificador do perfil, são informados na URL de requisição:

 

Retorno

{
  "success": true,
  "message": "Perfil ativado."
}