Contas

Listar contas

GET /contas

Parâmetro	Tipo	Descrição
`tipo`	array de string	`pagamento` (a pagar) ou `recebimento` (a receber)
`situacao[]`	array de string	`em_aberto`, `parcial` e/ou `paga`
`fatura`	integer	Filtra pela fatura
`dataVencimento[min]` / `[max]`	date	Intervalo de vencimento (`Y-m-d`)
`dataPagamento[min]` / `[max]`	date	Intervalo de pagamento (`Y-m-d`)
`cobranca`	integer	`1` = com cobrança, `0` = sem cobrança

curl "https://api-aberta-prod.useimobia.com.br/api/v1/contas?situacao[]=em_aberto&dataVencimento[min]=2026-07-01&dataVencimento[max]=2026-07-31" \
  -H "API-KEY: SUA_CHAVE_AQUI"

Entendendo a situação da conta

A conta tem exatamente três situações possíveis:

Situação	Significado
`em_aberto`	Nenhum pagamento registrado
`parcial`	Paga parcialmente (veja o `saldo` restante)
`paga`	Quitada

📘
Não existe situação "vencida". Uma conta vencida e não paga permanece em_aberto (ou parcial). Para identificar contas vencidas, compare dataVencimento com a data atual — ex.: situacao[]=em_aberto&dataVencimento[max]=ontem. Cancelamento é um campo separado (cancelamento: boolean).

Detalhes da conta

GET /contas/{id}

Exemplo de resposta:

{
  "data": {
    "id": "nRW1R...",
    "codigoInterno": null,
    "origemId": "3grXW01EbK",
    "origemType": "Locacao",
    "valor": 900,
    "saldo": 900,
    "numeroParcela": 1,
    "totalParcelas": 12,
    "fatura": 1,
    "multa": { "valor": "10.00", "porcentagem": "10.0000" },
    "juro": { "valor": "1.00", "porcentagem": "1.0000" },
    "desconto": null,
    "descricao": "Parcela de locação",
    "tipo": "pagamento",
    "dataVencimento": "2022-05-05",
    "dataVencimentoOriginal": "2022-05-05",
    "dataEmissao": "2022-04-29",
    "situacao": "em_aberto",
    "pessoa": "OGzXDLX6oB",
    "categorizacao": "Setor de locação mensal",
    "cancelamento": false,
    "caixa": "Caixa Digital Imobia",
    "cobranca": {
      "id": "pax4GO64A9",
      "situacao": "paga",
      "status": 1,
      "url": "https://sandbox.asaas.com/b/pdf/14vh9ead69zjzkn7"
    },
    "formaCobranca": null,
    "repasseAutomatico": false,
    "retroativa": false,
    "geracaoAutomaticaNf": false,
    "geracaoAutomaticaCobranca": false
  }
}

Campos que merecem atenção

Campo	Descrição
`origemId` / `origemType`	Recurso que originou a conta (ex.: uma Locação)
`saldo`	Valor ainda em aberto
`numeroParcela` / `totalParcelas` / `fatura`	Identificam a parcela dentro do parcelamento
`pessoa`	ID da pessoa vinculada — resolve em `GET /pessoas/{id}`
`cobranca`	Cobrança gerada, quando houver; `url` traz o link do boleto/fatura
`dataVencimentoOriginal`	Vencimento antes de eventuais prorrogações

💡
Para ir além: a composição da conta (aluguel, taxas, multa, juros, descontos) fica em Itens de contas, e as baixas realizadas em Pagamentos.