Consultar Tipos de Garantia (Versão 1.0.0)

Retorna os tipos de garantia cadastrados no QProf (tela FBC108 - Tipo de Garantia) e, para cada tipo,
os campos complementares configurados para ele.

Use esta consulta antes de incluir uma garantia, para saber:

quais tipos existem (o codigo_tipo_garantia é obrigatório na inclusão);

quais campos complementares cada tipo possui (o codigo_campo identifica o campo ao informar os dados complementares).

Um tipo sem campos complementares é retornado com campos_complementares vazio ([]).

Tipos de campo complementar (tipo_campo)

Código	Descrição	Formato esperado do valor
D	DATA	Data no formato dd/mm/aaaa
N	NUMERO	Somente dígitos, até 50 caracteres
P2	PERCENTUAL (2 Dec)	Número com ponto e 2 casas decimais, ex.: `5.00`
P6	PERCENTUAL (6 Dec)	Número com ponto e 6 casas decimais, ex.: `7.000009`
T	TEXTO	Texto livre, até 200 caracteres
V	VALOR	Número com ponto e 2 casas decimais, ex.: `25000.00`

Situação (situacao): A = Ativo, I = Inativo.
Situação Campo Complementar (situacaoCampo): A = Ativo, I = Inativo.

Habilitação: o usuário de integração precisa estar parametrizado para o sistema 34 - CADASTRO GARANTIA,
com a mesma versão enviada em version.

application/json

Lista de tipos de garantia, ordenada pelo código do tipo. Retorna lista vazia quando nenhum tipo atende aos filtros.

Bodyapplication/json

curl --location 'https://dominio-do-cliente.qprof.com.br/QprofApi/api/api/servicos/cadastroPessoa/garantias/tipos?version=&situacao=&situacaoCampo=' \ --header 'Authorization: Bearer {{token}}' \ --header 'Content-Type: application/json'

[ { "codigo_tipo_garantia": 1, "descricao": "Imóvel", "situacao": "A", "campos_complementares": [ { "codigo_campo": 1, "codigo_tipo_garantia": 1, "descricao": "m²", "tipo_campo": "N", "descricao_tipo_campo": "NUMERO", "situacao": "A" }, { "codigo_campo": 3, "codigo_tipo_garantia": 1, "descricao": "Endereço", "tipo_campo": "T", "descricao_tipo_campo": "TEXTO", "situacao": "A" }, { "codigo_campo": 4, "codigo_tipo_garantia": 1, "descricao": "Data da construção", "tipo_campo": "D", "descricao_tipo_campo": "DATA", "situacao": "A" }, { "codigo_campo": 6, "codigo_tipo_garantia": 1, "descricao": "Valor do IPTU", "tipo_campo": "V", "descricao_tipo_campo": "VALOR", "situacao": "A" } ] }, { "codigo_tipo_garantia": 2, "descricao": "Veículos", "situacao": "A", "campos_complementares": [ { "codigo_campo": 2, "codigo_tipo_garantia": 2, "descricao": "Cor", "tipo_campo": "T", "descricao_tipo_campo": "TEXTO", "situacao": "A" }, { "codigo_campo": 8, "codigo_tipo_garantia": 2, "descricao": "Valor na tabela FIPE", "tipo_campo": "V", "descricao_tipo_campo": "VALOR", "situacao": "A" } ] } ]

Consultar Tipos de Garantia (Versão 1.0.0)

Requisição

Respostas