Vendas

Vendas são o coração do sistema PDV — elas representam todas as transações comerciais realizadas no ponto de venda. Nesta página, vamos explorar os diferentes endpoints de vendas que você pode usar para gerenciar transações programaticamente. Veremos como consultar, criar e gerenciar vendas.

O modelo de venda

O modelo de venda contém todas as informações sobre as transações realizadas no PDV, incluindo dados do cliente, produtos, formas de pagamento e usuário responsável.

Propriedades

Name
id
Type
string
Description
Identificador único da venda.
Name
dataCadastro
Type
timestamp
Description
Data e hora do cadastro da venda.
Name
codigo
Type
integer
Description
Código sequencial da venda.
Name
cliente
Type
object
Description
Objeto contendo informações do cliente. Propriedades: type (tipo do cliente), id (identificador da comanda/mesa), takeAway (retirar na loja), phone (telefone), obs (observações).
Name
delivery
Type
boolean
Description
Indica se a venda é para delivery.
Name
cancelada
Type
boolean
Description
Indica se a venda foi cancelada.
Name
usuario
Type
object
Description
Objeto contendo dados do usuário responsável pela venda. Propriedades: id (identificador único), nome (nome do usuário), admin (se é administrador), excluido (se foi excluído).
Name
produtos
Type
array
Description
Array de produtos da venda. Cada produto contém: id (identificador único), titulo (nome do produto), valorUnitario (preço unitário), quantidade (quantidade), cancelado (se foi cancelado).
Name
formasPagamento
Type
array
Description
Array de formas de pagamento. Cada forma contém: tipo (tipo do pagamento - veja tabela abaixo), valorUnitario (valor pago), valorTroco (valor do troco).

Tipos de Pagamento

O campo tipo em formasPagamento pode ter os seguintes valores:

Name
1
Type
Dinheiro
Description
Pagamento em dinheiro.
Name
2
Type
Débito
Description
Pagamento com cartão de débito.
Name
3
Type
Crédito
Description
Pagamento com cartão de crédito.
Name
4
Type
Pix
Description
Pagamento via Pix.
Name
99
Type
Prazo
Description
Pagamento a prazo.

GET/vendas

Lista de Vendas

Retorna todas as vendas com opções de filtro por data, tipo de pagamento e código de comanda.

Atributos obrigatórios

Name
de
Type
date
Description
Data de início.
Name
ate
Type
date
Description
Data de fim.

Atributos opcionais

Name
comanda
Type
integer
Description
Código de comanda.

Request

GET

/vendas

curl -G https://api.toterus.com.br/vendas \
  -H "Authorization: Basic {privateKey}" \
  -d de=2025-10-28 \
  -d ate=2025-10-31 \
  -d comanda=100

Response

[
  {
    "id": "guid",
    "dataCadastro": "2025-10-31T20:32:42",
    "codigo": 669,
    "cliente": {
      "type": 2,
      "id": "100",
      "takeAway": false,
      "phone": "",
      "obs": ""
    },
    "delivery": false,
    "cancelada": false,
    "usuario": {
      "id": "guid",
      "nome": "Treinamento",
      "admin": true,
      "excluido": false
    },
    "produtos": [
      {
        "id": "guid",
        "titulo": "Couvert Sexta, Sabado e Domingo",
        "valorUnitario": 20,
        "quantidade": 1,
        "cancelado": false
      }
    ],
    "formasPagamento": [
      {
        "tipo": 2,
        "valorUnitario": 20,
        "valorTroco": 0
      }
    ]
  },
  ...
]

Toterus