Quickstart
Qual Remessa Usar?
A Equals Connect oferece dois tipos de relatório:
| Tipo | ID Sandbox | Quando usar |
|---|---|---|
| Vendas | 35176 | Para registrar previsões de recebimento (Contas a Receber) |
| Financeiro | 35177 | Para registrar efetivações (baixas, cancelamentos, taxas) |
Exemplo Prático
- Dia da venda: Gere a remessa de Vendas. Você verá registros
A1(Venda em Aberta) comVLLIQUIDO: R$ 145,50eDTVENCIMENTO: 14/04/2026. - Dia do pagamento (30 dias depois): Gere a remessa Financeira. Você verá registros
D1(Baixa por Pagamento) confirmando o depósito.
[!NOTE] Para entender profundamente a diferença, consulte: Entendendo os Tipos de Remessa
Quickstart (5 minutos)
Comece a integrar agora mesmo com apenas 3 chamadas principais.
1. Criar Relatório
Solicite a geração de uma remessa de vendas (ID 35176 no Sandbox).
curl -X POST "{BASE_URL}/retornos/geracao" \
-H "Authorization: Basic {TOKEN}" \
-H "Content-Type: application/json" \
-d '{
"idMovFinanCfg": 35176,
"dataMovimentacaoInicial": "01/03/2026",
"dataMovimentacaoFinal": "07/03/2026"
}'
2. Aguardar Processamento
Em Produção
Aguarde a notificação via Webhook (recomendado) ou acompanhe a Situação até CONCLUIDO.
No Sandbox
IMPORTANTE:
- Webhooks NÃO estão disponíveis no ambiente Sandbox
- O status é fixo como
EM_PROCESSAMENTOe nunca mudaComo proceder:
- Gere a remessa
- Pule a verificação de status
- Faça o download imediatamente (os dados já estão prontos)
3. Download da Remessa (Paginado)
Consuma os dados assim que a situação estiver CONCLUIDO.
curl -X POST "{BASE_URL}/retornos/download" \
-H "Authorization: Basic {TOKEN}" \
-H "Content-Type: application/json" \
-d '{
"id": 123456,
"pagina": 1
}'
Ambientes
| Ambiente | Base URL |
|---|---|
| Sandbox | https://partner.equals.com.br/sandbox/api/equals-retorno |
| Produção | https://app.equals.com.br/api/retornos |
IDs Fixos (Sandbox)
| Tipo | ID |
|---|---|
| Vendas | 35176 |
| Financeiro | 35177 |
Próximos Passos
Agora que você já conhece o fluxo básico, explore os detalhes técnicos:
Este conteúdo foi útil para você?