← HomeFleetPay / Schema

CteIcmsInput

Structure preserved from the versioned API contract.

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

Accepted for compatibility: variant, CST, tax base, rate and reduction are replaced by the route's tax rule. Only transactional values are read here: the withheld ST group (v_bc_st_ret, v_icms_st_ret, p_icms_st_ret, required when the rule is ICMS60) and the presumed credit (v_cred, optional for ICMS90).

variantestringOptional

"ICMS00" · "ICMS20" · "ICMS45" · "ICMS60" · "ICMS90" · "ICMSOutraUF" · "ICMSSN"

cststringOptional

minLength2

maxLength2

v_bcnumber | null · doubleOptional

minimum0

p_icmsnumber | null · doubleOptional

minimum0

maximum100

v_icmsnumber | null · doubleOptional

minimum0

p_red_bcnumber | null · doubleOptional

minimum0

maximum100

v_bc_st_retnumber | null · doubleOptional

minimum0

v_icms_st_retnumber | null · doubleOptional

minimum0

p_icms_st_retnumber | null · doubleOptional

minimum0

maximum100

v_crednumber | null · doubleOptional

minimum0

Original JSON Definition (Portuguese Descriptions)

{
  "type": "object",
  "description": "Aceito por compatibilidade: variante, CST, base, alíquota e redução são substituídos pela\nregra de tributação da rota. Só os valores transacionais são lidos daqui — o grupo de ST\nretido (`v_bc_st_ret`, `v_icms_st_ret`, `p_icms_st_ret`, obrigatório quando a regra é\n`ICMS60`) e o crédito presumido (`v_cred`, opcional em `ICMS90`).\n",
  "properties": {
    "variante": {
      "type": "string",
      "enum": [
        "ICMS00",
        "ICMS20",
        "ICMS45",
        "ICMS60",
        "ICMS90",
        "ICMSOutraUF",
        "ICMSSN"
      ]
    },
    "cst": {
      "type": "string",
      "minLength": 2,
      "maxLength": 2
    },
    "v_bc": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "minimum": 0
    },
    "p_icms": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "minimum": 0,
      "maximum": 100
    },
    "v_icms": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "minimum": 0
    },
    "p_red_bc": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "minimum": 0,
      "maximum": 100
    },
    "v_bc_st_ret": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "minimum": 0
    },
    "v_icms_st_ret": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "minimum": 0
    },
    "p_icms_st_ret": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "minimum": 0,
      "maximum": 100
    },
    "v_cred": {
      "type": [
        "number",
        "null"
      ],
      "format": "double",
      "minimum": 0
    }
  }
}