Abre o caixa do PDV
POST/store-front/cashier/:idbankaccount/open
Abre uma nova sessão de caixa ou retoma a sessão atual quando o caixa já está aberto pelo mesmo usuário.
Pré-condições
- Controle de concorrência (10 segundos) por conta bancária — evita abertura concorrente do mesmo caixa.
- A conta precisa ser uma caixinha do PDV — se não for, retorna
Banco informado não é do tipo Caixinha. - Tipo de pedido padrão — precisa estar configurado no cadastro da conta.
- Caixa não pode estar aberto por outro usuário — se estiver, retorna
Caixa já está aberto e precisa fechar antes de abrir novamente. Se for o mesmo usuário, a chamada é idempotente: retoma a sessão existente sem criar nova. - Usuário não pode ter outro caixa aberto — se tiver, retorna
Usuário já possui outro caixa aberto. - Senha — conferida contra a senha cadastrada do usuário. Senha errada →
Senha incorreta. Usuário sem senha →Usuário não tem senha cadastrada.
Validações condicionais
Quando a parametrização Checar configuração na abertura do caixa está ativa, o sistema valida as configurações fiscais antes de abrir:
- Número, série, CSC e ID do CSC da NFC-e preenchidos no cadastro da empresa.
- Existe ao menos uma regra fiscal habilitada para emissão de NFC-e.
- Essa regra tem ao menos uma configuração de ICMS para consumidor final.
- Existe ao menos um tipo de pagamento ativo e habilitado na frente de caixa.
Falha em qualquer uma delas devolve a mensagem específica (Precisa preencher o número da última NFCe..., Não existe nenhuma regra fiscal para emissão de NFCe..., etc.).
Efeitos
- Cria a sessão de caixa (ou reutiliza a existente, em caso de retomada).
- Quando
InitialBalancedifere do saldo atual em mais de R$ 0,01, gera um lançamento de ajuste com a descrição "Ajuste abertura de caixa" (crédito se positivo, débito se negativo) — registra a divergência declarada pelo operador. - Grava
Commentsno histórico da sessão de caixa quando preenchido.
Resposta
Retorna o caixa aberto com o contexto operacional (identificador da sessão, data/hora de abertura, login, tipo de pedido, política comercial, armazém, faturador e o indicador de emissão de NFC-e) — tudo o que a tela do PDV precisa para iniciar.
Request
Responses
- 200
- 400
- 500
Caixa aberto (ou retomado). A resposta inclui o contexto operacional para inicializar o PDV. Existe um caminho residual em que o caixa é aberto mas a busca do contexto operacional não devolve linha — nesse caso o corpo é a string "sucesso".
Erros (prefixo [BadRequest]):
Caixa já está em processo de abertura(controle de concorrência)Caixa não existeBanco informado não é do tipo CaixinhaBanco informado não tem tipo de pedido padrão cadastradoCaixa já está aberto e precisa fechar antes de abrir novamenteUsuário não localizadoUsuário não tem senha cadastradaSenha incorretaUsuário já possui outro caixa abertoErro ao abrir caixa. Verificar se o mesmo já está abertoNão existe tipo de pedido padrão para frente de caixa- Validações fiscais (com
CheckConfigCashierOpen=1):Precisa preencher o número da última NFCe dentro do cadastro da empresa,Precisa preencher a série da NFCe dentro do cadastro da empresa,Precisa preencher ID CSC da NFCe dentro do cadastro da empresa,Precisa preencher código de contribuinte da NFCe dentro do cadastro da empresa,Não existe nenhuma regra fiscal para emissão de NFCe. Acessar o dpto fiscal e configurar,Não existe nenhuma configuração de ICMS na regra fiscal para consumidor final,Não existe tipo de pagamento configurado para frente de caixa
Erro interno (prefixo Error:).