Pular para o conteúdo
MyClinicAPI Docs
PATCH

/v1/fiscal/candidates/{id}

Revisar candidato (tomador, valor, confirmação)

Completa o que falta com a procedência "revisão": nome, CPF (validado; nunca de outra pessoa), endereço estruturado e valor. Não altera o cadastro do paciente. Bloqueado com o candidato em lote ou com nota no modo atual.

Permissão:fiscal:emit

Autenticação

Envie o token de acesso do usuário no cabeçalho Authorization e, se ele tiver mais de uma clínica, o X-Clinic-Id. Integrações servidor a servidor usam o token de serviço com X-Clinic-Id e X-Agent-Key. Como autenticar

Authorization: Bearer <TOKEN>X-Clinic-Id: <clinic_id>

Parâmetros

Parâmetros de caminho

  • idstringObrigatório

    Id do recurso. · Entre 1 e 64 caracteres · Padrão (regex): ^[A-Za-z0-9._-]+$

Cabeçalhos

  • X-Clinic-IdstringOpcional

    Clínica ativa. Obrigatório só para quem tem acesso a mais de uma clínica (ou token de serviço). Validado contra o vínculo do usuário. · Padrão (regex): ^[A-Za-z0-9._-]{1,64}$

Corpo da requisição

application/json · obrigatório

  • takerobjectOpcional
  • namestringOpcional
    taker.name

    Entre 2 e 128 caracteres

  • cpfstring | nullOpcional
    taker.cpf

    Write-only: nunca é devolvido completo. · Padrão (regex): ^\d{3}\.?\d{3}\.?\d{3}-?\d{2}$

  • addressobject | nullOpcional
    taker.address
  • streetstringObrigatório
    taker.address.street

    Entre 2 e 160 caracteres

  • numberstringObrigatório
    taker.address.number

    Entre 1 e 20 caracteres

  • complementstring | nullOpcional
    taker.address.complement

    Até 60 caracteres

  • districtstringObrigatório
    taker.address.district

    Entre 2 e 80 caracteres

  • zipstringObrigatório
    taker.address.zip

    Padrão (regex): ^\d{5}-?\d{3}$

  • cityIbgestringObrigatório
    taker.address.cityIbge

    Padrão (regex): ^\d{7}$

  • cityNamestring | nullOpcional
    taker.address.cityName

    Até 80 caracteres

  • ufstringObrigatório
    taker.address.uf

    Padrão (regex): ^[A-Z]{2}$

  • amountnumberOpcional

    Valor da nota em reais (procedência: revisão). · Maior que 0 · Máximo 1000000

  • confirmAmountbooleanOpcional

    Confirma o valor vindo da tabela do serviço.

  • acknowledgeReviewbooleanOpcional

    Confirma a revisão depois de nota rejeitada ou cancelada.

Exemplo de requisição

Gerado do contrato. Troque os marcadores entre < > pelos seus valores.

const res = await fetch("https://myclinc.leadpoint.com.br/v1/fiscal/candidates/<id>", {  method: "PATCH",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",    "Content-Type": "application/json",  },  body: JSON.stringify({    "taker": {      "name": "<name>",      "cpf": "<cpf>",      "address": {        "street": "<street>",        "number": "<number>",        "district": "<district>",        "zip": "<zip>",        "cityIbge": "<cityIbge>",        "uf": "<uf>"      }    },    "amount": 1,    "confirmAmount": true,    "acknowledgeReview": true  }),})​if (!res.ok) {  const { error } = await res.json()  throw new Error(`${error.code}: ${error.message} (${error.requestId})`)}const { data } = await res.json()

Resposta

200OK — Sucesso.
JSON
{  "data": {    "id": "<id>",    "source": "atendimento",    "sourceId": "<sourceId>",    "appointmentId": "<appointmentId>",    "transactionId": "<transactionId>",    "patientId": "<patientId>",    "serviceKey": "<serviceKey>",    "serviceName": "<serviceName>",    "serviceDate": "<serviceDate>",    "amount": 1,    "amountSource": "<amountSource>",    "amountConfirmed": true,    "taker": {      "name": "<name>",      "nameSource": "<nameSource>",      "cpfMasked": "<cpfMasked>",      "cpfSource": "<cpfSource>",      "address": {        "street": "<street>",        "number": "<number>",        "complement": "<complement>",        "district": "<district>",        "zip": "<zip>",        "cityIbge": "<cityIbge>",        "cityName": "<cityName>",        "uf": "<uf>"      },      "addressSource": "<addressSource>"    },    "status": "pendente",    "reviewStatus": "<reviewStatus>",    "issues": [      {        "code": "<code>",        "message": "<message>",        "field": "<field>",        "blocks": [          "simulacao"        ],        "blocksCurrentMode": true      }    ],    "ignoredReason": "<ignoredReason>",    "reviewedAt": "<reviewedAt>",    "batchId": "<batchId>",    "documentId": "<documentId>",    "documentStatus": "reservada",    "documents": {      "simulacao": "<simulacao>",      "homologacao": "<homologacao>",      "producao": "<producao>"    },    "capturedAt": "<capturedAt>",    "rawHash": "<rawHash>"  }}

Exemplo gerado do esquema da resposta; valores entre < > são ilustrativos.

Códigos de erro

Corpo no formato padrão { error: { code, message, requestId } }. Veja todos os códigos.

400

Bad Request — Requisição malformada (JSON inválido, cursor inválido ou clínica ativa não informada).

401

Unauthorized — Token ausente, inválido ou expirado.

403

Forbidden — Autenticado, mas sem permissão (perfil ou clínica).

404

Not Found — Recurso não encontrado na clínica ativa.

409

Conflict — Conflito de estado (duplicidade, transição inválida, conflito de agenda).

422

Unprocessable Entity — Dados semanticamente inválidos (erros por campo em details).

429

Too Many Requests — Limite de requisições excedido (veja Retry-After).

500

Internal Server Error — Erro interno (sem detalhes expostos).

503

Service Unavailable — Banco de dados indisponível ou não configurado.

Limites

Limite padrão: 120 requisições a cada 60 segundos por token. Sobre limites

Testar no Swagger(abre em nova aba)