Clients - Protected

Get client by ID

Changed on

Get single client with all details and addresses. Verifies the client belongs to the authenticated user's company.

get/api/clients/{client_id}

Request

  • Base URL
    https://api.multigest.pt (the document declares no server; this is the origin it was published from)
  • URL
    https://api.multigest.pt/api/clients/{client_id}
  • Auth
    API key in header x-api-token and API key in header x-origin-verify

Path parameters

client_idinteger required

Client ID

Headers

x-api-tokenstring nullable

Response

Successful Response

idinteger required
nomestring required
emailstring nullable
contactostring nullable
nifinteger nullable
ccstring nullable
validade_ccstring date nullable
entidade_emissora_ccstring nullable
particularboolean
recorrenteboolean
carta_conducaostring nullable
data_carta_conducaostring date nullable
ibanstring nullable
iban_alimentarstring nullable
paisstring nullable
moradastring nullable
codigo_postalstring nullable
localidadestring nullable
cidadestring nullable
idcompanyinteger nullable
id_pontodevendainteger nullable
id_estado_civilinteger nullable
id_tipo_casainteger nullable
id_contrato_trabalhointeger nullable
tipo_idinteger nullable
agregado_familiarinteger nullable
creditos_ativosinteger nullable
mensalidade_casanumber nullable
antiguidade_empresainteger nullable
mensalidade_creditosnumber nullable
vencimento_liquidonumber nullable
foreign_nifstring nullable
data_nascimentostring date nullable
nacionalidadestring nullable
naturalidadestring nullable
nissstring nullable
doc_identificacao_tipo_idinteger nullable
dependentesinteger nullable
atividade_abertaboolean nullable
profissaostring nullable
data_entrada_empresastring date nullable
nif_entidade_empregadorastring nullable
nome_entidade_empregadorastring nullable
data_constituicaostring date nullable
tipo_empresa_idinteger nullable
capital_socialnumber nullable
caestring nullable
atividadestring nullable
resultado_liquidonumber nullable
volume_negociosnumber nullable
ano_contasinteger nullable
codigo_iesstring nullable
IDinteger nullable
Nomestring nullable
NIFinteger nullable
Contactostring nullable
CCstring nullable
ValidadeCCstring nullable
EntidadeEmissoraCCstring nullable
CartaConducaostring nullable
DataCartaConducaostring nullable

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status