Frações

As frações de um condomínio. O identificador da fração é o que liga um condómino, a correspondência e uma ocorrência a uma parte concreta do edifício.

Listar as frações de um condomínio

GET /buildings/{idBuilding}/fractions

Permissão · masterdata:read

Parâmetros

Parâmetro	Tipo	Por omissão	Descrição
idBuilding	inteiro	—	No caminho. O condomínio
limit	inteiro	500	Registos por página, no máximo 500
cursor	texto	—	Cursor da página seguinte. Ver Paginação

Pedido

curl "https://servidor.exemplo/api/integrations/v1/acme/buildings/12/fractions" \
  -H "ApiKey: $GC_API_KEY"

Resposta · 200

{
  "Items": [
    {
      "Id": 340,
      "IdBuilding": 12,
      "BuildingCode": "0012",
      "Code": "A",
      "Block": "",
      "Floor": "R/C",
      "Door": "Esq.",
      "Name": "Fração A",
      "Type": "Habitação",
      "Permilage": 34.5,
      "IsAdministration": false,
      "Sort": 1
    }
  ],
  "Paging": {
    "Limit": 500,
    "NextCursor": null,
    "HasMore": false
  }
}

Campo	Tipo	Descrição
Id	inteiro	Identificador da fração
IdBuilding	inteiro	O condomínio a que pertence
BuildingCode	texto	Código do condomínio, para não ter de o ir buscar
Code	texto	Letra ou código da fração, como consta do título
Block	texto	Bloco, quando o condomínio tem mais do que um
Floor	texto	Piso
Door	texto	Porta
Name	texto	Designação da fração
Type	texto	Tipo — habitação, garagem, arrecadação. Ver /reference/fraction-types
Permilage	decimal	Permilagem da fração na propriedade horizontal
IsAdministration	booleano	true na fração da própria administração, que não é habitação e não paga quotas
Sort	inteiro	Ordem de apresentação definida pela empresa. Pode vir a null

Uma fração não tem estado ativo ou inativo

Uma fração nunca é desativada. O que termina é a ligação de um proprietário a ela, que traz data de fim e se lê em /fractions/{id}/clients. Uma fração só deixa de ser gerida quando o condomínio deixa de o ser.

Erros

Estado	Código	Quando
400	INVALID_CURSOR	O cursor não foi emitido por esta API
401	INVALID_KEY · KEY_REVOKED · KEY_EXPIRED	Ver Autenticação
403	FORBIDDEN_SCOPE	A credencial não tem masterdata:read
404	BUILDING_NOT_FOUND	Não existe condomínio com esse identificador

O 404 é deliberado: uma página vazia leria-se como "este condomínio não tem frações", o que é diferente de "este condomínio não existe".

---

Obter uma fração

GET /fractions/{idFraction}

Permissão · masterdata:read

Pedido

curl "https://servidor.exemplo/api/integrations/v1/acme/fractions/340" \
  -H "ApiKey: $GC_API_KEY"

Resposta · 200

O mesmo objeto da listagem, sem envelope.

Erros

Estado	Código	Quando
401	INVALID_KEY · KEY_REVOKED · KEY_EXPIRED	Ver Autenticação
403	FORBIDDEN_SCOPE	A credencial não tem masterdata:read
404	FRACTION_NOT_FOUND	Não existe fração com esse identificador nesta empresa