Pular para o conteúdo
MyClinicAPI Docs
PATCH

/v1/fiscal/service-rules/{id}

Editar rascunho de regra

Só rascunho é editável. Regra aprovada é imutável: para corrigir, crie uma nova versão.

Permissão:fiscal:configure

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

  • descriptionstring | nullOpcional

    Discriminação do serviço na nota. · Até 1000 caracteres

  • nationalTaxCodestring | nullOpcional

    Código de tributação nacional (6 dígitos). · Padrão (regex): ^\d{6}$

  • lc116Itemstring | nullOpcional

    Padrão (regex): ^\d{1,2}\.\d{2}$

  • nbsCodestring | nullOpcional

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

  • municipalTaxCodestring | nullOpcional

    Até 20 caracteres

  • cnaestring | nullOpcional

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

  • issRatenumber | nullOpcional

    Alíquota em %. · Entre 0 e 100

  • issWithheldboolean | nullOpcional
  • issTaxationstring | nullOpcional

    Valores: tributavel, imune, exportacao, nao_incidencia

  • incidencestring | nullOpcional

    Valores: prestador, tomador

  • triggerstringOpcional

    Valores: padrao, atendimento_realizado, pagamento_recebido

  • notesstring | nullOpcional

    Até 1000 caracteres

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/service-rules/<id>", {  method: "PATCH",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",    "Content-Type": "application/json",  },  body: JSON.stringify({    "description": "<description>",    "nationalTaxCode": "<nationalTaxCode>",    "lc116Item": "04.08",    "nbsCode": "<nbsCode>",    "municipalTaxCode": "<municipalTaxCode>",    "cnae": "<cnae>",    "issRate": 1,    "issWithheld": 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>",    "serviceKey": "<serviceKey>",    "version": 1,    "status": "rascunho",    "description": "<description>",    "nationalTaxCode": "<nationalTaxCode>",    "lc116Item": "<lc116Item>",    "nbsCode": "<nbsCode>",    "municipalTaxCode": "<municipalTaxCode>",    "cnae": "<cnae>",    "issRate": 1,    "issWithheld": true,    "issTaxation": "tributavel",    "incidence": "prestador",    "trigger": "padrao",    "notes": "<notes>",    "validFrom": "<validFrom>",    "validTo": "<validTo>",    "approval": {      "byName": "<byName>",      "evidence": "<evidence>",      "at": "<at>",      "recordedBy": "<recordedBy>"    },    "missingFields": [      "<missingField>"    ],    "createdAt": "2026-09-18T14:00:00.000Z"  }}

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)