← HomeFleetPay / Schema

CtePayerInput

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.

tipointegerRequired

0 sender, 3 recipient, 4 other.

0 · 3 · 4

documentostring | nullOptional

Required when tipo is 4.

maxLength14

iestring | nullOptional

maxLength20

nomestring | nullOptional

maxLength120

logradourostring | nullOptional

maxLength120

numerostring | nullOptional

maxLength20

complementostring | nullOptional

maxLength60

bairrostring | nullOptional

maxLength80

codigo_municipiostring | nullOptional

pattern"^\\d{7}$"

municipiostring | nullOptional

maxLength80

ufstring | nullOptional

minLength2

maxLength2

cepstring | nullOptional

pattern"^\\d{8}$"

emailstring | null · emailOptional

maxLength120

Original JSON Definition (Portuguese Descriptions)

{
  "type": "object",
  "required": [
    "tipo"
  ],
  "properties": {
    "tipo": {
      "type": "integer",
      "enum": [
        0,
        3,
        4
      ],
      "description": "0 remetente, 3 destinatário, 4 outros."
    },
    "documento": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 14,
      "description": "Obrigatório quando `tipo` for 4."
    },
    "ie": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 20
    },
    "nome": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 120
    },
    "logradouro": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 120
    },
    "numero": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 20
    },
    "complemento": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 60
    },
    "bairro": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 80
    },
    "codigo_municipio": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^\\d{7}$"
    },
    "municipio": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 80
    },
    "uf": {
      "type": [
        "string",
        "null"
      ],
      "minLength": 2,
      "maxLength": 2
    },
    "cep": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^\\d{8}$"
    },
    "email": {
      "type": [
        "string",
        "null"
      ],
      "format": "email",
      "maxLength": 120
    }
  }
}