← HomeFleetPay / Schema

ContraCteTomadorResolvido

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.

The payer (tomador) with which the key/leg was issued, resolved on the request and frozen on the row: what the CT-e prints, without internal id. null = no payer chosen: the payer is the issuer of the source CT-e, as always (also on rows of batches created before this field).

cnpjstringOptional
iestring | nullOptional

The printed state tax registration, ISENTO, or null (non-taxpayer).

ind_ie_tomaintegerOptional

The CT-e indIEToma — official layout code, not the numbering starting at 1 of this API: 1 ICMS taxpayer, 2 taxpayer exempt from registration, 9 non-taxpayer.

1 · 2 · 9
nomestringOptional
logradourostringOptional
numerostringOptional
complementostring | nullOptional
bairrostringOptional
codigo_municipiostringOptional
municipiostringOptional
ufstringOptional
cepstringOptional
fontestringOptional

cadastro = completed from company registry (only cnpj in request); pedido = full details provided.

"cadastro" · "pedido"
Original JSON Definition (Portuguese Descriptions)
{
  "type": [
    "object",
    "null"
  ],
  "description": "O tomador com que a chave/perna saiu, resolvido no pedido e congelado na linha: o que o CT-e\nimprime, sem id interno. `null` = nenhum tomador escolhido: o tomador é o emitente do CT-e de\norigem, como sempre (também na linha de um lote criado antes deste campo).\n",
  "properties": {
    "cnpj": {
      "type": "string"
    },
    "ie": {
      "type": [
        "string",
        "null"
      ],
      "description": "A inscrição estadual impressa, `ISENTO`, ou `null` (não contribuinte)."
    },
    "ind_ie_toma": {
      "type": "integer",
      "enum": [
        1,
        2,
        9
      ],
      "description": "O `indIEToma` do CT-e — código oficial do leiaute, não a numeração a partir de `1` desta\nAPI: `1` contribuinte do ICMS, `2` contribuinte isento de inscrição, `9` não contribuinte.\n"
    },
    "nome": {
      "type": "string"
    },
    "logradouro": {
      "type": "string"
    },
    "numero": {
      "type": "string"
    },
    "complemento": {
      "type": [
        "string",
        "null"
      ]
    },
    "bairro": {
      "type": "string"
    },
    "codigo_municipio": {
      "type": "string"
    },
    "municipio": {
      "type": "string"
    },
    "uf": {
      "type": "string"
    },
    "cep": {
      "type": "string"
    },
    "fonte": {
      "type": "string",
      "enum": [
        "cadastro",
        "pedido"
      ],
      "description": "`cadastro` = completado pelo cadastro da empresa (só o `cnpj` no pedido); `pedido` = os\ndados completos informados.\n"
    }
  }
}