/api/v1/condominiums/{condominium}/units| Authorization | Obrigatório | Bearer <access_token> |
| X-Request-Id | Opcional | Ecoado na resposta |
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
| condominium* | path | string | — |
/api/v1/condominiums/{condominium}/units| 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âmetro | Local | Tipo | Descrição |
|---|---|---|---|
| condominium* | path | string | — |
| Campo | Tipo | Restrições | Descrição |
|---|---|---|---|
| name* | string | 0–80 chars | — |
| block_id* | integer | — | — |
| floor | integer | nullable | — |
| build_type | string | no_construction | in_construction | under_maintenance | — |
| is_rented | boolean | — | — |
| is_occupied | boolean | — | — |
| parking_spaces | integer | 0–50 | Onboarding shortcut over the unit's parking spots. Reading it returns the number of spots the unit owns, adjusted by approved rentals. Writing it reconciles the spot records: raising the number appends unlabelled spots, lowering it removes unlabelled spots that are not lent out. It fails with 422 when reaching the requested number would require deleting a labelled spot or one under an active or pending rental, and when the condominium has more than one parking pool, since the spot's pool decides where it can be used. |
| area | number | nullable | — |
| street_name | string | nullable | — |
| street_number | string | nullable | — |
/api/v1/condominiums/{condominium}/parties| Authorization | Obrigatório | Bearer <access_token> |
| X-Request-Id | Opcional | Ecoado na resposta |
| Parâmetro | Local | Tipo | Descrição |
|---|---|---|---|
| condominium* | path | string | — |
/api/v1/condominiums/{condominium}/parties| 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âmetro | Local | Tipo | Descrição |
|---|---|---|---|
| condominium* | path | string | — |
| Campo | Tipo | Restrições | Descrição |
|---|---|---|---|
| name* | string | 0–255 chars | — |
| social_name | string | nullable | — |
| document_rg | string | nullable | — |
| document_cpf | string | — | 11 dígitos, sem formatação |
| document_passport | string | nullable | — |
| gender | string | male | female | agender | — |
| birthed_at | string·date | — | — |
| has_reduced_mobility | boolean | — | — |