FinancingCdc

Rota responsável por analisar as condições da proposta

SecurityoAuth2ClientCredentials

Request

Request Body schema:
application/json-patch+json

cpf required	string
cnpj	string or null
birthDate required	string
clinicCode required	string
requestedAmount required	number <double>
monthlyIncome required	number <double>
phoneNumber	string or null

Responses

200

Success

400

Unable to return conditions due to validation error

404

Not Found

post/api/v2/financingCdc/conditions

Request samples

Payload

{"cpf": "string",
"cnpj": "string",
"birthDate": "string",
"clinicCode": "string",
"requestedAmount": 0,
"monthlyIncome": 0,
"phoneNumber": "string"
}

Response samples

200
400
404

application/json

{"aproved": true,
"installments": 0,
"maxValue": 0,
"installmentOfMaxValue": 0,
"homogeneousGroup": 0,
"message": "string"
}

Rota responsável por retornar dados básicos favorecidos da proposta

SecurityoAuth2ClientCredentials

Request

path Parameters

proposalNumber required	integer <int32>
version required	string

Responses

200

Return favoreds basic data

400

Unable to return data

get/api/v1/financingCdc/proposals/{proposalNumber}/favored-data

Response samples

200
400

application/json

{"success": true,
"message": "string",
"service": "string",
"external": {"statusCode": 100,
"service": "string",
"error": "string"
},
"listaFavorecido": [{"nomeTitular": "string",
"sequenciaFavorecido": 0,
"idFavorecido": "string",
"tipoFavorecido": "string"
}
]
}

Rota responsável pela devolução dos favorecidos da proposta

SecurityoAuth2ClientCredentials

Request

path Parameters

proposalNumber required	integer <int32>
version required	string

Responses

200

Return favoreds

400

Unable to return favoreds

get/api/v1/financingCdc/proposals/{proposalNumber}/favored

Response samples

200
400

application/json

{"success": true,
"message": "string",
"service": "string",
"external": {"statusCode": 100,
"service": "string",
"error": "string"
},
"listaFavorecidosProposta": [{"codigoFavorecido": 0,
"nomeFavorecido": "string",
"valorPagamento": 0,
"idFavorecido": "string"
}
]
}

Rota responsável pelo cadastro de favorecidos à proposta

SecurityoAuth2ClientCredentials

Request

path Parameters

version required	string
proposalNumber required	string

Request Body schema:
application/json-patch+json

numeroProposta	integer <int32>
	Array of objects or null (ListaFavorecido)

Responses

200

Registered favoreds

400

Unable to register favored due to validation error

404

Not Found

post/api/v1/financingCdc/proposals/{proposalNumber}/register-favored

Request samples

Payload

{"numeroProposta": 0,
"listaFavorecido": [{"idFavorecido": "string",
"valorFavorecido": 0,
"tipoFavorecido": "string"
}
]
}

Response samples

200
400
404

application/json

{"success": true,
"message": "string",
"service": "string",
"external": {"statusCode": 100,
"service": "string",
"error": "string"
},
"flagGravaFavorecido": true,
"statusRespostaServico": [{"codigo": 0,
"mensagem": "string",
"criticidade": "string",
"sistemaOrigem": "string",
"servicoOrigem": "string"
}
]
}

Rota responsável pela devolução do cálculo do financiamento

SecurityoAuth2ClientCredentials

Request

Request Body schema:
application/json-patch+json

cpfCnpj required	string
birthdate required	string
uf required	string
requestedAmount required	number <double>
monthlyIncome required	number <double>
homogeneousGroup required	number <double>
clinicCode	string or null
isRebate	boolean

Responses

200

Return financing calculation

400

Unable to return financing calculation due to validation error

post/api/v2/financingCdc/financing-calculation

Request samples

Payload

{"cpfCnpj": "string",
"birthdate": "string",
"uf": "string",
"requestedAmount": 0,
"monthlyIncome": 0,
"homogeneousGroup": 0,
"clinicCode": "string",
"isRebate": true
}

Response samples

200
400

application/json

{"requestedAmount": 0,
"monthlyIncome": 0,
"clinicName": "string",
"clinicCode": "string",
"firstInstallmentDate": "string",
"simulations": [{"productionCode": "string",
"productionCodeId": 0,
"isRebate": true,
"installments": [{"installments": 0,
"minimumIncome": 0,
"coefficient": 0,
"interest": 0,
"cet": 0,
"monthlyInstallmentValue": 0,
"clientTotalCost": 0,
"clinicRetention": 0,
"tacValue": 0,
"bvRetention": 0,
"annulCet": 0,
"annualInterest": 0,
"netFee": 0,
"firstInstallmentFee": 0,
"releasedValue": 0,
"financingValue": 0,
"iofValue": 0,
"elegible": true,
"maxFinancingValue": 0,
"coefficientId": "string"
}
],
"notComputedInstallments": [{"installment": 0,
"elegible": true
}
],
"creditRestriction": true,
"installmentMaxValueAllowed": 0,
"maxNumberInstallmentsAllowed": 0
}
],
"simulationErrors": [{"productionCode": "string",
"error": "string"
}
],
"incomeCommitiment": 0,
"simulationRecordId": "string"
}

Rota responsável por cancelar uma proposta

SecurityoAuth2ClientCredentials

Request

path Parameters

proposalNumber required	integer <int32>
version required	string

Request Body schema:
application/json-patch+json

reason

string or null

Responses

200

Proposal Canceled

400

Unable to cancel proposal due to validation error

404

Proposal not found

post/api/v1/financingCdc/proposals/{proposalNumber}/cancel

Request samples

Payload

{"reason": "string"
}

Response samples

400

application/json

{"errors": [ ],
"httpStatus": 500
}

Rota responsável pela devolução do arquivo carnê

SecurityoAuth2ClientCredentials

Request

path Parameters

proposalNumber required	integer <int32>
version required	string

Responses

200

Return carne file

400

Não foi possível devolver o arquivo devido a erros

get/api/v1/financingCdc/proposals/{proposalNumber}/carne-file

Response samples

200
400

application/json

"string"

Rota responsável por consultar uma proposta

SecurityoAuth2ClientCredentials

Request

path Parameters

proposalNumber required	integer <int32>
version required	string

Responses

200

Return proposal status

400

Unable to consult proposal due to errors

get/api/v1/financingCdc/proposals/{proposalNumber}/proposal-inquiry

Response samples

200
400

application/json

{"success": true,
"message": "string",
"service": "string",
"external": {"statusCode": 100,
"service": "string",
"error": "string"
},
"statusProposta": {"codigoStatus": "string",
"descricaoStatus": "string",
"dataHoraAtualizacao": "string"
},
"listaDocumento": [{"nomeDocumento": "string",
"codigoDocumento": 0,
"descricaoStatus": "string"
}
]
}

Simulate financing

Este endpoint recebe dados do cliente para simular um financiamento e retorna as opções de parcelamento disponíveis ou uma descrição do erro

SecurityoAuth2ClientCredentials

Request

Request Body schema:
application/json-patch+json; api-version=1.0

Dados necessários do cliente para fazer a simulação

cpf	string or null
cnpj	string or null
clinicCode	string or null
uf	string or null
requestedAmount	number <double>
withoutFee	boolean
birthdate	string <date-time>

Responses

200

Success

400

Bad Request

post/api/v1/financingCdc/financing-simulations

Request samples

Payload

{"cpf": "string",
"cnpj": "string",
"clinicCode": "string",
"uf": "string",
"requestedAmount": 0,
"withoutFee": true,
"birthdate": "2019-08-24T14:15:22Z"
}

Response samples

200
400

application/json

{"productionCodeId": 0,
"approved": true,
"maxValue": 0,
"homogeneousGroup": 0,
"installments": [{"installmentAmmount": 0,
"installmentValue": 0,
"clientCost": 0,
"clinicRetention": 0,
"bankRetention": 0,
"tacValue": 0,
"iofValue": 0,
"cet": 0,
"annualCet": 0,
"interest": 0,
"annualInterest": 0,
"releasedValue": 0
}
]
}

Rota responsável pelo retorno do link de formalização da proposta

SecurityoAuth2ClientCredentials

Request

path Parameters

solicitationId

required

integer <int32>

Responses

200

Return financing calculation

400

Não foi possível retornar o link de formalização da proposta devido a erro de validação

404

Solicitation not found

post/api/v1/financingCdc/eletronic-signature-link/{solicitationId}

Response samples

200
400

application/json

{"success": true,
"message": "string",
"service": "string",
"external": {"statusCode": 100,
"service": "string",
"error": "string"
},
"link": "string"
}

FinancingCdc

Rota responsável por analisar as condições da proposta

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

Rota responsável por retornar dados básicos favorecidos da proposta

path Parameters

Rota responsável pela devolução dos favorecidos da proposta

path Parameters

Rota responsável pelo cadastro de favorecidos à proposta

path Parameters

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

Rota responsável pela devolução do cálculo do financiamento

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

Rota responsável por cancelar uma proposta

path Parameters

Request Body schema: application/json-patch+jsonapplication/jsontext/jsonapplication/*+jsonapplication/json-patch+json

Rota responsável pela devolução do arquivo carnê

path Parameters

Rota responsável por consultar uma proposta

path Parameters

Simulate financing

Request Body schema: application/json-patch+json; api-version=1.0application/json; api-version=1.0text/json; api-version=1.0application/*+json; api-version=1.0application/json-patch+json; api-version=1.0

Rota responsável pelo retorno do link de formalização da proposta

path Parameters

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json

Request Body schema:
application/json-patch+json; api-version=1.0