Referência

Caixa

As sessões de caixa (turnos de operador) e os terminais, só para consulta. Abrir, fechar e movimentar o caixa fazem-se no balcão, pelo próprio operador: um documento emitido por chave de API não precisa de caixa aberto.

Operação	O que faz
GET `/api/caixa/meu`	A sessão de caixa aberta de quem a chave representa (o titular), ou nenhuma.
GET `/api/caixa/historico`	As sessões de caixa já fechadas, das mais recentes para as mais antigas.
GET `/api/caixa/abertos`	Os caixas abertos neste momento na empresa, com o operador e o saldo de cada um.
GET `/api/caixa/documentos`	Os documentos emitidos na sessão de caixa aberta, para conferir o turno.
GET `/api/caixa/terminais`	Os terminais de caixa (os postos físicos de venda) da empresa.
GET `/api/caixa/terminais/{id}`	A ficha de um terminal de caixa.

GET/api/caixa/meu#

A sessão de caixa aberta de quem a chave representa (o titular), ou nenhuma.

Permissão Caixa.MeuCaixaLer

Uma chave de API não precisa de caixa aberto para emitir documentos; isto serve para consultar o caixa do titular.

Pedido

curl

curl 'https://<endereço-da-API>/api/caixa/meu' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/caixa/historico#

As sessões de caixa já fechadas, das mais recentes para as mais antigas.

Permissão Caixa.HistoricoLer

A resposta é uma página: itens e proximoCursor. Ver Paginação.

Parâmetros

Nome	Onde	Tipo	Obrigatório
`cursor`	na pesquisa	texto
`tamanho`	na pesquisa	número inteiro

Pedido

curl

curl 'https://<endereço-da-API>/api/caixa/historico' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/caixa/abertos#

Os caixas abertos neste momento na empresa, com o operador e o saldo de cada um.

Permissão Caixa.MeuCaixaLer

Pedido

curl

curl 'https://<endereço-da-API>/api/caixa/abertos' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/caixa/documentos#

Os documentos emitidos na sessão de caixa aberta, para conferir o turno.

Permissão Caixa.MeuCaixaLer

Pedido

curl

curl 'https://<endereço-da-API>/api/caixa/documentos' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/caixa/terminais#

Os terminais de caixa (os postos físicos de venda) da empresa.

Permissão Caixa.AbrirFechar

lojaId filtra por estabelecimento.

A resposta é uma página: itens e proximoCursor. Ver Paginação.

Parâmetros

Nome	Onde	Tipo
`lojaId`	na pesquisa	identificador (UUID)
`cursor`	na pesquisa	texto
`tamanho`	na pesquisa	número inteiro

Pedido

curl

curl 'https://<endereço-da-API>/api/caixa/terminais' \
  -H 'X-Api-Key: <a-sua-chave>'

GET/api/caixa/terminais/{id}#

A ficha de um terminal de caixa.

Permissão Caixa.AbrirFechar

Parâmetros

Nome	Onde	Tipo	Obrigatório
`id`	no caminho	identificador (UUID)	sim

Pedido

curl

curl 'https://<endereço-da-API>/api/caixa/terminais/<id>' \
  -H 'X-Api-Key: <a-sua-chave>'