VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/ERP Frente de caixa (PDV)

Sangria e suprimento

Lista e registra as sangrias e os suprimentos de dinheiro de uma sessão de caixa.

Listar movimentos de caixa

Sangria é retirar dinheiro da gaveta durante o turno (por exemplo, levar ao cofre); suprimento é colocar dinheiro (reforço de troco). Ambos entram no cálculo do dinheiro esperado. A lista vem do mais novo para o mais antigo.

GET/api/v1/vendor/erp/pdv/sessions/{id}/cash-movementsSeller

Lista sangrias e suprimentos de uma sessão

Parâmetros de caminho

iduuidobrigatório
Id (UUID) da sessão.

Exemplo de requisição: Listar movimentos de caixa

bash
curl "$BASE_URL/api/v1/vendor/erp/pdv/sessions/3f6c1c1e-8d0b-4a55-9a52-1d6f6a4a7b10/cash-movements" \
  -H "Authorization: Bearer $TOKEN"

Resposta: Listar movimentos de caixa

200Movimentos
json
{
  "cash_movements": [
    {
      "id": "4e5f6071-8293-4a4b-b5c6-d7e8f9012345",
      "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
      "session_id": "f403dacc-b763-4866-bf47-a5caee6319f8",
      "type": "withdrawal",
      "amount_cents": 1000,
      "reason": "Pagamento de entregador",
      "created_by": "b00d3e7c-d5b4-4942-827a-06e2c43645af",
      "created_at": "2026-10-11T14:30:00Z"
    }
  ],
  "total": 1
}

Campos da resposta

cash_movementsarray

Movimentos.

iduuid
Id do movimento.
vendor_iduuid
Seller dono.
session_iduuid
Sessão.
typestring
supplywithdrawal
supply (suprimento) entra dinheiro no caixa; withdrawal (sangria) tira.
amount_centsinteger
Valor em centavos.
reasonstring
Motivo.
created_byuuid
Quem registrou.
created_atdatetime
Quando.
totalinteger
Quantidade devolvida.

Erros: Listar movimentos de caixa

StatusQuandoCorpo
500O id da sessão não é um UUID válido.{"error":"failed to list cash movements","detail":"o valor \"abc\" não é um uuid válido. ..."}
401Cabeçalho Authorization ausente, token inválido, expirado ou revogado.{"error":"missing authorization header"}
403O token não é de um usuário seller (por exemplo, é de administrador).{"error":"insufficient permissions"}
403O usuário não está vinculado a um seller, ou o cadastro do seller ainda está em análise (vendor_pending_review).{"error":"no vendor account associated with this user"}
Sessão de outro seller devolve lista vazia

Esta rota não confere a sessão: um id inexistente ou de outro seller responde 200 com lista vazia.

Registrar movimento de caixa

POST/api/v1/vendor/erp/pdv/sessions/{id}/cash-movementsSeller

Registra sangria ou suprimento

Parâmetros de caminho

iduuidobrigatório
Id (UUID) da sessão aberta.

Corpo da requisição

typestringobrigatório
supplywithdrawal
supply ou withdrawal. Aceita maiúsculas.
amount_centsintegerobrigatório
Valor em centavos, maior que zero.
reasonstring
Motivo livre.

Exemplo de requisição: Registrar movimento de caixa

bash
curl -X POST "$BASE_URL/api/v1/vendor/erp/pdv/sessions/3f6c1c1e-8d0b-4a55-9a52-1d6f6a4a7b10/cash-movements" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "withdrawal",
  "amount_cents": 1000,
  "reason": "Pagamento de entregador"
}'

Resposta: Registrar movimento de caixa

201Movimento registrado
json
{
  "id": "4e5f6071-8293-4a4b-b5c6-d7e8f9012345",
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "session_id": "f403dacc-b763-4866-bf47-a5caee6319f8",
  "type": "withdrawal",
  "amount_cents": 1000,
  "reason": "Pagamento de entregador",
  "created_by": "b00d3e7c-d5b4-4942-827a-06e2c43645af",
  "created_at": "2026-10-11T14:30:00Z"
}

Campos da resposta

iduuid
Id do movimento.
vendor_iduuid
Seller dono.
session_iduuid
Sessão.
typestring
supplywithdrawal
supply (suprimento) entra dinheiro no caixa; withdrawal (sangria) tira.
amount_centsinteger
Valor em centavos.
reasonstring
Motivo.
created_byuuid
Quem registrou.
created_atdatetime
Quando.

Erros: Registrar movimento de caixa

StatusQuandoCorpo
400Corpo não é um JSON válido.{"error":"invalid request body","detail":"invalid character 'b' looking for beginning of object key string"}
400type inválido.{"error":"vendorerp: type must be supply|withdrawal"}
400amount_cents menor ou igual a zero.{"error":"vendorerp: amount_cents must be > 0"}
400A sessão já foi fechada.{"error":"session is not open"}
404A sessão não existe ou é de outro seller.{"error":"session not found"}
401Cabeçalho Authorization ausente, token inválido, expirado ou revogado.{"error":"missing authorization header"}
403O token não é de um usuário seller (por exemplo, é de administrador).{"error":"insufficient permissions"}
403O usuário não está vinculado a um seller, ou o cadastro do seller ainda está em análise (vendor_pending_review).{"error":"no vendor account associated with this user"}
A sessão vem do caminho

Um session_id enviado no corpo é ignorado; vale o id da URL.

Veja também

  • Sessões de caixa
Anterior
Sessões de caixa
Próxima
Vendas do PDV
Nesta página
  • Listar movimentos de caixa
  • Exemplo de requisição: Listar movimentos de caixa
  • Resposta: Listar movimentos de caixa
  • Erros: Listar movimentos de caixa
  • Registrar movimento de caixa
  • Exemplo de requisição: Registrar movimento de caixa
  • Resposta: Registrar movimento de caixa
  • Erros: Registrar movimento de caixa
  • Veja também