Apólices de seguro

As apólices de um condomínio e as de uma fração em particular. É o que o tratamento de um sinistro precisa para saber com que seguradora e com que mediador lidar.

Apólices de um condomínio

GET /buildings/{idBuilding}/insurance-policies

Permissão · masterdata:read

Parâmetros

Parâmetro	Tipo	Por omissão	Descrição
idBuilding	inteiro	—	No caminho. O condomínio
includeExpired	booleano	false	Inclui as apólices já terminadas

Pedido

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

Resposta · 200

Array simples, sem envelope — um condomínio tem poucas apólices.

[
  {
    "Id": 21,
    "IdBuilding": 12,
    "BuildingCode": "0012",
    "IdFraction": null,
    "FractionCode": null,
    "InsuranceType": { "Id": 1, "Description": "Multirriscos" },
    "Policy": "AP-2024-889112",
    "Insurer": { "Id": 91, "Description": "Seguradora Exemplo, S.A." },
    "Intermediary": { "Id": 92, "Description": "Mediação Exemplo, Lda." },
    "SumInsured": 1250000.0,
    "Periodicity": { "Id": 3, "Description": "Anual" },
    "BeginDate": "2024-01-01T00:00:00",
    "RenovationDate": "2027-01-01T00:00:00",
    "EndDate": null,
    "Notes": "Franquia de 250 EUR por sinistro."
  }
]

Campo	Tipo	Descrição
Id	inteiro	Identificador da apólice. É o IdPolicy que participar um sinistro aceita
IdBuilding · BuildingCode	inteiro · texto	O condomínio
IdFraction · FractionCode	inteiro · texto	Preenchidos só na apólice de uma fração. null na do condomínio
InsuranceType	objeto	Tipo de seguro
Policy	texto	Número da apólice
Insurer	objeto	Seguradora. Pode vir a null
Intermediary	objeto	Mediador. Pode vir a null
SumInsured	decimal	Capital seguro
Periodicity	objeto	Periodicidade do prémio
BeginDate	data	Início
RenovationDate	data	Próxima renovação
EndDate	data	Fim. null enquanto estiver em vigor
Notes	texto	Observações em texto livre

As coberturas não são dados estruturados

A apólice traz seguradora, mediador, capital e datas. As coberturas não existem como campos — o que houver está escrito em texto livre em Notes, se é que está. Não construa lógica sobre coberturas a partir daqui.

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	BUILDING_NOT_FOUND	Não existe condomínio com esse identificador

---

Apólices de uma fração

GET /fractions/{idFraction}/insurance-policies

Permissão · masterdata:read

Um proprietário pode segurar a sua fração por conta própria, para além do seguro do condomínio, e a empresa regista-o. É isso que este ponto devolve.

Parâmetros

Parâmetro	Tipo	Por omissão	Descrição
idFraction	inteiro	—	No caminho. A fração
includeExpired	booleano	false	Inclui as apólices já terminadas

Pedido

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

Resposta · 200

O mesmo objeto, desta vez com IdFraction e FractionCode preenchidos.

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

---

Participar um sinistro contra uma apólice

Ao abrir um sinistro, dê o Id da apólice em Insurance.IdPolicy e o número, a seguradora e o mediador são retirados dela — não tem de os repetir.

Para uma apólice que não esteja registada aqui, envie os campos soltos. Ver Sinistros.

Use includeExpired=true ao tratar um sinistro

Um sinistro é frequentemente participado contra a apólice que estava em vigor à data do dano, e não contra a que está em vigor hoje. Por isso a escolha de apólice na abertura de um sinistro aceita também as já terminadas.