Condoa Staging

GET/api/v1/condominiums/{condominium}/invoices

Lista cobranças do condomínio com filtros por status, unidade, morador e vencimento

Sem autenticação

Headers

Authorization	Obrigatório	`Bearer <access_token>`
X-Request-Id	Opcional	`Ecoado na resposta`

Parâmetros

Parâmetro	Local	Tipo	Descrição
condominium*	path	string	—
state	query	string	—
unit_id	query	integer	—
party_id	query	integer	—
due_from	query	string·date	—
due_to	query	string·date	—

Respostas

POST/api/v1/condominiums/{condominium}/invoices

Cria uma cobrança em rascunho, vinculada ao período financeiro aberto

Sem autenticação

Headers

Authorization	Obrigatório	`Bearer <access_token>`
Content-Type	Obrigatório	`application/json`
Idempotency-Key	Recomendado	`ULID, janela de 24h`
X-Request-Id	Opcional	`Ecoado na resposta`

Parâmetros

Parâmetro	Local	Tipo	Descrição
condominium*	path	string	—

Corpo da requisição*

Campo	Tipo	Restrições	Descrição
unit_id*	integer	—	—
party_id	integer	nullable	—
bank_account_id*	integer	—	—
billing_type	string	BOLETO \| PIX \| BOLETO_PIX	—
due_date*	string·date	—	—
subtotal*	number	—	—
fine_amount	number	—	—
interest_amount	number	—	—
monetary_correction_amount	number	—	—
discount_amount	number	—	—
total*	number	—	—
notes	string	nullable	—

Respostas

POST/api/v1/condominiums/{condominium}/invoices/{publicId}/issue

Emite as opções de pagamento (boleto registrado + QR PIX) em uma única chamada ao gateway

Sem autenticação

Headers

Authorization	Obrigatório	`Bearer <access_token>`
Idempotency-Key	Recomendado	`ULID, janela de 24h`
X-Request-Id	Opcional	`Ecoado na resposta`

Parâmetros

Parâmetro	Local	Tipo	Descrição
condominium*	path	string	—
publicId*	path	string	—

Respostas

GET/api/v1/condominiums/{condominium}/invoices/{publicId}/payment

Recupera as opções de pagamento já emitidas (URL do boleto, payload PIX, txid)

Sem autenticação

Headers

Authorization	Obrigatório	`Bearer <access_token>`
X-Request-Id	Opcional	`Ecoado na resposta`

Parâmetros

Parâmetro	Local	Tipo	Descrição
condominium*	path	string	—
publicId*	path	string	—

Respostas

GET/api/v1/condominiums/{condominium}/expenses

Lista despesas do condomínio com filtros por fornecedor, conta contábil e data de pagamento

Sem autenticação

Headers

Authorization	Obrigatório	`Bearer <access_token>`
X-Request-Id	Opcional	`Ecoado na resposta`

Parâmetros

Parâmetro	Local	Tipo	Descrição
condominium*	path	string	—

Respostas

POST/api/v1/condominiums/{condominium}/expenses

Registra uma despesa já liquidada como lançamento no livro razão

Sem autenticação

Headers

Authorization	Obrigatório	`Bearer <access_token>`
Content-Type	Obrigatório	`application/json`
Idempotency-Key	Recomendado	`ULID, janela de 24h`
X-Request-Id	Opcional	`Ecoado na resposta`

Parâmetros

Parâmetro	Local	Tipo	Descrição
condominium*	path	string	—

Corpo da requisição*

Campo	Tipo	Restrições	Descrição
supplier_id	integer	nullable	—
chart_of_accounts_id*	integer	—	—
bank_account_id	integer	nullable	—
amount*	number	—	—
fine_amount	number	nullable	—
interest_amount	number	nullable	—
discount_amount	number	nullable	—
description*	string	—	—
payee	string	nullable	—
document_number	string	nullable	—
payment_method	string	nullable	—
notes	string	nullable	—
due_at*	string·date	—	—
paid_at	string·date	nullable	—

Respostas

POST/api/v1/condominiums/{condominium}/expenses/installments

Cria N despesas vinculadas com vencimentos mensais, distribuindo o total entre as parcelas

Sem autenticação

Headers

Authorization	Obrigatório	`Bearer <access_token>`
Content-Type	Obrigatório	`application/json`
Idempotency-Key	Recomendado	`ULID, janela de 24h`
X-Request-Id	Opcional	`Ecoado na resposta`

Parâmetros

Parâmetro	Local	Tipo	Descrição
condominium*	path	string	—

Corpo da requisição*

Campo	Tipo	Restrições	Descrição
count*	integer	2–60	—
total_amount*	number	—	—
first_due_at*	string·date	—	—
monthly_interval_days	integer	1–90	—
supplier_id	integer	nullable	—
chart_of_accounts_id*	integer	—	—
bank_account_id	integer	nullable	—
description*	string	—	—
payment_method	string	nullable	—

Respostas

GET/api/v1/condominiums/{condominium}/payables

Lista contas a pagar do condomínio com filtros por fornecedor, data de vencimento e estado

Escopo: payments.read

Sem autenticação

Headers

Authorization	Obrigatório	`Bearer <access_token>`
X-Request-Id	Opcional	`Ecoado na resposta`

Parâmetros

Parâmetro	Local	Tipo	Descrição
condominium*	path	string	—

Respostas

POST/api/v1/condominiums/{condominium}/payables

Cria uma conta a pagar pendente no condomínio

Escopo: payments.write

Sem autenticação

Headers

Authorization	Obrigatório	`Bearer <access_token>`
Content-Type	Obrigatório	`application/json`
Idempotency-Key	Recomendado	`ULID, janela de 24h`
X-Request-Id	Opcional	`Ecoado na resposta`

Parâmetros

Parâmetro	Local	Tipo	Descrição
condominium*	path	string	—

Corpo da requisição*

Campo	Tipo	Restrições	Descrição
supplier_id	integer	nullable	—
chart_of_accounts_id*	integer	—	—
payee_name	string	nullable	—
amount*	integer	—	Valor em centavos
fine_amount	integer	nullable	—
interest_amount	integer	nullable	—
discount_amount	integer	nullable	—
forma_pagamento*	string	pix \| ted \| doc \| boleto \| cash \| check	—
due_date*	string·date	—	—
issue_date	string·date	nullable	—
document_number	string	nullable	—
description*	string	—	—
notes	string	nullable	—

Respostas

GET/api/v1/condominiums/{condominium}/payables/{payable}

Retorna uma conta a pagar pelo seu public_id

Escopo: payments.read

Sem autenticação

Headers

Authorization	Obrigatório	`Bearer <access_token>`
X-Request-Id	Opcional	`Ecoado na resposta`

Parâmetros

Parâmetro	Local	Tipo	Descrição
condominium*	path	string	—
payable*	path	string	public_id do payable

Respostas

PATCH/api/v1/condominiums/{condominium}/payables/{payable}

Atualiza campos de uma conta a pagar pendente

Escopo: payments.write

Sem autenticação

Headers

Authorization	Obrigatório	`Bearer <access_token>`
Content-Type	Obrigatório	`application/json`
Idempotency-Key	Recomendado	`ULID, janela de 24h`
X-Request-Id	Opcional	`Ecoado na resposta`

Parâmetros

Parâmetro	Local	Tipo	Descrição
condominium*	path	string	—
payable*	path	string	public_id do payable

Corpo da requisição*

Campo	Tipo	Restrições	Descrição
payee_name	string	nullable	—
amount	integer	nullable	—
fine_amount	integer	nullable	—
interest_amount	integer	nullable	—
discount_amount	integer	nullable	—
forma_pagamento	string	nullable	—
due_date	string·date	nullable	—
issue_date	string·date	nullable	—
document_number	string	nullable	—
description	string	nullable	—
notes	string	nullable	—

Respostas

DELETE/api/v1/condominiums/{condominium}/payables/{payable}

Remove uma conta a pagar que ainda não foi incluída em lote de pagamento

Escopo: payments.write

Sem autenticação

Headers

Authorization	Obrigatório	`Bearer <access_token>`
Idempotency-Key	Recomendado	`ULID, janela de 24h`
X-Request-Id	Opcional	`Ecoado na resposta`

Parâmetros

Parâmetro	Local	Tipo	Descrição
condominium*	path	string	—
payable*	path	string	public_id do payable

Respostas

POST/api/v1/condominiums/{condominium}/payables/{payable}/mark-for-remessa

Marca a conta a pagar para ser incluída no próximo lote CNAB pagamento

Escopo: payments.write. Move o estado para marked_for_remessa.

Sem autenticação

Headers

Authorization	Obrigatório	`Bearer <access_token>`
Idempotency-Key	Recomendado	`ULID, janela de 24h`
X-Request-Id	Opcional	`Ecoado na resposta`

Parâmetros

Parâmetro	Local	Tipo	Descrição
condominium*	path	string	—
payable*	path	string	—

Respostas

POST/api/v1/condominiums/{condominium}/payables/{payable}/unmark-for-remessa

Remove a marcação para remessa de uma conta a pagar

Escopo: payments.write. Reverte o estado de marked_for_remessa para pending.

Sem autenticação

Headers

Authorization	Obrigatório	`Bearer <access_token>`
Idempotency-Key	Recomendado	`ULID, janela de 24h`
X-Request-Id	Opcional	`Ecoado na resposta`

Parâmetros

Parâmetro	Local	Tipo	Descrição
condominium*	path	string	—
payable*	path	string	—

Respostas

GET/api/v1/condominiums/{condominium}/pagamento-batches

Lista lotes de pagamento CNAB do condomínio

Escopo: payments.read

Sem autenticação

Headers

Authorization	Obrigatório	`Bearer <access_token>`
X-Request-Id	Opcional	`Ecoado na resposta`

Parâmetros

Parâmetro	Local	Tipo	Descrição
condominium*	path	string	—

Respostas

POST/api/v1/condominiums/{condominium}/pagamento-batches

Gera um arquivo CNAB 240 de pagamento com todos os payables marcados para remessa

Escopo: payments.write. Agrupa os payables em estado marked_for_remessa e emite o arquivo remessa.

Sem autenticação

Headers

Authorization	Obrigatório	`Bearer <access_token>`
Content-Type	Obrigatório	`application/json`
Idempotency-Key	Recomendado	`ULID, janela de 24h`
X-Request-Id	Opcional	`Ecoado na resposta`

Parâmetros

Parâmetro	Local	Tipo	Descrição
condominium*	path	string	—

Corpo da requisição*

Campo	Tipo	Restrições	Descrição
data_pagamento*	string·date	—	Data de pagamento a estampar no CNAB

Respostas

GET/api/v1/condominiums/{condominium}/pagamento-batches/{pagamentoBatch}

Retorna um lote de pagamento pelo seu public_id

Escopo: payments.read

Sem autenticação

Headers

Authorization	Obrigatório	`Bearer <access_token>`
X-Request-Id	Opcional	`Ecoado na resposta`

Parâmetros

Parâmetro	Local	Tipo	Descrição
condominium*	path	string	—
pagamentoBatch*	path	string	public_id do lote

Respostas

GET/api/v1/condominiums/{condominium}/pagamento-batches/{pagamentoBatch}/file

Faz download do arquivo CNAB 240 de remessa de pagamento

Escopo: payments.read. Retorna o arquivo .rem como download.

Sem autenticação

Headers

Authorization	Obrigatório	`Bearer <access_token>`
X-Request-Id	Opcional	`Ecoado na resposta`

Parâmetros

Parâmetro	Local	Tipo	Descrição
condominium*	path	string	—
pagamentoBatch*	path	string	—

Respostas

POST/api/v1/condominiums/{condominium}/pagamento-batches/{pagamentoBatch}/retorno

Importa um arquivo de retorno CNAB 240 e processa as confirmações de pagamento

Escopo: payments.write. Atualiza o estado dos payables confirmados e registra lançamentos contábeis.

Sem autenticação

Headers

Authorization	Obrigatório	`Bearer <access_token>`
Content-Type	Obrigatório	`multipart/form-data`
Idempotency-Key	Recomendado	`ULID, janela de 24h`
X-Request-Id	Opcional	`Ecoado na resposta`

Parâmetros

Parâmetro	Local	Tipo	Descrição
condominium*	path	string	—
pagamentoBatch*	path	string	—

Corpo da requisição*

Campo	Tipo	Restrições	Descrição
file*	string·binary	—	Arquivo .ret CNAB 240

Respostas

GET/api/v1/condominiums/{condominium}/defaulters

Snapshot de inadimplência agregado por unidade, com total em aberto e dias de atraso

Sem autenticação

Headers

Authorization	Obrigatório	`Bearer <access_token>`
X-Request-Id	Opcional	`Ecoado na resposta`

Parâmetros

Parâmetro	Local	Tipo	Descrição
condominium*	path	string	—
as_of	query	string·date	—
min_overdue_days	query	integer	—
min_amount	query	number	—

Respostas

GET/api/v1/condominiums/{condominium}/monetary-indexes

Lista os índices monetários suportados (IPCA, IGPM, INPC, INCC, TJSP)

Sem autenticação

Headers

Authorization	Obrigatório	`Bearer <access_token>`
X-Request-Id	Opcional	`Ecoado na resposta`

Parâmetros

Parâmetro	Local	Tipo	Descrição
condominium*	path	string	—

Respostas

GET/api/v1/condominiums/{condominium}/bank-accounts

Lista as contas bancárias do condomínio (com saldo atual e tipo)

Sem autenticação

Headers

Authorization	Obrigatório	`Bearer <access_token>`
X-Request-Id	Opcional	`Ecoado na resposta`

Parâmetros

Parâmetro	Local	Tipo	Descrição
condominium*	path	string	—

Respostas

POST/api/v1/condominiums/{condominium}/bank-accounts/{bankAccount}/statements/import

Importa um extrato OFX ou CSV, dispara conciliação automática e emite bank.statement.imported

Sem autenticação

Headers

Authorization	Obrigatório	`Bearer <access_token>`
Content-Type	Obrigatório	`multipart/form-data`
Idempotency-Key	Recomendado	`ULID, janela de 24h`
X-Request-Id	Opcional	`Ecoado na resposta`

Parâmetros

Parâmetro	Local	Tipo	Descrição
condominium*	path	string	—
bankAccount*	path	integer	—

Corpo da requisição*

Campo	Tipo	Restrições	Descrição
file*	string·binary	—	—
format*	string	ofx \| csv	—

Respostas

GET/api/v1/condominiums/{condominium}/chart-of-accounts

Lista as contas do plano (com filtros por tipo e estado)

Sem autenticação

Headers

Authorization	Obrigatório	`Bearer <access_token>`
X-Request-Id	Opcional	`Ecoado na resposta`

Parâmetros

Parâmetro	Local	Tipo	Descrição
condominium*	path	string	—

Respostas

GET/api/v1/condominiums/{condominium}/account-entries

Lista lançamentos do livro razão (receitas e despesas) com filtros por período e conta

Sem autenticação

Headers

Authorization	Obrigatório	`Bearer <access_token>`
X-Request-Id	Opcional	`Ecoado na resposta`

Parâmetros

Parâmetro	Local	Tipo	Descrição
condominium*	path	string	—

Respostas

POST/api/v1/condominiums/{condominium}/account-entries

Cria um lançamento contábil no período financeiro que cobre a data de pagamento

Sem autenticação

Headers

Authorization	Obrigatório	`Bearer <access_token>`
Content-Type	Obrigatório	`application/json`
Idempotency-Key	Recomendado	`ULID, janela de 24h`
X-Request-Id	Opcional	`Ecoado na resposta`

Parâmetros

Parâmetro	Local	Tipo	Descrição
condominium*	path	string	—

Corpo da requisição*

Campo	Tipo	Restrições	Descrição
type*	string	revenue \| expense	—
chart_of_accounts_id*	integer	—	—
bank_account_id	integer	nullable	—
unit_id	integer	nullable	—
supplier_id	integer	nullable	—
amount*	number	—	—
description*	string	—	—
payee	string	nullable	—
document_number	string	nullable	—
payment_method	string	nullable	—
due_at	string·date	nullable	—
paid_at*	string·date	—	—

Respostas

POST/api/v1/condominiums/{condominium}/account-transfers

Registra uma transferência entre contas bancárias como par de lançamentos (saída e entrada)

Sem autenticação

Headers

Authorization	Obrigatório	`Bearer <access_token>`
Content-Type	Obrigatório	`application/json`
Idempotency-Key	Recomendado	`ULID, janela de 24h`
X-Request-Id	Opcional	`Ecoado na resposta`

Parâmetros

Parâmetro	Local	Tipo	Descrição
condominium*	path	string	—

Corpo da requisição*

Campo	Tipo	Restrições	Descrição
source_bank_account_id*	integer	—	—
destination_bank_account_id*	integer	—	—
amount*	number	—	—
transfer_date*	string·date	—	—
description	string	nullable	—
chart_of_accounts_id*	integer	—	—

Respostas

Finanças

Lista cobranças do condomínio com filtros por status, unidade, morador e vencimento

Cria uma cobrança em rascunho, vinculada ao período financeiro aberto

Emite as opções de pagamento (boleto registrado + QR PIX) em uma única chamada ao gateway

Recupera as opções de pagamento já emitidas (URL do boleto, payload PIX, txid)

Lista despesas do condomínio com filtros por fornecedor, conta contábil e data de pagamento

Registra uma despesa já liquidada como lançamento no livro razão

Cria N despesas vinculadas com vencimentos mensais, distribuindo o total entre as parcelas

Lista contas a pagar do condomínio com filtros por fornecedor, data de vencimento e estado

Cria uma conta a pagar pendente no condomínio

Retorna uma conta a pagar pelo seu public_id

Atualiza campos de uma conta a pagar pendente

Remove uma conta a pagar que ainda não foi incluída em lote de pagamento

Marca a conta a pagar para ser incluída no próximo lote CNAB pagamento

Remove a marcação para remessa de uma conta a pagar

Lista lotes de pagamento CNAB do condomínio

Gera um arquivo CNAB 240 de pagamento com todos os payables marcados para remessa

Retorna um lote de pagamento pelo seu public_id

Faz download do arquivo CNAB 240 de remessa de pagamento

Importa um arquivo de retorno CNAB 240 e processa as confirmações de pagamento

Snapshot de inadimplência agregado por unidade, com total em aberto e dias de atraso

Lista os índices monetários suportados (IPCA, IGPM, INPC, INCC, TJSP)

Lista as contas bancárias do condomínio (com saldo atual e tipo)

Importa um extrato OFX ou CSV, dispara conciliação automática e emite bank.statement.imported

Lista as contas do plano (com filtros por tipo e estado)

Lista lançamentos do livro razão (receitas e despesas) com filtros por período e conta

Cria um lançamento contábil no período financeiro que cobre a data de pagamento

Registra uma transferência entre contas bancárias como par de lançamentos (saída e entrada)