Skip to content

Propostas comerciais ​

Submeter um pedido de proposta de gestão de condomínio — um contacto de quem procura uma administração.

É o ponto que um formulário de um sítio ou um agente de atendimento usa para fazer chegar um contacto à empresa, sem passar por correio eletrónico.

Submeter um pedido de proposta ​

POST /proposals

Permissão · commercial:write · aceita Idempotency-Key

Quem está a pedir ​

CampoTipoDescrição
ClientNametextoObrigatório. Nome de quem pede
ClientAddresstextoObrigatório. Morada
ClientEMailtextoCorreio eletrónico
ClientPhonetextoTelefone
ClientMobilePhonetextoTelemóvel
ClientDoor · ClientBlock · ClientFloor · ClientSidetextoPorta, bloco, piso e lado
ClientPlace · ClientZipCode · ClientZipCodePlacetextoLocalidade e código postal

Pelo menos um de ClientEMail, ClientPhone ou ClientMobilePhone é obrigatório — um contacto a que ninguém consegue responder não vale a pena ser registado.

O condomínio ​

CampoTipoDescrição
BuildingAddresstextoObrigatório. Morada do condomínio
BuildingDoor · BuildingPlacetextoPorta e localidade
BuildingZipCode · BuildingZipCodePlacetextoCódigo postal
BuildingTaxIdinteiroContribuinte do condomínio, se já tiver
BuildingYearsinteiroIdade do edifício, em anos

O que lá existe ​

CampoTipoDescrição
TotalHousinginteiroFrações de habitação
TotalStoresinteiroLojas
TotalGaragesinteiroGaragens
TotalHouseStorageinteiroArrecadações
TotalLiftsinteiroElevadores
AssistanceLiftsNametextoQuem faz a manutenção dos elevadores
HasCondominiumRoombooleanoTem sala de condomínio
HasGateHousebooleanoTem portaria
HasGatebooleanoTem portão
HasMaidbooleanoTem empregada de limpeza
HasMaidCompanybooleanoA limpeza é feita por empresa
MaidCompanytextoQual

O contexto ​

CampoTipoDescrição
VeryOldCondominiumDebtstextoDívidas antigas do condomínio
WhichLedContactCompanytextoO que os levou a contactar
HowKnowledgeCompanytextoComo conheceram a empresa

Pedido ​

bash
curl -X POST "https://servidor.exemplo/api/integrations/v1/acme/proposals" \
  -H "ApiKey: $GC_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
        "ClientName": "João Pereira",
        "ClientEMail": "joao.pereira@exemplo.pt",
        "ClientMobilePhone": "912345678",
        "ClientAddress": "Rua do Comércio, 40",
        "ClientPlace": "Lisboa",
        "ClientZipCode": "1100-150",
        "BuildingAddress": "Avenida Central, 88",
        "BuildingPlace": "Lisboa",
        "BuildingZipCode": "1000-200",
        "BuildingYears": 22,
        "TotalHousing": 18,
        "TotalStores": 2,
        "TotalGarages": 18,
        "TotalLifts": 2,
        "HasCondominiumRoom": true,
        "HasGateHouse": false,
        "WhichLedContactCompany": "Insatisfação com a administração actual.",
        "HowKnowledgeCompany": "Recomendação de um conhecido."
      }'

Resposta · 201 ​

json
{ "Reference": "2026/PR/114" }

A referência que a numeração lhe deu. É por ela que a proposta passa a ser conhecida em qualquer conversa sobre o assunto — guarde-a e apresente-a a quem submeteu.

A proposta não se lê de volta

Não há ponto para consultar ou acompanhar uma proposta submetida. O seguimento é feito no backoffice pela equipa comercial: orçamentação, aprovação e plano de negócio ficam do lado deles.

Só o preenchimento inicial vem de fora — quem envia um contacto não define o preço dele.

Erros ​

EstadoCódigoQuando
400INVALID_BODYCorpo em falta ou JSON inválido
400MISSING_FIELDFalta ClientName, ClientAddress, BuildingAddress, ou qualquer forma de contacto
401INVALID_KEY · KEY_REVOKED · KEY_EXPIREDVer Autenticação
403FORBIDDEN_SCOPEA credencial não tem commercial:write
409IDEMPOTENCY_KEY_REUSEDA chave já foi usada noutro pedido
422PROPOSAL_NOT_CREATEDNão chegou a ser registada. Reporte

Use chave de idempotência num formulário público

Um visitante que carregue duas vezes no botão, ou uma repetição depois de um tempo esgotado, cria dois contactos iguais na lista da equipa comercial. Uma chave por submissão evita isso. Ver Idempotência.

API de Integração GC