← InicioFleetPay / Schema

FiscalTaxRule

Estructura preservada del contrato versionado de la API.

Las descripciones técnicas se traducen del contrato versionado. Se conservan los identificadores y el JSON originales; se omiten los ejemplos de datos.

idintegerObligatorio

Identificador entero de la regla; es el que recibe DELETE.

minimum1
origin_statestring | nullObligatorio

Estado de origen; null significa cualquier origen (comodín).

minLength2
maxLength2
destination_statestring | nullObligatorio

Estado de destino; null significa cualquier destino (comodín).

minLength2
maxLength2
tp_servinteger | nullObligatorio

Tipo de servicio (ide/tpServ) al que se aplica la regla; null significa cualquier tipo.

0 · 1 · 2 · 3 · null
tp_serv_rotulostring | nullObligatorio

Etiqueta legible del tipo de servicio; por ejemplo, Subcontratação. Es null cuando la regla se aplica a cualquier tipo. Solo lectura: aparece en GET y en la respuesta 201 de POST; no se acepta en el envío.

cfopstring | nullObligatorio

CFOP sugerido al completar el borrador.

pattern"^\\d{4}$"
icms_variante_rotulostringObligatorio

Etiqueta legible de la variante de ICMS; por ejemplo, Tributação normal do ICMS (CST 00). Solo lectura: aparece en GET y en la respuesta 201 de POST; no se acepta en el envío.

cststringObligatorio

CST efectivo de la regla, derivado de la variante; el cliente solo lo informa en ICMS45.

minLength2
maxLength2
aliquotanumber | null · doubleObligatorio

Porcentaje de ICMS.

minimum0
maximum100
p_red_bcnumber | null · doubleObligatorio

Reducción porcentual de la base imponible del ICMS.

minimum0
maximum100
ibs_cbs_cststring | nullObligatorio

CST de IBS/CBS, con 3 dígitos; por ejemplo, 000, tributación íntegra. Utiliza el vocabulario propio de la Reforma Tributaria: no es el cst de ICMS, que tiene 2 dígitos, y ninguno se deriva del otro.

pattern"^\\d{3}$"
ibs_cbs_class_tribstring | nullObligatorio

Clasificación tributaria de IBS/CBS, con 6 dígitos — p. ej. 000001.

pattern"^\\d{6}$"
ibs_uf_aliquotanumber | null · doubleObligatorio

Tasa estatal de IBS, en porcentaje, con hasta 4 decimales.

minimum0
maximum100
ibs_mun_aliquotanumber | null · doubleObligatorio

Tasa municipal de IBS, en porcentaje, con hasta 4 decimales.

minimum0
maximum100
cbs_aliquotanumber | null · doubleObligatorio

Tasa de CBS, en porcentaje, con hasta 4 decimales.

minimum0
maximum100
ibs_cbs_p_red_bcnumber | null · doubleObligatorio

Reducción porcentual de la base imponible de IBS/CBS, con hasta 4 decimales. Se aplica antes de las alícuotas.

minimum0
maximum100
valid_fromstring | null · dateObligatorio
valid_untilstring | null · dateObligatorio
notesstring | nullObligatorio
maxLength255
Definición JSON Original (Descripciones en Portugués)
{
  "type": "object",
  "required": [
    "id",
    "origin_state",
    "destination_state",
    "tp_serv",
    "tp_serv_rotulo",
    "cfop",
    "icms_variante",
    "icms_variante_rotulo",
    "cst",
    "aliquota",
    "p_red_bc",
    "ibs_cbs_cst",
    "ibs_cbs_class_trib",
    "ibs_uf_aliquota",
    "ibs_mun_aliquota",
    "cbs_aliquota",
    "ibs_cbs_p_red_bc",
    "valid_from",
    "valid_until",
    "notes"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "minimum": 1,
      "description": "ID inteiro da regra; é ele que o `DELETE` recebe."
    },
    "origin_state": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 2,
      "maxLength": 2,
      "description": "UF de origem; `null` = qualquer origem (curinga)."
    },
    "destination_state": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 2,
      "maxLength": 2,
      "description": "UF de destino; `null` = qualquer destino (curinga)."
    },
    "tp_serv": {
      "type": [
        "integer",
        "null"
      ],
      "enum": [
        0,
        1,
        2,
        3,
        null
      ],
      "description": "Tipo de serviço (`ide/tpServ`) a que a regra se aplica; `null` = qualquer tipo."
    },
    "tp_serv_rotulo": {
      "type": [
        "string",
        "null"
      ],
      "description": "Rótulo legível do tipo de serviço — ex.: `Subcontratação`; `null` quando a regra vale\npara qualquer tipo. Somente leitura: aparece no `GET` e no `201` do `POST`, e não é\naceito no envio.\n"
    },
    "cfop": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^\\d{4}$",
      "description": "CFOP sugerido no preenchimento do rascunho."
    },
    "icms_variante": {
      "$ref": "#/components/schemas/FiscalTaxRuleIcmsVariant"
    },
    "icms_variante_rotulo": {
      "type": "string",
      "description": "Rótulo legível da variante de ICMS — ex.: `Tributação normal do ICMS (CST 00)`.\nSomente leitura: aparece no `GET` e no `201` do `POST`, e não é aceito no envio.\n"
    },
    "cst": {
      "type": "string",
      "minLength": 2,
      "maxLength": 2,
      "description": "CST efetivo da regra, derivado da variante — informado pelo cliente somente em `ICMS45`."
    },
    "aliquota": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "minimum": 0,
      "maximum": 100,
      "description": "Percentual do ICMS."
    },
    "p_red_bc": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "minimum": 0,
      "maximum": 100,
      "description": "Redução da base de cálculo do ICMS, em percentual."
    },
    "ibs_cbs_cst": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^\\d{3}$",
      "description": "CST de IBS/CBS, com 3 dígitos — ex.: `000`, tributação integral. Vocabulário próprio\nda Reforma Tributária: não é o `cst` do ICMS, que tem 2 dígitos, e um não deriva do\noutro.\n"
    },
    "ibs_cbs_class_trib": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^\\d{6}$",
      "description": "Classificação tributária de IBS/CBS, com 6 dígitos — ex.: `000001`.\n"
    },
    "ibs_uf_aliquota": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "minimum": 0,
      "maximum": 100,
      "description": "Alíquota do IBS estadual, em percentual, com até 4 casas decimais."
    },
    "ibs_mun_aliquota": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "minimum": 0,
      "maximum": 100,
      "description": "Alíquota do IBS municipal, em percentual, com até 4 casas decimais."
    },
    "cbs_aliquota": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "minimum": 0,
      "maximum": 100,
      "description": "Alíquota da CBS, em percentual, com até 4 casas decimais."
    },
    "ibs_cbs_p_red_bc": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "minimum": 0,
      "maximum": 100,
      "description": "Redução da base de cálculo de IBS/CBS, em percentual, com até 4 casas decimais.\nAplicada antes das alíquotas.\n"
    },
    "valid_from": {
      "type": [
        "string",
        "null"
      ],
      "format": "date"
    },
    "valid_until": {
      "type": [
        "string",
        "null"
      ],
      "format": "date"
    },
    "notes": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 255
    }
  }
}