Fornecedores

Os fornecedores da empresa de condomínios. Inclui seguradoras e mediadores de seguros, que aqui são fornecedores como qualquer outro.

É desta listagem que sai o Id para atribuir uma ocorrência a um fornecedor, e o número de contribuinte pelo qual uma fatura é reconhecida no registo.

Listar fornecedores

GET /suppliers

Permissão · masterdata:read

Parâmetros

Parâmetro	Tipo	Por omissão	Descrição
type	texto	todos	Restringe a um papel: insurance, intermediary ou maintenance
limit	inteiro	500	Registos por página, no máximo 500
cursor	texto	—	Cursor da página seguinte. Ver Paginação

Pedido

# todos
curl "https://servidor.exemplo/api/integrations/v1/acme/suppliers" \
  -H "ApiKey: $GC_API_KEY"

# só seguradoras
curl "https://servidor.exemplo/api/integrations/v1/acme/suppliers?type=insurance" \
  -H "ApiKey: $GC_API_KEY"

Resposta · 200

{
  "Items": [
    {
      "Id": 88,
      "Code": "F0088",
      "Name": "Elevadores Norte, Lda.",
      "TaxId": "501234567",
      "SupplierType": { "Id": 4, "Description": "Manutenção" },
      "EMail": "geral@exemplo.pt",
      "MobilePhone": "912345678",
      "Phones": ["213456789", "213456790"],
      "ContactEMails": ["assistencia@exemplo.pt", "financeiro@exemplo.pt"]
    }
  ],
  "Paging": {
    "Limit": 500,
    "NextCursor": null,
    "HasMore": false
  }
}

Campo	Tipo	Descrição
Id	inteiro	Identificador do fornecedor
Code	texto	Código pelo qual a empresa o conhece
Name	texto	Designação
TaxId	texto	Número de contribuinte. É por ele que uma fatura é reconhecida no registo
SupplierType	objeto	Tipo de fornecedor. Corresponde a uma entrada de /reference/supplier-types
email	texto	Endereço principal
MobilePhone	texto	Telemóvel
Phones	lista de texto	Telefones dos contactos, sem repetições
ContactEMails	lista de texto	Endereços dos contactos, sem repetições

Os contactos vêm como lista, não como texto a separar

Um fornecedor pode ter vários telefones e vários endereços. A API já os entrega separados e sem duplicados — não tem de partir nenhuma string.

Os três tipos

O type filtra pelo papel, que é uma marca no tipo do fornecedor:

Valor	Traz
insurance	Seguradoras
intermediary	Mediadores de seguros
maintenance	Prestadores de manutenção

Um mesmo fornecedor pode ter mais do que um papel. Para saber todos os papéis de um tipo, leia /reference/supplier-types — cada entrada traz as marcas que a definem.

Erros

Estado	Código	Quando
400	INVALID_CURSOR	O cursor não foi emitido por esta API
400	INVALID_TYPE	O type não é insurance, intermediary nem maintenance
401	INVALID_KEY · KEY_REVOKED · KEY_EXPIRED	Ver Autenticação
403	FORBIDDEN_SCOPE	A credencial não tem masterdata:read

---

Obter um fornecedor

GET /suppliers/{idSupplier}

Permissão · masterdata:read

Pedido

curl "https://servidor.exemplo/api/integrations/v1/acme/suppliers/88" \
  -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	SUPPLIER_NOT_FOUND	Não existe fornecedor com esse identificador nesta empresa