Tools do Asaas
As 12 operações do Asaas que o seu produto executa na conta do cliente pelo Connect. Todas usam o mesmo endpoint, POST /api/tools/{tool}/execute.
- Listar clientesGETLista os clientes (pagadores) da conta, com filtro opcional por nome, e-mail, CPF ou CNPJ, grupo ou referência externa. A resposta traz data, totalCount e hasMore; pagine com offset e limit enquanto hasMore for true.
- Consultar clienteGETRetorna um cliente, com nome, CPF ou CNPJ, e-mail, telefones, endereço e configuração de notificação.
- Criar clientePOSTCria um cliente, o pagador de cobranças e assinaturas. name e cpfCnpj são obrigatórios. Não há campo de cidade: o Asaas obtém a cidade pelo postalCode.
- Atualizar clientePUTAtualiza um cliente. Os campos não enviados permanecem como estão.
- Listar cobrançasGETLista as cobranças, com filtro opcional por cliente, assinatura, status, forma de pagamento, data de pagamento ou referência externa. Os valores são em reais. A resposta traz data, totalCount e hasMore; pagine com offset e limit enquanto hasMore for true.
- Consultar cobrançaGETRetorna uma cobrança, com status, valor, valor líquido, vencimento, data de pagamento e os links invoiceUrl (a página da cobrança) e bankSlipUrl (o boleto).
- Criar cobrançaPOSTCria uma cobrança para um cliente, por boleto, Pix ou cartão de crédito, à vista ou parcelada. A resposta traz invoiceUrl, a página da cobrança para enviar ao pagador, e o Asaas pode notificar o cliente conforme a configuração de notificação dele.
- Atualizar cobrançaPUTAtualiza uma cobrança ainda pendente ou vencida; o cliente não pode ser alterado. Envie billingType, value e dueDate mesmo quando não mudam, com os valores atuais de Get payment. Um novo valor ou vencimento pode notificar o cliente.
- Remover cobrançaDELETERemove uma cobrança, que deixa de poder ser paga; é possível restaurá-la no Asaas. Não reembolsa um valor já pago, e remover uma cobrança de assinatura não encerra a assinatura.
- Listar assinaturasGETLista as assinaturas, com filtro opcional por cliente, status, forma de pagamento ou referência externa. As cobranças geradas por uma assinatura vêm de List payments com o filtro de assinatura. Pagine com offset e limit enquanto hasMore for true.
- Criar assinaturaPOSTCria uma assinatura para um cliente, que gera uma cobrança por ciclo, a primeira com vencimento em nextDueDate. As cobranças aparecem em List payments com o filtro de assinatura.
- Atualizar assinaturaPUTAtualiza uma assinatura. As mudanças valem para as cobranças ainda não geradas, a menos que updatePendingPayments seja true. status INACTIVE suspende a assinatura e mantém as cobranças, e ACTIVE a reativa com um novo nextDueDate.
Toolkits da mesma categoria
Ver os 100 toolkitsVeja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.

Conta Azul