Powered by Redocly

Clinic

Rota responsável pela atualização de uma clínica

SecurityoAuth2ClientCredentials
Request
path Parameters
clinicId
required
integer <int32>
version
required
string
Request Body schema:
tradingName
string or null
companyName
string or null
email
string or null
financeEmail
string or null
phoneNumber
string or null
cellPhoneNumber
string or null
monthlyPayment
number <double>
clinicTypeId
integer <int32>
Responses
200

update a clinic

400

Unable to update a clinic due to validation error

404

No clinic registered with this id in the system was found

put/api/v1/clinics/{clinicId}/clinic-partner
Request samples
{
  • "tradingName": "string",
  • "companyName": "string",
  • "email": "string",
  • "financeEmail": "string",
  • "phoneNumber": "string",
  • "cellPhoneNumber": "string",
  • "monthlyPayment": 0,
  • "clinicTypeId": 0
}
Response samples
application/json
{
  • "id": 1,
  • "tradingName": "Dentista Mais",
  • "companyName": "Dentista Mais",
  • "cnpj": "12.932.545/0001-15",
  • "email": "dentista@email.com",
  • "financeEmail": null,
  • "code": "DR15",
  • "phoneNumber": "(61) 3827-2938",
  • "operatingFee": 0
}

Rota responsável por devolver uma lista de todas as clínicas cadastradas no sistema

SecurityoAuth2ClientCredentials
Request
query Parameters
pageNumber
integer <int32>
pageSize
integer <int32>
orderBy
string or null
search
string or null
clinicCode
string or null
tradingName
string or null
networkId
integer or null <int32>
clinicTypeId
integer or null <int32>
productionCodeId
integer or null <int32>
city
string or null
state
string or null
advisorId
string or null
clinicFlagId
integer or null <int32>
clinicStatusTypeId
integer or null <int32>
newsClinic
boolean or null
Responses
200

A list of all clinics registered in the system

400

Unable to return a list of all clinics due to validation error

404

No clinics registered in the system was found

get/api/v1/clinics
Response samples
application/json
[
  • {
    }
]

Rota responsável por verificar se o cnpj de uma clínica existe ou não

SecurityoAuth2ClientCredentials
Request
path Parameters
version
required
string
Request Body schema:
cnpj
string or null
Responses
200

Retorna mensagem informando que o cnpj já existe

400

Erro ao verificar cnpj

404

cnpj não existe no banco de dados

post/api/v1/clinics/check-cnpj
Request samples
{
  • "cnpj": "string"
}
Response samples
application/json
{
  • "id": 0,
  • "cnpj": "string",
  • "exists": true
}

Rota responsável pelo registro dos Termos Aceitos da clínica para a clínica

SecurityoAuth2ClientCredentials
Request
path Parameters
cnpjOrCpf
required
string or null
version
required
string
Request Body schema:
Array
name
string or null
link
string or null
Responses
200

clínica registrada Termos aceitos

400

Não foi possível registrar a clínica. Termos aceitos para a clínica

404

Not Found

post/api/v1/clinics/cnpj-or-cpf/{cnpjOrCpf}/accepted-terms
Request samples
[
  • {
    }
]
Response samples
application/json
true

Rota responsável por cadastrar uma nova clínica em uma rede

SecurityoAuth2ClientCredentials
Request
path Parameters
networkId
required
integer <int32>
version
required
string
Request Body schema:
tradingName
required
string
companyName
required
string
cpfCnpj
required
string
email
required
string
financeEmail
required
string
phoneNumber
required
string
cellPhoneNumber
string or null
monthlyPayment
required
number <double>
clinicTypeId
required
integer <int32>
required
object (CreateAddressRequest)
required
object (CreateBankDataRequest)
Responses
200

Adicionar uma nova clínica

400

Não foi possível adicionar uma clínica devido a um erro de validação

404

Nenhuma rede cadastrada com este id no sistema foi encontrada

post/api/v1/networks/{networkId}/partner-clinic
Request samples
{
  • "tradingName": "Ortopedia Mais",
  • "companyName": "Ortopedia Mais",
  • "cpfCnpj": "12.456.378/0001-22",
  • "email": "dentista@email.com",
  • "financeEmail": "dentista@financeiro.com",
  • "phoneNumber": "(61) 3271-2847",
  • "cellPhoneNumber": "(61) 9 8164-2847",
  • "monthlyPayment": 100,
  • "clinicTypeId": 1,
  • "address": {
    },
  • "bankData": {
    }
}
Response samples
application/json
{
  • "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": {
    },
  • "address": {
    },
  • "bankData": {
    },
  • "clinicType": {
    },
  • "clinicFlag": null,
  • "clinicTier": null,
  • "clinicStatusType": null,
  • "clinicSubStatusType": null,
  • "hasRebate": false,
  • "minFinancingValue": 0,
  • "features": null,
  • "financedAmmount": 0,
  • "helperResponse": null,
  • "clinicBusinessPartner": null,
  • "clinicPaymentMonthlies": null,
  • "bvRegistrationStatusType": null,
  • "isRegressiveRate": false,
  • "contractSubmissionDate": null,
  • "membershipPaymentDate": null,
  • "activationDate": null,
  • "registrationSubmissionToBVDate": null,
  • "bvRegistrationProtocol": null,
  • "platformMonthlySubscription": 0,
  • "dosIssueInvoice": false,
  • "clinicResponsibleForIssuingInvoice": null,
  • "registrationAnalyst": null,
  • "drCashProduct": null,
  • "financingParameters": null
}

Rota responsável por retornar uma lista de tipos de clínicas

SecurityoAuth2ClientCredentials
Request
path Parameters
version
required
string
Responses
200

Uma lista de todos os tipos de clínicas cadastradas no sistema

400

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

404

Não foi encontrado nenhum tipo de clínica cadastrada no sistema

get/api/v1/clinics/types
Response samples
application/json
[
  • {
    }
]

Rota responsável por retornar tipos de status da clínica

SecurityoAuth2ClientCredentials
Request
path Parameters
version
required
string
query Parameters
currentStatus
integer <int32> (ClinicStatusTypesIds)
Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
Responses
200

New types of clinic status existing in the database

400

Bad Request

404

No types of clinic status found

get/api/v1/clinics/status
Response samples
application/json
"string"
➔ Next to Beneficiary