← HomeFleetPay / Schema

CreateComplementaryCteInput

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.

Values to add in the complementary CT-e (tpCTe = 1). Provide valor_frete > 0 (proportional ICMS is calculated by the current tax rule of the route) or valor_frete = 0 with a positive value in icms.v_icms / icms.v_icms_st_ret for tax-only complement.

valor_fretenumber | nullOptional

Freight value to add (vTPrest). Cannot be negative.

minimum0
maximum999999.99
valor_recebernumber | nullOptional

Complementary receivable value (vRec). If omitted, defaults to valor_frete.

minimum0
maximum999999.99
componentesarray | nullOptional
maxItems20
icmsobject | nullOptional

Transactional ICMS fields for pure tax complement or CST 60/90.

natureza_operacaostring | nullOptional

Defaults to COMPLEMENTO DE VALORES DE TRANSPORTE.

maxLength60
observacoesstring | nullOptional

Free-form notes text; the mandatory payment notice is automatically kept.

maxLength2000
emitirboolean | nullOptional

When true, reserves and immediately initiates issuance with the fiscal provider (202).

Original JSON Definition (Portuguese Descriptions)
{
  "type": "object",
  "description": "Valores a acrescentar no CT-e complementar (`tpCTe = 1`). Informe `valor_frete > 0` (o ICMS\nproporcional é calculado pela regra tributária vigente da rota) ou `valor_frete = 0` com\nvalor positivo em `icms.v_icms` / `icms.v_icms_st_ret` para complemento exclusivo de imposto.\n",
  "properties": {
    "valor_frete": {
      "type": [
        "number",
        "null"
      ],
      "minimum": 0,
      "maximum": 999999.99,
      "description": "Valor do frete a acrescentar (`vTPrest`). Não pode ser negativo."
    },
    "valor_receber": {
      "type": [
        "number",
        "null"
      ],
      "minimum": 0,
      "maximum": 999999.99,
      "description": "Valor a receber complementar (`vRec`). Ausente, assume `valor_frete`."
    },
    "componentes": {
      "type": [
        "array",
        "null"
      ],
      "maxItems": 20,
      "items": {
        "type": "object",
        "required": [
          "nome",
          "valor"
        ],
        "properties": {
          "nome": {
            "type": "string",
            "maxLength": 15
          },
          "valor": {
            "type": "number",
            "minimum": 0
          }
        }
      }
    },
    "icms": {
      "type": [
        "object",
        "null"
      ],
      "description": "Campos transacionais de ICMS para complemento puro de imposto ou CST 60/90.",
      "properties": {
        "v_bc": {
          "type": [
            "number",
            "null"
          ],
          "minimum": 0
        },
        "p_icms": {
          "type": [
            "number",
            "null"
          ],
          "minimum": 0,
          "maximum": 100
        },
        "v_icms": {
          "type": [
            "number",
            "null"
          ],
          "minimum": 0
        },
        "v_bc_st_ret": {
          "type": [
            "number",
            "null"
          ],
          "minimum": 0
        },
        "v_icms_st_ret": {
          "type": [
            "number",
            "null"
          ],
          "minimum": 0
        },
        "p_icms_st_ret": {
          "type": [
            "number",
            "null"
          ],
          "minimum": 0,
          "maximum": 100
        },
        "v_cred": {
          "type": [
            "number",
            "null"
          ],
          "minimum": 0
        }
      }
    },
    "natureza_operacao": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 60,
      "description": "Padrão `COMPLEMENTO DE VALORES DE TRANSPORTE`."
    },
    "observacoes": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 2000,
      "description": "Texto livre de observações; o aviso obrigatório de pagamento é mantido automaticamente."
    },
    "emitir": {
      "type": [
        "boolean",
        "null"
      ],
      "default": false,
      "description": "Quando `true`, reserva e inicia imediatamente a emissão junto ao provedor fiscal (`202`)."
    }
  }
}