Criar Usuário

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Ao criar um novo usuário na API, é essencial definir corretamente o tipo de usuário. Atualmente, existem dois tipos principais:

TIPO DE USUARIOINFORMAÇÃO
USUARIOUsuários do tipo USUARIO possuem acesso ao portal e podem ser utilizados para tarefas operacionais e de gestão, como: Portais dos lojistas, Ambientes administrativos,Outras interfaces visuais da plataforma.
APLICACAOUsuários do tipo APLICACAO não têm acesso ao portal do lojista, sendo restritos a chamadas de API e autenticação de dispositivos (Maquinas de Cartão).

Cada usuário criado pode possuir um conjunto de permissões, que determinam quais funcionalidades estarão disponíveis para ele — seja no Portal do Lojista ou nas Maquininhas (POS).

As permissões devem ser atribuídas de acordo com o tipo de usuário e o contexto de uso:

PERMISSÃOATRIBUIÇÃO
ADM_USUARIOQuando a opção é definida como ativa, ela recebe a capacidade de criar outros usuários e gerenciar suas permissões.
ADM_COBRANCAPermite criar cobranças, gerenciar todos os aspectos relacionados a uma cobrança
CANCELAR_COBRANCAPermissão necessária para cancelar uma cobrança. Se desativada, o usuário não poderá cancelar cobranças.
ADM_EMPRESAPermite criar empresas, editar dados de empresas ainda não aprovadas, e realizar ajustes quando necessário.
ADM_CLIENTEPermite gerenciar o cadastro de clientes, incluindo a edição de dados pessoais e comerciais.
ADM_SERVICOPermite criar e editar serviços, bem como modificar os dados associados a cada serviço.
REFORCO_CAIXAPermissão voltada para maquininhas. Habilita o usuário a registrar reforços de caixa (entrada de valores).
FECHAMENTO_CAIXAPermite ao usuário realizar o fechamento do caixa da loja. Também aplicável para uso em maquininhas.
EXTRATO_CONTAPermite consultar o saldo e o extrato bancário das empresas com as quais o usuário possui vínculo.
EMISSAO_NFSPermite emitir Nota Fiscal de Serviço (NFS-e) durante a criação de uma cobrança. Se desativada, a nota não poderá ser emitida nesse momento.
CANCELAR_TRANSACAOPermite ao usuário cancelar (estornar) transações das empresas com as quais está vinculado.
ADM_PLANOPermite criar, editar e gerenciar os planos comerciais das empresas, incluindo alterações de dados.
ALTERAR_VALOR_ITEMAutoriza a alteração do valor de um item no momento da criação da cobrança (ex: mudar um item de R$10,00 para R$20,00).
RECEBER_BOLETOPermite selecionar boleto bancário como forma de pagamento.
RECEBER_CREDITOPermite selecionar cartão de crédito como forma de pagamento.
RECEBER_DEBITOPermite selecionar cartão de débito como forma de pagamento.
RECEBER_DINHEIROPermite selecionar pagamento em dinheiro.
RECEBER_PIXPermite selecionar PIX como forma de pagamento.
CANCELAR_NFSPermite cancelar uma NFS-e já emitida, caso seja necessário e a permissão esteja ativa.
ADM_SPLITPermite gerenciar os splits de pagamento no momento da criação de uma cobrança.
ABERTURA_CAIXAPermite ao usuário realizar a abertura de caixa no início de uma operação.
SANGRIA_CAIXAAutoriza o usuário a fazer uma sangria, ou seja, retirada de valores do caixa.
FLASH_CAIXAPermite gerar um relatório instantâneo (flash) com as movimentações do caixa até o momento atual.
MAX_DESCONTODefine o desconto máximo que o usuário pode aplicar em uma venda realizada na maquininha.

🚧

Atenção :

Lembrando que é obrigatório informar pelo menos uma empresa que esteja vinculada ao usuário.

{
   "tipo":"USUARIO",
   "codigo":79,
   "status":"ATIVO",
   "id":"a010fb31-5c8c-4bcb-bb24-2ef9433ede7d",
   "nome":"Nome do Usuario",
   "email":"[email protected]",
   "cpf":"759.661.830-82",
   "telefone":"11 45454-5454",
   "permissoes":{
      "controle_estoque_visualizar":"boolean",
      "remessas_visualizar":"boolean",
      "cad_empresas_visualizar":"boolean",
      "rel_vendas_analitico_visualizar":"boolean",
      "sangria_caixa":"boolean",
      "vendas_pdv_cancelar":"boolean",
      "adm_cobranca":"boolean",
      "notas_fiscais_visualizar":"boolean",
      "cad_setores_criar":"boolean",
      "cad_servicos_visualizar":"boolean",
      "receber_credito":"boolean",
      "rel_extrato_conta_visualizar":"boolean",
      "cad_produtos_visualizar":"boolean",
      "fechamento_caixa":"boolean",
      "adm_cliente":"boolean",
      "receber_dinheiro":"boolean",
      "rel_vendas_pdv_visualizar":"boolean",
      "controle_estoque_movimentar":"boolean",
      "vendas_pdv_criar":"boolean",
      "cad_servicos_editar":"boolean",
      "cad_planos_visualizar":"boolean",
      "cad_produtos_editar":"boolean",
      "cad_pdv_visualizar":"boolean",
      "antecipacao_visualizar":"boolean",
      "transacoes_visualizar":"boolean",
      "notas_fiscais_emitir":"boolean",
      "cad_estandes_visualizar":"boolean",
      "antecipacao_efetuar_pedido":"boolean",
      "transacoes_cancelar":"boolean",
      "cad_categorias_criar":"boolean",
      "cad_categorias_editar":"boolean",
      "cad_tabelapreco_visualizar":"boolean",
      "remessas_enviar":"boolean",
      "cancelar_transacao":"boolean",
      "cad_pdv_editar":"boolean",
      "cad_setores_editar":"boolean",
      "extrato_conta":"boolean",
      "cad_planos_criar":"boolean",
      "adm_servico":"boolean",
      "cancelar_cobranca":"boolean",
      "assinaturas_renovar":"boolean",
      "cad_produtos_criar":"boolean",
      "contratos_criar":"boolean",
      "assinaturas_cancelar":"boolean",
      "receber_pix":"boolean",
      "controle_estoque_inventario":"boolean",
      "cad_planos_editar":"boolean",
      "receber_boleto":"boolean",
      "cad_tabelapreco_editar":"boolean",
      "rel_monitoramento_visualizar":"boolean",
      "rel_pagamento_analitico_visualizar":"boolean",
      "cad_eventos_criar":"boolean",
      "assinaturas_criar":"boolean",
      "adm_usuario":"boolean",
      "rel_vendas_evento_visualizar":"boolean",
      "cad_pdv_criar":"boolean",
      "flash_caixa":"boolean",
      "reforco_caixa":"boolean",
      "notas_fiscais_definir_emissao":"boolean",
      "receber_cashless":false,
      "cad_clientes_editar":"boolean",
      "cad_estandes_editar":"boolean",
      "abertura_caixa":"boolean",
      "cobrancas_criar":"boolean",
      "assinaturas_alterar_pagamento":"boolean",
      "cad_categorias_visualizar":"boolean",
      "transacoes_reprocessar":"boolean",
      "alterar_valor_item":"boolean",
      "vendas_pdv_visualizar":"boolean",
      "cad_eventos_editar":"boolean",
      "cad_tabelapreco_criar":"boolean",
      "cad_usuarios_criar":"boolean",
      "adm_empresa":"boolean",
      "rel_vendas_rede_visualizar":"boolean",
      "assinaturas_visualizar":"boolean",
      "cad_usuarios_editar":"boolean",
      "cobrancas_visualizar":"boolean",
      "emissao_nfs":"boolean",
      "rel_extrato_recebiveis_visualizar":"boolean",
      "assinaturas_alterar_plano":"boolean",
      "cad_clientes_visualizar":"boolean",
      "cad_empresas_editar":"boolean",
      "cad_servicos_criar":"boolean",
      "adm_split":"boolean",
      "contratos_cancelar":"boolean",
      "receber_debito":"boolean",
      "cad_eventos_visualizar":"boolean",
      "cancelar_venda":"boolean",
      "cobrancas_cancelar":"boolean",
      "controle_estoque_transferir":"boolean",
      "cad_estandes_criar":"boolean",
      "cad_empresas_criar":"boolean",
      "contratos_visualizar":"boolean",
      "rel_movimentacoes_estoque_visualizar":"boolean",
      "cad_clientes_criar":"boolean",
      "adm_plano":"boolean",
      "cad_usuarios_visualizar":"boolean",
      "cancelar_nfs":"boolean",
      "cad_setores_visualizar":"boolean",
      "notas_fiscais_cancelar":"boolean",
      "relatorios_visualizar":"boolean"
   },
   "max_desconto":100,
   "empresas":[
      {
         "id":"b51ae983-184f-4d31-9f28-92db414557f9"
      }
   ]
}
Body Params
string
required
Defaults to Jose da Silva

Nome do Usuário

string
required
Defaults to Usuario

Tipo do USUARIO

string
required
Defaults to ATIVO

Caso esteja inativo entrar em contato.

string
required
Defaults to [email protected]
int32
required
Defaults to 11923231212

numero de celular

int32
required
Defaults to 11923231212

cpf do usuario

string
required
empresas
object
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json