← InícioFleetPay / Schema

ContraCteTomador

Estrutura preservada do contrato versionado da API.

Descrições técnicas preservadas do contrato versionado. Exemplos de dados foram omitidos da cópia pública.

Quem paga o frete do contra-CT-e (toma4), no lugar do emitente do CT-e da contratante. Duas formas, e só elas: só o cnpj — o resto vem do cadastro da empresa com esse CNPJ exato — ou todos os dados (cnpj, nome, logradouro, numero, bairro, codigo_municipio, municipio, uf, cep; complemento e ie opcionais). Mais que o cnpj e menos que todos os dados é recusado, com os campos que faltam. indIEToma sai da ie (com IE 1, ISENTO 2, sem ie 9) e não é aceito informado à parte. null ou ausente = não informado.

cnpjstringObrigatório

CNPJ do tomador (14 posições, com ou sem pontuação; o alfanumérico é aceito), com os dígitos verificadores conferidos.

nomestringOpcional

Razão social. Só na forma "todos os dados".

maxLength60
iestringOpcional

Inscrição estadual (de 2 a 14 dígitos; a pontuação é removida) ou ISENTO. Ausente = não contribuinte do ICMS (indIEToma 9). Só na forma "todos os dados".

maxLength14
logradourostringOpcional
maxLength120
numerostringOpcional

Use S/N quando o endereço não tem número.

maxLength20
complementostringOpcional
maxLength60
bairrostringOpcional
maxLength60
codigo_municipiostringOpcional

Código IBGE, 7 dígitos; precisa pertencer à uf.

pattern"^\\d{7}$"
municipiostringOpcional
maxLength60
ufstringOpcional
minLength2
maxLength2
cepstringOpcional

8 dígitos, com ou sem traço.

Definição JSON Completa
{
  "type": [
    "object",
    "null"
  ],
  "required": [
    "cnpj"
  ],
  "description": "Quem paga o frete do contra-CT-e (`toma4`), no lugar do emitente do CT-e da contratante. Duas\nformas, e só elas: só o `cnpj` — o resto vem do cadastro da empresa com esse CNPJ exato — ou\ntodos os dados (`cnpj`, `nome`, `logradouro`, `numero`, `bairro`, `codigo_municipio`,\n`municipio`, `uf`, `cep`; `complemento` e `ie` opcionais). Mais que o `cnpj` e menos que todos\nos dados é recusado, com os campos que faltam. `indIEToma` sai da `ie` (com IE `1`, `ISENTO`\n`2`, sem `ie` `9`) e não é aceito informado à parte. `null` ou ausente = não informado.\n",
  "properties": {
    "cnpj": {
      "type": "string",
      "description": "CNPJ do tomador (14 posições, com ou sem pontuação; o alfanumérico é aceito), com os dígitos verificadores conferidos."
    },
    "nome": {
      "type": "string",
      "maxLength": 60,
      "description": "Razão social. Só na forma \"todos os dados\"."
    },
    "ie": {
      "type": "string",
      "maxLength": 14,
      "description": "Inscrição estadual (de 2 a 14 dígitos; a pontuação é removida) ou `ISENTO`. Ausente = não\ncontribuinte do ICMS (`indIEToma` `9`). Só na forma \"todos os dados\".\n"
    },
    "logradouro": {
      "type": "string",
      "maxLength": 120
    },
    "numero": {
      "type": "string",
      "maxLength": 20,
      "description": "Use `S/N` quando o endereço não tem número."
    },
    "complemento": {
      "type": "string",
      "maxLength": 60
    },
    "bairro": {
      "type": "string",
      "maxLength": 60
    },
    "codigo_municipio": {
      "type": "string",
      "pattern": "^\\d{7}$",
      "description": "Código IBGE, 7 dígitos; precisa pertencer à `uf`."
    },
    "municipio": {
      "type": "string",
      "maxLength": 60
    },
    "uf": {
      "type": "string",
      "minLength": 2,
      "maxLength": 2
    },
    "cep": {
      "type": "string",
      "description": "8 dígitos, com ou sem traço."
    }
  }
}