# Manual de cadastro de estabelecimento e clientes Manual contendo as últimas atualizações efetuadas em 07/03/2024. # Acesso **Link documentação técnica:** [https://app.systax.com.br/partner/swagger#/](https://app.systax.com.br/partner/swagger#/) # Introdução Este documento destina-se à equipe de desenvolvimento responsável por integrar aplicações internas ao Systax. Com o objetivo de facilitar esse processo de integração, a Systax possui um módulo de integração construído em formato JSON o que garante a interoperabilidade com sistemas desenvolvidos em linguagens e plataformas diversas. # Autenticação A autenticação da API de Parceiros é feita via bearer token. Para mais detahes de como obtê-la, acesse a última versão de documentação no link: [https://documentacao.systax.com.br/books/manual-da-api-de-geracao-de-token](https://documentacao.systax.com.br/books/manual-da-api-de-geracao-de-token) # Consulta de Usuários O objetivo dessa API é realizar a consulta de todos os usuários cadastrados na empresa filha desejada. # Acesso **URL:** https://app.systax.com.br/partner/users/{child\_client\_id} **Método:** GET **Importante:** No lugar do {child\_client\_id} será informado o ID da empresa filha na qual os usuários cadastrados serão consultados # Descrição dos campos da chamada e retorno **Chamada** Essa API não possui corpo de chamada, portanto a única informação necessária é o token gerado e o ID da empresa filha na qual a consulta será feita, que é informado na própria URL, conforme exemplo abaixo: [![Consulta Usuários.PNG](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/consulta-usuarios.PNG)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/consulta-usuarios.PNG) **Retorno**
**Tag** **Descrição**
id Informa o id que foi gerado no momento da criação do usuário. É o código único de identificação dele
username É o usuário que foi cadastrado e que é utilizado como credencial de acesso no uso das API's
nome Nome do usuário cadastrado
email Email do usuário cadastrado
tipo Indica o nível de acesso para o usuário que está sendo criado. Variáveis possíveis: "10" para Admin Empresa Usuária "20" para Operador Empresa Usuária
**Códigos de retorno**
**Código de retorno** **Sucess** **Message** **Descrição**
200 true ok Consulta efetuada com sucesso
400 false missing\_token Token não informado
400 false token\_invalid Token informado está incorreto ou expirou
400 false empresa xxx não é filha do parceiro ou não existe O ID Cliente informado na URL não existe ou não é filho do parceiro
# Exemplo de retorno { "success": true, "message": "ok", "record\_count": 5, "data": \[ { "id": 1, "username": "empresa.teste1", "nome": " Empresa Teste 1", "email": "empresa.teste1@systax.com.br", "tipo": 20 }, { "id": 2, "username": "empresa.teste2", "nome": "Empresa Teste 2", "email": "empresa.teste2@systax.com.br", "tipo": 20 }, { "id": 3, "username": "empresa.teste3", "nome": "Empresa Teste 3", "email": "empresa.teste3@systax.com.br", "tipo": 10 }, { "id": 4, "username": "empresa.teste4", "nome": "Empresa Teste 4", "email": "empresa.teste4@systax.com.br", "tipo": 10 }, { "id": 5, "username": "empresa.teste5", "nome": "Empresa Teste 5", "email": "empresa.teste5@systax.com.br", "tipo": 10 } \] } # Criação de usuários Essa API tem o objetivo de cadastrar um usuário para uma empresa filha. # Acesso **URL:** [https://app.systax.com.br/partner/users/{child\_client\_id}](https://app.systax.com.br/partner/users/%7bchild_client_id%7d) **Método:** POST **Importante:** No lugar do {child\_client\_id} será informado o ID da empresa filha na qual o usuário será cadastrado # Descrição dos campos da chamada e retorno **Chamada**
**Tag** **Descrição** **Obrigatório**
tipo Indica o nível de acesso para o usuário que está sendo criado Variáveis possíveis: "10" para Admin Empresa Usuária "20" para Operador Empresa Usuária Sim
username Usuário que vai ser cadastrado dentro da empresa filha Sim
senha Senha do usuário que está sendo cadastrado Obs: A senha deve ser criptografada no formato md5 com 32 caracteres Sim
nome Nome do usuário que vai ser cadastrado na empresa filha Sim
email Email do usuário que vai ser cadastrado na empresa filha sim
**Códigos de retorno**
**Código de retorno** **Sucess** **Message** **Descrição**
200 True ok Cadastro feito com sucesso
400 False The ( ) field is required Campo obrigatório não preenchido
400 False token\_invalid Token incorreto
400 False token\_expired Token expirado
# Exemplos de chamada e retorno **Chamada** { "tipo": 10, "username": "joao\_teste", "senha": "8e7894fe02dffc89c3ac8c55143e0481", "nome": "Joao Teste", "email": "joao@teste.com.br" } [![Criação usuário - Exemplo chamada.PNG](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/criacao-usuario-exemplo-chamada.PNG)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/criacao-usuario-exemplo-chamada.PNG) **Retorno** { "success": true, "message": "string", "id": 1 } # Alteração de usuários Essa API tem o objetivo de alterar os dados de usuários que estejam cadastrados numa empresa filha. # Acesso **URL:** https://app.systax.com.br/partner/users/{child\_client\_id}/{id\_user} **Método:** PUT # Descrição dos campos da chamada **Chamada**
**Tag** **Descrição** **Obrigatório**
Senha Altera a senha do usuário informado. Nessa tag j;a é informada a nova senha do usuário. Obs.L A senha deve ser criptografada no formato MD5, com 32 caracteres Não
Nome Altera o nome do usuário cadastrado. Nessa tag já é informado o novo nome do usuário Não
E-mail Altera o nome do usuário cadastrado. Nessa tag já é informado o novo nome do usuário Não
Para o funcionamento da API, além do corpo da chamada é necessário informar na URL o ID da empresa filha cadastrada, além do ID do usuário cadastrado, que é fornecido no momento do cadastro. Abaixo print com exemplo do preenchimento da URL: [![Alteração usuário - Chamada.PNG](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/alteracao-usuario-chamada.PNG)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/alteracao-usuario-chamada.PNG) **Códigos de retorno**
**Código de retorno** **Sucess** **Message** **Descrição**
200 True ok item(s) alterado(s) com sucesso
400 False missing\_token Token não informado
400 False token\_invalid Token informado está incorreto ou expirou
400 False missing\_data Parâmetro informado para alteração
# Exemplos de chamada e retorno **Chamada** { "senha": "", "nome": "Empresa Teste 2", "email": "" } [![Alteração usuário - Exemplo Chamada.PNG](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/alteracao-usuario-exemplo-chamada.PNG)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/alteracao-usuario-exemplo-chamada.PNG) **Retorno** { "success": true, "message": "ok" } [![Alteração usuário - Exemplo Retorno.PNG](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/alteracao-usuario-exemplo-retorno.PNG)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/alteracao-usuario-exemplo-retorno.PNG) # Exclusão de usuários Essa API tem o objetivo de excluir usuários que estejam cadastrados numa empresa filha. # Acesso **URL:** https://app.systax.com.br/partner/users/{child\_client\_id}/{id\_user} **Método:** DEL # Descrição dos campos da chamada **Chamada** Essa API não possui corpo de chamada, portanto a única informação necessária é o token gerado, o ID da empresa filha e o ID do usuário que será excluído, que é informado na própria URL, conforme exemplo abaixo: [![Exclusão usuário - Chamada.PNG](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/exclusao-usuario-chamada.PNG)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/exclusao-usuario-chamada.PNG) **Códigos de retorno**
**Código de retorno** **Sucess** **Message** **Descrição**
200 true ok Usuário cadastrado com sucesso
400 false O usuário não pertence a essa empresa ou não existe Usuário não está cadastrado na empresa filha indicada ou não existe
400 false missing\_token Token não informado
400 false token\_invalid Token informado está incorreto ou expirou
400 false empresa xxx não é filha do parceiro ou não existe O ID Cliente informado na URL não existe ou não é filho do parceiro
# Exemplos de retorno **Retorno** { "success": true, "message": "ok" } # Consulta de empresas filhas Esta API tem como objetivo a apresentação, em forma de lista, dos dados das empresas filhas. # Acessos **URL**: https://app.systax.com.br/partner/clients **Método:** GET # Exemplos de chamada e retorno **Chamada** [![Consulta Emp Filhas - Chamada.PNG](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/consulta-emp-filhas-chamada.PNG)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/consulta-emp-filhas-chamada.PNG) **Retorno**
**Campo** **Descrição**
id Corresponde ao ID da empresa ao qual o cliente foi cadastrado
entidade Nome da entidade (cliente) que será cadastrada
nome Nome da pessoa que será o contato no cliente cadastrado
email Email da pessoa que será o contato no cliente cadastrado
id\_emp\_responsavel Corresponde ao ID da empresa responsável
tipo Indica o nível de acesso para o usuário que está sendo criado. Variáveis possíveis: "10" para Admin Empresa Usuária "20" para Operador Empresa Usuária
ddd DDD da pessoa que será o contato no cliente cadastrado
telefone Telefone da pessoa que será o contato no cliente cadastrado
ramal Ramal da pessoa que será o contato no cliente cadastrado
dt\_registro Data na qual foi registrada a entidade
quantidade\_regras Informa a quantidade de regras contratadas
# Criação de empresas filhas Essa API tem o objetivo de cadastrar empresas filhas que serão vinculadas a empresa principal, que já possui um cadastro na Systax. # Acessos **URL:** [https://app.systax.com.br/partner/clients](https://app.systax.com.br/partner/clients) **Método:** POST # Descrição dos campos da chamada
**Tag** **Descrição** **Obrigatório**
entidade Nome da entidade (cliente) que será cadastrada Sim
nome Nome da pessoa que será o contato no cliente cadastrado Sim
email Email da pessoa que será o contato no cliente cadastrado Sim
ddd DDD da pessoa que será o contato no cliente cadastrado Sim
telefone Telefone da pessoa que será o contato no cliente cadastrado Sim
quantidade\_regras Informa a quantidade de regras contratadas Não
ramal Ramal da pessoa que será o contato no cliente cadastrado Não
id Corresponde ao ID da empresa parceira da Systax ao qual o cliente cadastrado será vinculado Sim
tipo Indica o nível de acesso para o usuário que está sendo criado. Variáveis possíveis: "10" para Admin Empresa Usuária "20" para Operador Empresa Usuária
username Usuário do cliente que está sendo cadastrado Sim
senha Senha do cliente que está sendo cadastrado Obs: A senha deve ser criptografada no formato MD5 com 32 caracteres Sim
nome Nome da pessoa responsável pelo cadastro feito Sim
email Email da pessoa responsável pelo cadastro feito Sim
flag\_aprovacao\_auto\_regras Indica se o cockpit do cliente possui aprovação automática de regras. "1" Sim "0" Não Sim
**Códigos de retorno**
**Código de retorno** **Sucess** **Message** **Descrição**
200 True ok Cadastro feito com sucesso
400 False The ( ) field is required Campo obrigatório não preenchido
400 False token\_invalid Token incorreto
400 False token\_expired Token expirado
# Exemplos de chamada e retorno **Chamada** { "entidade": "Empresa Teste", "nome": "João", "email": "joao@empresateste.com.br", "ddd": "11", "telefone": "44444444", "ramal": "44", "quantidade\_regras": 1000, "user": { "id": 1, "tipo": 20, "username": "empresa\_teste", "senha": "428f2ccb30410a2bf744ada36df6b50a", "nome": "Pedro", "email": "pedro@empresaprincipal.com.br" } } [![Criação Emp Filha - Exemplo chamada.PNG](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/criacao-emp-filha-exemplo-chamada.PNG)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/criacao-emp-filha-exemplo-chamada.PNG) **Retorno** { "success": true, "message": "string", "id\_cliente": 1, "id\_user": 1 } # Alteração de empresas filhas Essa API tem o objetivo de alterar informações cadastrais de uma empresa filha. # Acessos **URL**: app.systax.com.br?/partner?/clients?/{child\_client\_id} **Método**: PUT # Descrição dos campos da chamada
**Campo** **Descrição**
entidade Nome da entidade (cliente) que será cadastrada
nome Nome da pessoa que será o contato no cliente cadastrado
email Email da pessoa que será o contato no cliente cadastrado
ddd DDD da pessoa que será o contato no cliente cadastrado
telefone Telefone da pessoa que será o contato no cliente cadastrado
ramal Ramal da pessoa que será o contato no cliente cadastrado
**Códigos de retorno**
**Código de retorno** **Sucess** **Message** **Descrição**
200 True ok Cadastro feito com sucesso
400 False The ( ) field is required Campo obrigatório não preenchido
400 False token\_invalid Token incorreto
400 False token\_expired Token expirado
# Exemplos de chamada e retorno **Chamada** { "entidade": "string", "nome": "string", "email": "string", "ddd": "string", "telefone": "string", "ramal": "string" } **Retorno** { "success": true, "message": "string" } # Exclusão de empresas filhas Essa API tem o objetivo de excluir uma empresa filha. # Acessos **URL:** app.systax.com.br/partner/clients/{child\_client\_id} **Método:** DEL # Descrição dos campos da chamada Essa API não possui corpo de chamada, portanto a única informação necessária é o token gerado e o ID da empresa filha que será excluída, que é informado na própria URL, conforme exemplo abaixo: [![Exclusão emp filha - Chamada.PNG](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/AXrexclusao-emp-filha-chamada.PNG)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/AXrexclusao-emp-filha-chamada.PNG) **Códigos de retorno**
**Código de retorno** **Sucess** **Message** **Descrição**
200 True ok Cadastro feito com sucesso
400 False missing tokenToken não informado
400 False token\_invalidToken informado está incorreto ou expirou
400 False empresa xxx não é filha do parceiro ou não existeO ID Cliente informado na URL não existe ou não é filho do parceiro
# Exemplo de retorno **Retorno** { "success": true, "message": "ok" } # Consulta de informações de licença O objetivo dessa API é consultar as informações das licenças de serviços da empresa filha # Acesso **URL:** app.systax.com.br/partner/licenses/clients/{id\_servico}/{child\_client\_id} **Método:** GET # Descrição dos campos da chamada e retorno Essa API não possui corpo de chamada, portanto a única informação necessária é o token gerado, o ID da empresa filha na qual a consulta será feita e o ID do serviço, que é informado na própria URL, conforme exemplo abaixo: [![Consulta Licença - Chamada.PNG](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/scaled-1680-/consulta-licenca-chamada.PNG)](https://documentacao.systax.com.br/uploads/images/gallery/2025-07/consulta-licenca-chamada.PNG) **Códigos de Serviços disponíveis**
**ID** **Descrição**
3 Alertas - CFM
4 Alertas - TEC
5 Alertas - TIPI
6 Webservice Systax - NF-e
7 Webservice Systax - EFD
14 Alertas - ERP
24 Systax - DFE
25 Cadastro Fiscal (Portal)
26 Validação de nota com engine G4
27 Systax Gestão
28 E-commerce
29 Validação de nota com G5
31 Systax SPED
32 Nfe - Validação Basica
33 Diagnóstico Fiscal
37 Captura XML
38 Motor de Cálculo
39 Systax - DFE - Avançado
40 Tax Reports
43 Regra on line - individual
44 Regra on line - Lote
45 API tributos aproximados
48 API Fórmulas
**Retorno** { "success": true, "message": "string", "data": \[ { "id": 0, "id\_servico": 0, "id\_cliente": 0, "dt\_expiracao": "string", "tipo\_servico": "standard", "controle\_creditos": 0 } \] } # Alteração de licenças Esta API tem como objetivo efetuar chamadas para alteração de informações de licença de serviço. # Acesso **URL:** app.systax.com.br/partner/licenses/clients/{id\_servico}/{child\_client\_id} **Método:** PUT # Exemplos de chamada e retorno **Chamada** { "dt\_expiracao": "23/11/2019", "tipo\_servico": "standard" } **Retorno** { "success": true, "message": "string", "licenca": { "id": 0, "id\_servico": 0, "id\_cliente": 0, "dt\_expiracao": "string", "tipo\_servico": "standard", "controle\_creditos": 0 } } # Exclusão de licenças Essa API é utilizada quando é necessário realizar a exclusão de alguma licença de empresa filha. # Acesso **URL:** app.systax.com.br/partner/licenses/clients/{id\_servico}/{child\_client\_id} **Método:** DEL # Exemplo de resposta { "success": true, "message": "string" } # Cadastro de licenças API utilizada para cadastro de alguma licença para uma empresa filha. # Acesso **URL:** app.systax.com.br/partner/licenses/clients/{child\_client\_id} # Exemplo de chamada e resposta **Chamada** { "id\_servico": 0, "dt\_expiracao": "23/11/2019", "tipo\_servico": "standard" } **Retorno** { "success": true, "message": "string", "licenca": { "id": 0, "id\_servico": 0, "id\_cliente": 0, "dt\_expiracao": "string", "tipo\_servico": "standard", "controle\_creditos": 0 } } # Consulta de estabelecimentos Utiliza-se esta API para realizar a consulta de um estabelecimento na Systax; Os filtros de busca são aplicados na URL dessa chamada. Exemplos: filter\[0\]=cnpj|35587148000243&filter\[1\]=nome|filial # Acesso **URL:** app.systax.com.br/partner/company-establishments/{child\_client\_id} **Método:** GET # Exemplo de retorno **Retorno** { "success": true, "message": "string", "record\_count": 0, "data": \[ { "id": 0, "id\_cli": 0, "cnpj": "string", "ie": "string", "nome": "string", "email": "string", "id\_mun\_origem": 0, "telefone": "string", "endereco": "string", "im": "string", "uf": "string", "cnae\_principal": "string", "cnae\_secundario": "string" } \] } # Cadastro de estabelecimentos API utilizada para cadastro de um estabelecimentos. # Acesso **URL**: app.systax.com.br/partner/company-establishments/{child\_client\_id} **Método:** POST # Exemplos de chamada e retorno **Chamada** { "id": 0, "id\_cli": 0, "cnpj": "string", "ie": "string", "nome": "string", "email": "string", "id\_mun\_origem": 0, "telefone": "string", "endereco": "string", "im": "string", "uf": "string", "cnae\_principal": "string", "cnae\_secundario": "string" } **Retorno** { "success": true, "message": "string", "id": 0 } # Alteração de estabelecimentos API utilizada quando for necessário realizar alguma alteração de informação do estabelecimento. Lembrando que, para filtrar o estabelecimento que deseja realizar alterações, é necessário indicar o id da empresa filha e o id do estabelecimento na URL da chamada. # Acesso **URL**: app.systax.com.br?/partner?/company-establishments?/{child\_client\_id}?/{id\_estabelecimento} **Método:** PUT # Exemplos de chamada e retorno **Chamada** { "id": 0, "id\_cli": 0, "cnpj": "string", "ie": "string", "nome": "string", "email": "string", "id\_mun\_origem": 0, "telefone": "string", "endereco": "string", "im": "string", "uf": "string", "cnae\_principal": "string", "cnae\_secundario": "string" } **Retorno** { "success": true, "message": "string" } # Exclusão de estabelecimentos API utilizada quando for necessário excluir algum estabelecimento cadastrado anteriormente. # Acesso **URL:** app.systax.com.br/partner/company-establishments/{child\_client\_id}/{id\_estabelecimento} **Método:** DEL # Exemplos de retorno **Retorno** { "success": true, "message": "string" }