Pular para o conteúdo
MyClinicAPI Docs
PUT

/v1/fiscal/settings

Salvar dados do emissor e preferências fiscais

Alterar documento, regime, dados do emissor, série, numeração ou exigências do tomador anula a aprovação do contador (é preciso registrar de novo) e é proibido em Produção (409 leave_production_first: volte para Homologação antes). Nenhum certificado, senha ou token é aceito aqui.

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

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

  • documentTypestringOpcional

    Valores: pendente, nfse_nacional, nfse_municipal

  • taxRegimestringOpcional

    Valores: pendente, simples_nacional, mei, lucro_presumido, lucro_real, outro

  • triggerstringOpcional

    Valores: atendimento_realizado, pagamento_recebido

  • autoCandidatesbooleanOpcional
  • legalNamestring | nullOpcional

    Até 160 caracteres

  • tradeNamestring | nullOpcional

    Até 160 caracteres

  • cnpjstring | nullOpcional

    Padrão (regex): ^\d{2}\.?\d{3}\.?\d{3}/?\d{4}-?\d{2}$

  • municipalRegistrationstring | nullOpcional

    Até 32 caracteres

  • cityIbgestring | nullOpcional

    Código IBGE do município (7 dígitos). · Padrão (regex): ^\d{7}$

  • cityNamestring | nullOpcional

    Até 80 caracteres

  • ufstring | nullOpcional

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

  • addressStreetstring | nullOpcional

    Até 160 caracteres

  • addressNumberstring | nullOpcional

    Até 20 caracteres

  • addressDistrictstring | nullOpcional

    Até 80 caracteres

  • addressZipstring | nullOpcional

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

  • rpsSeriesstring | nullOpcional

    Série da DPS/RPS (Homologação e Produção). Simulação usa "SIM". · Padrão (regex): ^[A-Za-z0-9]{1,5}$

  • numberingStartHomologacaointeger | nullOpcional

    Mínimo 1

  • numberingStartProducaointeger | nullOpcional

    Próximo número de Produção (último usado no sistema anterior + 1). · Mínimo 1

  • takerRequiresCpfbooleanOpcional
  • takerRequiresAddressbooleanOpcional
  • accountantNamestring | nullOpcional

    Até 128 caracteres

  • accountantEmailstring (e-mail) | nullOpcional

    Até 160 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/settings", {  method: "PUT",  headers: {    Authorization: "Bearer <TOKEN>",    "X-Clinic-Id": "<clinic_id>",    "Content-Type": "application/json",  },  body: JSON.stringify({    "documentType": "pendente",    "taxRegime": "pendente",    "trigger": "atendimento_realizado",    "autoCandidates": true,    "legalName": "<legalName>",    "tradeName": "<tradeName>",    "cnpj": "11.222.333/0001-81",    "municipalRegistration": "<municipalRegistration>"  }),})​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": {    "persisted": true,    "version": 1,    "mode": "simulacao",    "modeLabel": "<modeLabel>",    "provider": {      "id": "<id>",      "label": "<label>",      "homologacaoConfigured": true,      "producaoConfigured": true,      "webhookConfigured": true    },    "productionServerEnabled": true,    "documentType": "pendente",    "taxRegime": "pendente",    "trigger": "atendimento_realizado",    "autoCandidates": true,    "emitter": {      "legalName": "<legalName>",      "tradeName": "<tradeName>",      "cnpj": "<cnpj>",      "municipalRegistration": "<municipalRegistration>",      "cityIbge": "<cityIbge>",      "cityName": "<cityName>",      "uf": "<uf>",      "addressStreet": "<addressStreet>",      "addressNumber": "<addressNumber>",      "addressDistrict": "<addressDistrict>",      "addressZip": "<addressZip>"    },    "rpsSeries": "<rpsSeries>",    "numberingStart": {      "homologacao": 1,      "producao": 1    },    "takerRequiresCpf": true,    "takerRequiresAddress": true,    "accountant": {      "name": "<name>",      "email": "<email>"    },    "approval": {      "byName": "<byName>",      "evidence": "<evidence>",      "at": "<at>",      "recordedBy": "<recordedBy>"    },    "gate": [      {        "item": "<item>",        "label": "<label>",        "attested": true,        "byName": "<byName>",        "at": "<at>",        "evidence": "<evidence>",        "validUntil": "<validUntil>"      }    ],    "suggestions": {      "legalName": "<legalName>",      "cnpj": "<cnpj>",      "cityName": "<cityName>",      "uf": "<uf>",      "addressStreet": "<addressStreet>",      "addressZip": "<addressZip>",      "addressDistrict": "<addressDistrict>"    },    "readiness": [      {        "key": "<key>",        "label": "<label>",        "state": "ok",        "blocks": [          "simulacao"        ],        "reason": "<reason>",        "action": "<action>"      }    ],    "modes": [      {        "mode": "simulacao",        "label": "<label>",        "available": true,        "blockers": [          {}        ]      }    ],    "phrases": {      "activateProduction": "<activateProduction>"    }  }}

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).

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)