VenddorDocumentação API
API atualAPI legada
Guia rápidoReferência completa
Carregando índice…
API atual/Referência completa/ERP Cobrança e conciliação

Régua de cobrança: fila e contatos

Mostra a fila de títulos vencidos com a mensagem pronta, registra os contatos feitos e lista o histórico.

Ver a fila

Calcula na hora a lista de contas a receber em aberto e vencidas, da mais antiga para a mais nova, já com a mensagem pronta. Para cada título a plataforma escolhe a etapa de maior offset_days que não passa dos dias de atraso e preenche o modelo. Sem etapa aplicável, o canal sugerido é manual e a mensagem vem vazia. Não há paginação.

GET/api/v1/vendor/erp/cobranca/queueSeller

Fila de títulos vencidos a cobrar

Exemplo de requisição: Ver a fila

bash
curl "$BASE_URL/api/v1/vendor/erp/cobranca/queue" \
  -H "Authorization: Bearer $TOKEN"

Resposta: Ver a fila

200Fila
json
{
  "queue": [
    {
      "receivable_id": "cd8210a4-9275-4142-949f-b0f54e5a984c",
      "customer_ref": "Mercadinho Pinheiros",
      "description": "Venda a prazo 1043",
      "amount_cents": 20000,
      "due_date": "2026-10-01",
      "days_overdue": 10,
      "step_id": "0b1c2d3e-4f50-4a61-8b72-93a4b5c6d7e8",
      "channel": "whatsapp",
      "subject": "Boleto em atraso",
      "message": "Olá Mercadinho Pinheiros, o valor de R$ 200,00 venceu em 2026-10-01 (10 dias). Podemos ajudar?",
      "already_contacted": false,
      "last_contact_at": null
    }
  ],
  "total": 1
}

Campos da resposta

queuearray

Títulos a cobrar.

receivable_iduuid
Conta a receber.
customer_refstring
Referência do cliente.
descriptionstring
Descrição.
amount_centsinteger
Valor do título (não o saldo).
due_datestring
Vencimento.
days_overdueinteger
Dias de atraso.
step_iduuid
Etapa escolhida. null se nenhuma.
channelstring
Canal sugerido.
subjectstring
Assunto já preenchido.
messagestring
Mensagem já preenchida.
already_contactedboolean
true se já existe contato registrado para este título e esta etapa (ou qualquer contato, quando não há etapa).
last_contact_atdatetime
Último contato. null se nenhum.
totalinteger
Quantidade devolvida.

Erros: Ver a fila

StatusQuandoCorpo
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"}
Só entram títulos vencidos

Uma etapa com offset_days negativo ou zero não faz um título a vencer aparecer. A fila só olha títulos com vencimento anterior a hoje.

Registrar contato

Anota que você fez contato com o cliente, para o título deixar de parecer "não cobrado" na fila. A plataforma não envia a mensagem: o envio é seu. Registrar de novo o mesmo título, etapa e canal atualiza a anotação e a hora do contato existente em vez de duplicar.

POST/api/v1/vendor/erp/cobranca/contactSeller

Registra que um título foi cobrado

Corpo da requisição

receivable_iduuidobrigatório
Conta a receber cobrada.
step_iduuid
Etapa da régua, se foi o caso.
channelstringpadrão: manual
emailwhatsappphonemanual
Canal usado. Padrão manual.
notestring
Anotação livre.

Exemplo de requisição: Registrar contato

bash
curl -X POST "$BASE_URL/api/v1/vendor/erp/cobranca/contact" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "receivable_id": "cd8210a4-9275-4142-949f-b0f54e5a984c",
  "step_id": "0b1c2d3e-4f50-4a61-8b72-93a4b5c6d7e8",
  "channel": "whatsapp",
  "note": "Cliente prometeu pagar sexta"
}'

Resposta: Registrar contato

201Contato registrado
json
{
  "id": "7c8d9e0f-1a2b-4c3d-8e4f-5a6b7c8d9e0f",
  "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
  "receivable_id": "cd8210a4-9275-4142-949f-b0f54e5a984c",
  "step_id": "0b1c2d3e-4f50-4a61-8b72-93a4b5c6d7e8",
  "channel": "whatsapp",
  "status": "sent",
  "note": "Cliente prometeu pagar sexta",
  "created_at": "2026-10-11T14:30:00Z"
}

Campos da resposta

iduuid
Id do contato.
vendor_iduuid
Seller dono.
receivable_iduuid
Conta a receber cobrada.
step_iduuid
Etapa que originou o contato. null se foi avulso.
channelstring
emailwhatsappphonemanual
Canal usado.
statusstring
Sempre sent.
notestring
Anotação do contato.
created_atdatetime
Quando foi registrado ou atualizado pela última vez.

Erros: Registrar contato

StatusQuandoCorpo
400Corpo não é um JSON válido.{"error":"invalid request body","detail":"invalid character 'b' looking for beginning of object key string"}
400receivable_id em branco.{"error":"vendorerp: vendor_id and receivable_id required"}
400Canal inválido.{"error":"vendorerp: channel must be email|whatsapp|phone|manual"}
404A conta a receber ou a etapa não existe.{"error":"receivable 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"}

Listar contatos

GET/api/v1/vendor/erp/cobranca/eventsSeller

Histórico de contatos de cobrança

Parâmetros de consulta

pageintegerpadrão: 1
Página, a partir de 1. Valor inválido ou menor que 1 volta para 1.
per_pageintegerpadrão: 20
Itens por página, de 1 a 200. Fora dessa faixa vale o padrão.

Exemplo de requisição: Listar contatos

bash
curl "$BASE_URL/api/v1/vendor/erp/cobranca/events" \
  -H "Authorization: Bearer $TOKEN"

Resposta: Listar contatos

200Contatos
json
{
  "events": [
    {
      "id": "7c8d9e0f-1a2b-4c3d-8e4f-5a6b7c8d9e0f",
      "vendor_id": "94bd7e9a-fdad-4d01-8fc2-ba9d677d8b36",
      "receivable_id": "cd8210a4-9275-4142-949f-b0f54e5a984c",
      "step_id": "0b1c2d3e-4f50-4a61-8b72-93a4b5c6d7e8",
      "channel": "whatsapp",
      "status": "sent",
      "note": "Cliente prometeu pagar sexta",
      "created_at": "2026-10-11T14:30:00Z"
    }
  ],
  "total": 1
}

Campos da resposta

eventsarray

Contatos da página, do mais recente ao mais antigo.

iduuid
Id do contato.
vendor_iduuid
Seller dono.
receivable_iduuid
Conta a receber cobrada.
step_iduuid
Etapa que originou o contato. null se foi avulso.
channelstring
emailwhatsappphonemanual
Canal usado.
statusstring
Sempre sent.
notestring
Anotação do contato.
created_atdatetime
Quando foi registrado ou atualizado pela última vez.
totalinteger
Total de contatos.

Erros: Listar contatos

StatusQuandoCorpo
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"}

Veja também

  • Configurar a régua
  • Baixar contas a receber
Anterior
Régua de cobrança: configuração
Próxima
Conciliação: extratos e transações
Nesta página
  • Ver a fila
  • Exemplo de requisição: Ver a fila
  • Resposta: Ver a fila
  • Erros: Ver a fila
  • Registrar contato
  • Exemplo de requisição: Registrar contato
  • Resposta: Registrar contato
  • Erros: Registrar contato
  • Listar contatos
  • Exemplo de requisição: Listar contatos
  • Resposta: Listar contatos
  • Erros: Listar contatos
  • Veja também