Solicitation

Rota responsável por retornar uma lista de solicitações salva no sistema

SecurityoAuth2ClientCredentials

Request

query Parameters

pageNumber	integer <int32>
pageSize	integer <int32>
orderBy	string or null
search	string or null
clinicId	integer or null <int32>
statusId	integer or null <int32>
solicitationTypeId	integer or null <int32>
month	integer or null <int32>
dateStart	string or null <date-time>
dateEnd	string or null <date-time>
name	string or null
cpf	string or null

Responses

200

Uma lista de todas as solicitações registradas no sistema

400

Não foi possível retornar uma lista de todas as solicitações devido a um erro de validação

401

Unauthorized

404

Nenhuma solicitação cadastrada no sistema foi encontrada

get/api/v1/solicitations

Response samples

application/json

{"id": 1,
"requestedAmount": 5000,
"installmentOfRequestedAmount": 0,
"monthlyIncome": 1000,
"contractId": "1",
"isBeneficiaryInformed": true,
"numeroProtocolo": null,
"numeroProposta": null,
"tacValue": 0,
"paymentDoneDate": null,
"paymentRequestDate": null,
"isPaymentRequested": false,
"user": null,
"createdAt": "2023-08-01T14:46:43.3788822+01:00",
"clinic": {"id": 1,
"tradingName": "Dentista Mais",
"companyName": "Dentista Mais",
"cpfCnpj": "123.456.789-01",
"email": "dentista@email.com",
"financeEmail": null,
"code": "DR15",
"phoneNumber": "(61) 3827-2938",
"cellPhoneNumber": null,
"monthlyPayment": 0,
"isPrivacyPolicyAccepted": false,
"operatingFee": null,
"isActive": false,
"createdAt": "0001-01-01T00:00:00",
"network": {"id": "5",
"name": "Dentista Mais",
"totalClinics": 0,
"admin": null,
"advisor": null
},
"address": {"id": 1,
"country": "Brasil",
"zipCode": "12345-678",
"state": "MG",
"city": "Unaí",
"neighborhood": "Divineia",
"street": "Av. Governador valadares",
"number": "123",
"complement": "ap 9",
"latitude": 0,
"longitude": 0,
"distance": 0,
"propertyType": {"id": 3,
"type": "Financiado"
}
},
"bankData": {"id": 1,
"agency": "4289",
"account": "10853-3",
"digit": null,
"bank": {"id": 4,
"name": "Banco Itaú Unibanco S.A.",
"code": 341
}
},
"clinicType": {"id": 2,
"type": "Odontologia"
},
"clinicFlag": null,
"clinicTier": null,
"clinicStatusType": null,
"hasRebate": false,
"minFinancingValue": 0,
"features": null
},
"beneficiary": {"id": 1,
"name": "Paulo Gonçalves Ferreira ",
"cpf": "123.456.789-01",
"rg": "1234567",
"relationship": "Marido",
"phoneNumber": "(61) 3827-2938",
"address": {"id": 1,
"country": "Brasil",
"zipCode": "12345-678",
"state": "MG",
"city": "Unaí",
"neighborhood": "Divineia",
"street": "Av. Governador valadares",
"number": "123",
"complement": "ap 9",
"latitude": 0,
"longitude": 0,
"distance": 0,
"propertyType": {"id": 3,
"type": "Financiado"
}
}
},
"procedure": {"id": 1,
"name": null,
"procedureDate": "2023-08-01T14:46:43.3788852+01:00",
"isProcedureDone": true
},
"coefficient": {"id": 1,
"value": 0.123,
"interestPerMonth": 2.45,
"interestPerYear": 2.12,
"installments": 72,
"tecPerMonth": 0.11,
"tecPerYear": 0.11,
"productionCode": {"id": 3,
"code": "BVO2W",
"isRebate": false
}
},
"solicitationType": {"id": 3,
"type": "Empréstimo"
},
"serviceType": {"id": 3,
"type": "Equipamentos médicos"
},
"statusType": {"id": 7,
"type": "Concluído"
},
"cancelReason": null,
"cancellationDate": null,
"homogeneousGroup": 0,
"clinicRetention": 0,
"isRebate": false,
"requestToken": null,
"reasonStatusType": null,
"solicitationOrigin": null,
"productionCodeId": null,
"productionCode": null,
"installments": 0,
"simulationRecordId": null
}

Rota responsável pela devolução de uma solicitação feita por Id

SecurityoAuth2ClientCredentials

Request

path Parameters

solicitationId

required

integer <int32>

Responses

200

A list of all solicitations registered in the system

400

Unable to return a solicitation due to validation error

401

Unauthorized

404

No solicitation with this id registered in the system was found

get/api/v1/solicitations/{solicitationId}

Response samples

application/json

{"id": 1,
"requestedAmount": 5000,
"installmentOfRequestedAmount": 0,
"monthlyIncome": 1000,
"contractId": "1",
"isBeneficiaryInformed": true,
"numeroProtocolo": null,
"numeroProposta": null,
"tacValue": 0,
"paymentDoneDate": null,
"paymentRequestDate": null,
"isPaymentRequested": false,
"user": null,
"createdAt": "2023-08-01T14:46:43.3788822+01:00",
"clinic": {"id": 1,
"tradingName": "Dentista Mais",
"companyName": "Dentista Mais",
"cpfCnpj": "123.456.789-01",
"email": "dentista@email.com",
"financeEmail": null,
"code": "DR15",
"phoneNumber": "(61) 3827-2938",
"cellPhoneNumber": null,
"monthlyPayment": 0,
"isPrivacyPolicyAccepted": false,
"operatingFee": null,
"isActive": false,
"createdAt": "0001-01-01T00:00:00",
"network": {"id": "5",
"name": "Dentista Mais",
"totalClinics": 0,
"admin": null,
"advisor": null
},
"address": {"id": 1,
"country": "Brasil",
"zipCode": "12345-678",
"state": "MG",
"city": "Unaí",
"neighborhood": "Divineia",
"street": "Av. Governador valadares",
"number": "123",
"complement": "ap 9",
"latitude": 0,
"longitude": 0,
"distance": 0,
"propertyType": {"id": 3,
"type": "Financiado"
}
},
"bankData": {"id": 1,
"agency": "4289",
"account": "10853-3",
"digit": null,
"bank": {"id": 4,
"name": "Banco Itaú Unibanco S.A.",
"code": 341
}
},
"clinicType": {"id": 2,
"type": "Odontologia"
},
"clinicFlag": null,
"clinicTier": null,
"clinicStatusType": null,
"hasRebate": false,
"minFinancingValue": 0,
"features": null
},
"beneficiary": {"id": 1,
"name": "Paulo Gonçalves Ferreira ",
"cpf": "123.456.789-01",
"rg": "1234567",
"relationship": "Marido",
"phoneNumber": "(61) 3827-2938",
"address": {"id": 1,
"country": "Brasil",
"zipCode": "12345-678",
"state": "MG",
"city": "Unaí",
"neighborhood": "Divineia",
"street": "Av. Governador valadares",
"number": "123",
"complement": "ap 9",
"latitude": 0,
"longitude": 0,
"distance": 0,
"propertyType": {"id": 3,
"type": "Financiado"
}
}
},
"procedure": {"id": 1,
"name": null,
"procedureDate": "2023-08-01T14:46:43.3788852+01:00",
"isProcedureDone": true
},
"coefficient": {"id": 1,
"value": 0.123,
"interestPerMonth": 2.45,
"interestPerYear": 2.12,
"installments": 72,
"tecPerMonth": 0.11,
"tecPerYear": 0.11,
"productionCode": {"id": 3,
"code": "BVO2W",
"isRebate": false
}
},
"solicitationType": {"id": 3,
"type": "Empréstimo"
},
"serviceType": {"id": 3,
"type": "Equipamentos médicos"
},
"statusType": {"id": 7,
"type": "Concluído"
},
"cancelReason": null,
"cancellationDate": null,
"homogeneousGroup": 0,
"clinicRetention": 0,
"isRebate": false,
"requestToken": null,
"reasonStatusType": null,
"solicitationOrigin": null,
"productionCodeId": null,
"productionCode": null,
"installments": 0,
"simulationRecordId": null
}

Rota responsável por excluir uma solicitação

SecurityoAuth2ClientCredentials

Request

path Parameters

solicitationId required	integer <int32>
version required	string

Responses

200

Success

204

excluir uma solicitação

400

Não foi possível excluir uma solicitação devido a um erro de validação

delete/api/v1/solicitations/{solicitationId}

Response samples

application/json

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

Rota responsável por registrar uma solicitação feita por um cliente

SecurityoAuth2ClientCredentials

Request

path Parameters

userId required	string or null
version required	string

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

requestedAmount required	number <double>
installmentOfRequestedAmount required	number <double>
monthlyIncome required	number <double>
solicitationTypeId required	integer <int32>
serviceTypeId required	integer <int32>
productionCodeId required	integer <int32>
simulationRecordId required	string or null
installments required	integer <int32>
clinicId	integer <int32>
tacValue	number <double>
procedure	string or null
homogeneousGroup required	integer <int32>
clinicRetention	integer <int32>

Responses

200

Add a new solicitation registered in the system

400

Unable to add a solicitation due to validation error

401

Unauthorized

post/api/v1/users/{userId}/solicitations

Request samples

Payload

{"requestedAmount": "1500.00",
"installmentOfRequestedAmount": "70.00",
"monthlyIncome": "1000.00",
"solicitationTypeId": 2,
"serviceTypeId": 3,
"productionCodeId": null,
"simulationRecordId": null,
"installments": null,
"clinicId": 1,
"tacValue": 0,
"procedure": null,
"homogeneousGroup": 0,
"clinicRetention": 0
}

Response samples

application/json

{"id": 1,
"requestedAmount": 5000,
"installmentOfRequestedAmount": 0,
"monthlyIncome": 1000,
"contractId": "1",
"isBeneficiaryInformed": true,
"numeroProtocolo": null,
"numeroProposta": null,
"tacValue": 0,
"paymentDoneDate": null,
"paymentRequestDate": null,
"isPaymentRequested": false,
"user": null,
"createdAt": "2023-08-01T14:46:43.3915854+01:00",
"clinic": {"id": 1,
"tradingName": "Dentista Mais",
"companyName": "Dentista Mais",
"cpfCnpj": "123.456.789-01",
"email": "dentista@email.com",
"financeEmail": null,
"code": "DR15",
"phoneNumber": "(61) 3827-2938",
"cellPhoneNumber": null,
"monthlyPayment": 0,
"isPrivacyPolicyAccepted": false,
"operatingFee": null,
"isActive": false,
"createdAt": "0001-01-01T00:00:00",
"network": {"id": "5",
"name": "Dentista Mais",
"totalClinics": 0,
"admin": null,
"advisor": null
},
"address": {"id": 1,
"country": "Brasil",
"zipCode": "12345-678",
"state": "MG",
"city": "Unaí",
"neighborhood": "Divineia",
"street": "Av. Governador valadares",
"number": "123",
"complement": "ap 9",
"latitude": 0,
"longitude": 0,
"distance": 0,
"propertyType": {"id": 3,
"type": "Financiado"
}
},
"bankData": {"id": 1,
"agency": "4289",
"account": "10853-3",
"digit": null,
"bank": {"id": 4,
"name": "Banco Itaú Unibanco S.A.",
"code": 341
}
},
"clinicType": {"id": 2,
"type": "Odontologia"
},
"clinicFlag": null,
"clinicTier": null,
"clinicStatusType": null,
"hasRebate": false,
"minFinancingValue": 0,
"features": null
},
"beneficiary": {"id": 1,
"name": "Paulo Gonçalves Ferreira ",
"cpf": "123.456.789-01",
"rg": "1234567",
"relationship": "Marido",
"phoneNumber": "(61) 3827-2938",
"address": {"id": 1,
"country": "Brasil",
"zipCode": "12345-678",
"state": "MG",
"city": "Unaí",
"neighborhood": "Divineia",
"street": "Av. Governador valadares",
"number": "123",
"complement": "ap 9",
"latitude": 0,
"longitude": 0,
"distance": 0,
"propertyType": {"id": 3,
"type": "Financiado"
}
}
},
"procedure": {"id": 1,
"name": null,
"procedureDate": "2023-08-01T14:46:43.3915872+01:00",
"isProcedureDone": true
},
"coefficient": {"id": 1,
"value": 0.123,
"interestPerMonth": 2.45,
"interestPerYear": 2.12,
"installments": 72,
"tecPerMonth": 0.11,
"tecPerYear": 0.11,
"productionCode": {"id": 3,
"code": "BVO2W",
"isRebate": false
}
},
"solicitationType": {"id": 3,
"type": "Empréstimo"
},
"serviceType": {"id": 3,
"type": "Equipamentos médicos"
},
"statusType": {"id": 7,
"type": "Concluído"
},
"cancelReason": null,
"cancellationDate": null,
"homogeneousGroup": 0,
"clinicRetention": 0,
"isRebate": false,
"requestToken": null,
"reasonStatusType": null,
"solicitationOrigin": null,
"productionCodeId": null,
"productionCode": null,
"installments": 0,
"simulationRecordId": null
}

Rota responsável por retornar todos os tipos de solicitação

SecurityoAuth2ClientCredentials

Responses

200

Retornando uma lista de todos os tipos de solicitação

400

Não foi possível retornar uma lista de todos os tipos de solicitação devido a um erro de validação

401

Unauthorized

404

Nenhum tipo de solicitação cadastrado o sistema foi encontrado

get/api/v1/solicitations/solicitation-types

Response samples

application/json

[{"id": 0,
"type": "string"
}
]

Rota responsável por adicionar favorecido ao proponente

SecurityoAuth2ClientCredentials

Request

path Parameters

solicitationId required	integer <int32>
version required	string

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

Array

value	number <double>
cpfOrCnpj	string or null

Responses

200

Favorito adicionado com sucesso

400

Unable to add favored

404

Not Found

post/api/v1/solicitations/{solicitationId}/favored

Request samples

Payload

[{"value": 0,
"cpfOrCnpj": "string"
}
]

Response samples

application/json

true

Rota responsável por retornar todos os tipos de serviço

SecurityoAuth2ClientCredentials

Responses

200

Retornando uma lista de todos os tipos de serviço

400

Não foi possível retornar uma lista de todos os tipos de serviço devido a um erro de validação

401

Unauthorized

404

Nenhum tipo de serviço registrado o sistema foi encontrado

get/api/v1/solicitations/service-types

Response samples

application/json

[{"id": 0,
"type": "string"
}
]

Rota responsável pelo cancelamento de uma solicitação

SecurityoAuth2ClientCredentials

Request

path Parameters

solicitationId required	integer <int32> solicitation id
version required	string

Responses

200

Solicitação cancelada com sucesso

400

Não foi possível cancelar a solicitação

post/api/v1/solicitations/{solicitationId}/cancel

Response samples

application/json

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

Solicitation

Rota responsável por retornar uma lista de solicitações salva no sistema

query Parameters

Rota responsável pela devolução de uma solicitação feita por Id

path Parameters

Rota responsável por excluir uma solicitação

path Parameters

Rota responsável por registrar uma solicitação feita por um cliente

path Parameters

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 por retornar todos os tipos de solicitação

Rota responsável por adicionar favorecido ao proponente

path Parameters

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 por retornar todos os tipos de serviço

Rota responsável pelo cancelamento de uma solicitação

path Parameters

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

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