Ver apólice

Para visualizar uma apólice específica é necessário que você tenha o ID de referência da apólice.

GET{{api_url}}/api/v1/policy/${id}

Headers

Name	Type	Description
Authorization*	String	Código de acesso

Params

Name	Type	Description
id*	Number	ID da apólice

Response Body

Name	Type	Description
id	Number	Identificador único da apólice
id_proposal	Number	Identificador único da proposta
policy_number	String	Protocolo de identificação da apólice
status	String	Status da apólice
value_final	Float	Valor da apólice
automatic_charge	Boolean	Cobrança automática
requested_cancellation	Boolean	Pedido de cancelamento
not_renew	Boolean	Não renovar
is_fleet	Boolean	Frota
claim_notice	Boolean	Sinistro avisado
id_type_cancelation	Number	Tipo de cancelamento
created_at	Date	Data de criação da apólice
tb_address.zip_code	String	CEP de referência do veículo
tb_address.street	String	Rua de referência do veículo
tb_address.complement	String	Complemento de referência do veículo
tb_address.district	String	Distrito de referência do veículo
tb_address.state	String	Estado de referência do veículo
tb_address.number	String	Número do endereço de referência do veículo
tb_proposal.id	Number	Identificador único da proposta
tb_proposal.protocol	String	Protocolo de identificação da proposta
tb_proposal.status	String	Status da proposta
tb_proposal.value_final	Float	Valor da propostas
tb_proposal.iof	Float	Iof
tb_proposal.maindriver_name	String	Condutor principal
tb_proposal.maindriver_document	String	Documento do condutor principal
tb_proposal.maindriver_birthdate	Date	Data de nascimento do condutor principal
inspection.id	String	Identificador único da vistoria
inspection.inspection_code	String	Código da vistoria
inspection.created_at	Date	Data de criação da vistoria
inspection.status	String	Status da vistoria
vehicle.manufacture_year	String	Ano do veículo
vehicle.year_model	String	Ano modelo do veículo
vehicle.plate	String	Placa do veículo
vehicle.chassi	String	Chassi do veículo
vehicle.value	Float	Valor do veículo
vehicle.auction	Boolean	Leilão
vehicle.remarked	Boolean	Chassi remarcado ou recuperado de sinistro
vehicle.gnv	Boolean	GNV
vehicle.brand	String	Marca do veículo
vehicle.model	String	Modelo do veículo
vehicle.vehicle_use	String	Uso do veículo
user.name	String	Nome do cliente
user.cpf	String	Documento do cliente
user.birthdate	Date	Data de nascimento do cliente
user.social_name	String	Nome social do cliente
user.phone	String	Número de telefone do cliente
user.email	String	Email do cliente
salesAgent.id	Number	Identificador único do autor da apólice
salesAgent.name	String	Nome do autor da apólice
salesAgent.cpf	String	Documento do autor da apólice
salesAgent.phone	String	Telefone do autor da apólice
salesAgent.email	String	Email do autor da apólice
salesAgent.tb_teams.name	String	Nome da equipe que o autor da apólice pertence
company.id	Number	Identificador único da companhia
company.trade_name	String	Nome da companhia
company.social_reason	String	Razão social da companhia
company.cnpj	String	CPNJ da companhia
insurance_coverage.id	Number	Id da cobertura
insurance_coverage.name	String	Nome da cobertura

Response Examples

200: OK

{
    "id": 1000,
    "id_proposal": 1000,
    "policy_number": "SPLITAUTO202404991IIO9O1234567",
    "status": "active",
    "value_final": 100,
    "automatic_charge": false,
    "requested_cancellation": false,
    "not_renew": false,
    "is_fleet": false,
    "claim_notice": null,
    "id_type_cancelation": null,
    "created_at": "2024-04-11 T13:26:26.000Z",
    "TB_ADDRESS": {
        "zip_code": "01153000",
        "street": "Rua Vitorino Carmilo",
        "complement": "",
        "district": "Barra Funda",
        "state": "SP",
        "number": "1"
    },
    "TB_PROPOSAL": {
        "id": 1000,
        "protocol": "JQMJ2T4F3GJU99KR9YMAX8UXGT7IMY",
        "status": "activated",
        "value_final": 100,
        "iof": 21.84,
        "maindriver_name": "BRUNO MELLO",
        "maindriver_document": "90798971234",
        "maindriver_birthdate": "2000-01-01 T02:00:00.000Z"
    },
    "inspection": {
        "id": 1056,
        "id_proposal": 1000,
        "inspection_code": "z2pisHXF",
        "created_at": "2024-04-11 T13:24:26.000Z",
        "deleted_at": null,
        "updated_at": "2024-04-11 T13:24:26.000Z",
        "result_date": null,
        "status": "pending"
    },
        "vehicle": {
        "manufacture_year": "2016",
        "year_model": "2017",
        "plate": "IXF5H55",
        "chassi": "9BHBG41BAHP604742",
        "value": 53996,
        "auction": 0,
        "remarked": false,
        "gnv": false,
        "brand": "Hyundai",
        "model": "HB20S Comfort Style 1.0 TB Flex 12V Mec.",
        "vehicle_use": {
            "name": "Motorista Aplicativo"
        }
    },
    "user": {
        "name": "BRUNO MELLO",
        "cpf": "90798971234",
        "birthdate": "2000-01-01 T02:00:00.000Z",
        "social_name": null,
        "phone": "11912924184",
        "email": "[email protected]"
    },
    "salesAgent": {
        "id": 137,
        "name": "BEATRIZ CRISTINA GONÇALVES",
        "cpf": "14458884670",
        "phone": "34991440602",
        "email": "[email protected]",
        "TB_TEAMS": [
            {
                "name": "Equipe 1"
            }
        ]
    },
    "company": {
        "id": 8,
        "trade_name": "Company name",
        "social_reason": "Social reason company",
        "cnpj": "12345678912345"
    },
    "insurance_coverage": [
        {
            "id": 3,
            "name": "Roubo e Furto PP | PT"
        }
    ]
}