API Reference

Criar Usuário

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",
    "status": "ATIVO",
    "nome": "TESTE",
    "email": "[email protected]",
    "cpf": "000.000.000-00",
    "telefone": "11 99999-9999",
    "permissoes": {
        "relatorios_visualizar": true,
        "alterar_valor_item": true,
        "adm_split": true,
        "fechamento_caixa": true,
        "abertura_caixa": true,
        "sangria_caixa": true,
        "reforco_caixa": true,
        "flash_caixa": true,
        "receber_boleto": true,
        "receber_credito": true,
        "receber_debito": true,
        "receber_pix": true,
        "receber_dinheiro": true,
        "vendas_pdv_visualizar": true,
        "vendas_pdv_criar": true,
        "vendas_pdv_cancelar": true,
        "cobrancas_visualizar": true,
        "cobrancas_criar": true,
        "cobrancas_cancelar": true,
        "assinaturas_visualizar": true,
        "assinaturas_criar": true,
        "assinaturas_cancelar": true,
        "assinaturas_alterar_pagamento": true,
        "assinaturas_alterar_plano": true,
        "assinaturas_renovar": true,
        "transacoes_visualizar": true,
        "transacoes_cancelar": true,
        "transacoes_reprocessar": true,
        "contratos_visualizar": true,
        "contratos_criar": true,
        "contratos_cancelar": true,
        "notas_fiscais_visualizar": true,
        "notas_fiscais_emitir": true,
        "notas_fiscais_cancelar": true,
        "notas_fiscais_definir_emissao": true,
        "controle_estoque_visualizar": true,
        "controle_estoque_movimentar": true,
        "controle_estoque_transferir": true,
        "controle_estoque_inventario": true,
        "antecipacao_visualizar": true,
        "antecipacao_efetuar_pedido": true,
        "remessas_visualizar": true,
        "remessas_enviar": true,
        "rel_extrato_conta_visualizar": true,
        "rel_monitoramento_visualizar": true,
        "rel_extrato_recebiveis_visualizar": true,
        "rel_vendas_evento_visualizar": true,
        "rel_pagamento_analitico_visualizar": true,
        "rel_vendas_analitico_visualizar": true,
        "rel_vendas_pdv_visualizar": true,
        "rel_vendas_rede_visualizar": true,
        "rel_movimentacoes_estoque_visualizar": true,
        "cad_empresas_visualizar": true,
        "cad_empresas_criar": true,
        "cad_empresas_editar": true,
        "cad_clientes_visualizar": true,
        "cad_clientes_criar": true,
        "cad_clientes_editar": true,
        "cad_servicos_visualizar": true,
        "cad_servicos_criar": true,
        "cad_servicos_editar": true,
        "cad_produtos_visualizar": true,
        "cad_produtos_criar": true,
        "cad_produtos_editar": true,
        "cad_categorias_visualizar": true,
        "cad_categorias_criar": true,
        "cad_categorias_editar": true,
        "cad_setores_visualizar": true,
        "cad_setores_criar": true,
        "cad_setores_editar": true,
        "cad_planos_visualizar": true,
        "cad_planos_criar": true,
        "cad_planos_editar": true,
        "cad_eventos_criar": true,
        "cad_eventos_editar": true,
        "cad_eventos_visualizar": true,
        "cad_estandes_visualizar": true,
        "cad_estandes_criar": true,
        "cad_estandes_editar": true,
        "cad_tabelapreco_visualizar": true,
        "cad_tabelapreco_criar": true,
        "cad_tabelapreco_editar": true,
        "cad_pdv_visualizar": true,
        "cad_pdv_criar": true,
        "cad_pdv_editar": true,
        "cad_usuarios_visualizar": true,
        "cad_usuarios_editar": true,
        "cad_usuarios_criar": true
    },
    "max_desconto": 100,
    "empresas": [
        {
            "id": "6847ec9a-208f-44f5-a139-784c22307083"
        },
        {
            "id": "927ec015-2ddc-4608-b710-eb9a82420e6c"
        },
        {
            "id": "2912d5f9-8dd2-45fb-a7e1-c9e5930f76d4"
        },
        {
            "id": "69d11b63-c1b5-441a-9012-d33aa4d95e16"
        },
        {
            "id": "1923e887-23e5-45cb-9dbd-602d55ceb5dd"
        },
        {
            "id": "7d538b2a-e414-4740-986d-7a1af41150f9"
        },
        {
            "id": "9686e9ec-3585-4747-a455-59bf287b5798"
        },
        {
            "id": "e5aee713-a3c4-4696-8239-29e8d4581485"
        },
        {
            "id": "cde2dbe0-9043-4382-b74d-de73ee50a812"
        },
        {
            "id": "2d6ec638-b31c-4d1f-bb95-36869cf81aa5"
        }
    ]
}
Language
Credentials
Basic
base64
:
Click Try It! to start a request and see the response here!