Pular para o conteúdo principal

Consulta um caixa por ID.

GET /api/{userId}/establishment/{establishmentId}/cashiers/{cashierId}

Parâmetros de rota

NomeTipoDescrição
userIdnumberIdentificador do usuário
establishmentIdnumberIdentificador do estabelecimento
cashierIdnumberIdentificador do caixa

Requisição

  • Método: GET
  • Path: /api/\{userId\}/establishment/\{establishmentId\}/cashiers/\{cashierId\}
  • Headers: Authorization, Accept: application/json
  • Autorização: informe o userId do token na URL e envie o token no header Authorization: Bearer <YOUR_API_TOKEN> (gerados no painel de API do Site Admin).

Resposta

  • Status: 200 OK
  • Content-Type: application/json

Exemplo de resposta

{
"response": "success",
"data": {
"cashierId": 845,
"sequence": 120,
"establishmentId": 1234,
"openingDateTime": "2026-04-19 08:00:00",
"closingDateTime": "2026-04-19 18:30:00",
"userId": 42,
"closingUserId": 42,
"accountId": 55,
"openingAccountName": "Caixa Loja 01",
"closingAccountName": "Caixa Loja 01",
"transactions": [
"12020260419080012",
"12020260419143211"
],
"openingTransactionId": "12020260419080012",
"totalAmount": 1820.50,
"paymentMethodsAmounts": [
{
"paymentMethodId": 17,
"paymentMethodName": "Dinheiro",
"amount": 450.00,
"transactionCount": 12
},
{
"paymentMethodId": 18,
"paymentMethodName": "Cartão de Crédito",
"amount": 1370.50,
"transactionCount": 24
}
],
"closingObservation": "Fechamento normal",
"closingPrintAbstract": {
"recipe": 1820.50,
"paymentTypes": [
{
"paymentMethodId": 17,
"paymentMethodName": "Dinheiro",
"amount": 450.00,
"transactionCount": 12
}
]
},
"automaticClosing": 0,
"automaticOpening": 0,
"openingAttachments": null,
"closingAttachments": null,
"status": 1,
"openingUserName": "João Silva",
"closingUserName": "João Silva",
"openingAmount": 200.00
}
}

Observações

  • Os campos transactions, paymentMethodsAmounts, closingPrintAbstract, openingAttachments e closingAttachments são armazenados no banco como strings JSON, porém o endpoint retorna já decodificados (array/objeto).
  • openingAccountName e closingAccountName vêm de jump_accounts (abertura e fechamento, podendo ser iguais).
  • openingUserName vem do usuário que abriu o caixa; closingUserName vem do usuário que fechou (pode ser null se o caixa ainda estiver aberto).
  • openingAmount é o valor da transação de abertura do caixa (transação vinculada em openingTransactionId).

Respostas de erro

Caixa não encontrado:

{
"response": "error",
"data": {
"code": "22001",
"msg": "Cashier not found"
}
}