# Manual da API de determinação de perfil Manual contendo as últimas atualizações efetuadas em 24/01/2024. # 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](https://vertexinc.sharepoint.com/sites/Systax-Data-SystaxProdutos/_layouts/15/download.aspx?UniqueId=f566b85bbbb146c191f4b202db8bd6dd&e=1cEeuk). **Swagger** [https://determinacao-perfil.systax.com.br/api/index.html](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://determinacao-perfil.systax.com.br/api/v1/perfil/buscar/cliente/%7bid_cliente%7d) [http://app.systax.com.br/platform/access-token](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}](https://determinacao-perfil.systax.com.br/api/v1/perfil/cliente/%7bid_cliente%7d) [http://app.systax.com.br/platform/access-token](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}](https://determinacao-perfil.systax.com.br/api/v1/perfil/%7bid_perfil%7d/cliente/%7bid_cliente%7d) [http://app.systax.com.br/platform/access-token](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}](https://determinacao-perfil.systax.com.br/api/v1/perfil/%7bid_perfil%7d/cliente/%7bid_cliente%7d) [http://app.systax.com.br/platform/access-token](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}](https://determinacao-perfil.systax.com.br/api/v1/perfil/%7bid_perfil%7d/desativar/cliente/%7bid_cliente%7d) [http://app.systax.com.br/platform/access-token](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}](https://determinacao-perfil.systax.com.br/api/v1/perfil/%7bid_perfil%7d/ativar/cliente/%7bid_cliente%7d) [http://app.systax.com.br/platform/access-token](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 API de busca de perfil na tabela de determinação de perfil, com os dados da chamada que são compostos de informações presentes no cadastro do cliente e nos campos da NF-e. # 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](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 Essa API de inclusão de perfil insere na tabela de determiação de perfil novos perfis específicos. São iguais aos campos de entrada da API de busca de perfil com alguns campos específicos. Acessar os campos da API de busca de perfil: [https://documentacao.systax.com.br/books/manual-da-api-de-determinacao-de-perfil/page/descricao-dos-campos-da-entrada](https://documentacao.systax.com.br/books/manual-da-api-de-determinacao-de-perfil/page/descricao-dos-campos-de-entrada-fsV) # 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 A API de consulta de perfil busca na tabela de determinação de perfil dados de determinado perfil retornando informações de quem criou o perfil na tabela, assim como a data que foi criado e alterado. São iguais aos campos de entrada da API de busca de perfil. Para mais detalhes, acesse o link: [https://documentacao.systax.com.br/books/manual-da-api-de-determinacao-de-perfil/page/descricao-dos-campos-de-entrada-fsV](https://documentacao.systax.com.br/books/manual-da-api-de-determinacao-de-perfil/page/descricao-dos-campos-de-entrada-fsV) # 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: [![API Consulta - Exemplo chamada.PNG](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/api-consulta-exemplo-chamada.PNG)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/api-consulta-exemplo-chamada.PNG) **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 Nesta API de atualização de perfil é possivel alterar um registro da tabela de determinação de perfil. São iguais aos campos de entrada da API de busca de perfil com alguns campos específicos. Acessar os campos da API de busca de perfil: [https://documentacao.systax.com.br/books/manual-da-api-de-determinacao-de-perfil/page/descricao-dos-campos-de-entrada-fsV](https://documentacao.systax.com.br/books/manual-da-api-de-determinacao-de-perfil/page/descricao-dos-campos-de-entrada-fsV) # 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: [![API At. Perfil - Exemplo chamada.PNG](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/api-at-perfil-exemplo-chamada.PNG)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/api-at-perfil-exemplo-chamada.PNG) { "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 Com essa API de desativação de perfil é possível desativar um perfil da tabela de determinaçã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: [![API Desativação - Exemplo chamada.PNG](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/api-desativacao-exemplo-chamada.PNG)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/api-desativacao-exemplo-chamada.PNG) **Retorno** { "success": true, "message": "Perfil desativado." } # API de ativação de perfil API de ativação de perfil para ativar um perfil da tabela. # 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: [![API Aativação - Exemplo chamada.PNG](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/api-aativacao-exemplo-chamada.PNG)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/api-aativacao-exemplo-chamada.PNG) **Retorno** { "success": true, "message": "Perfil ativado." }