← HomeFleetPay / Schema

InboundCteParty

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.

documentstring | nullRequired

CNPJ or CPF, digits only.

namestring | nullRequired

state_registrationstring | nullOptional

citystring | nullRequired

city_codestring | nullOptional

Municipality's IBGE code.

statestring | nullRequired

Original JSON Definition (Portuguese Descriptions)

{
  "type": "object",
  "required": [
    "document",
    "name",
    "city",
    "state"
  ],
  "properties": {
    "document": {
      "type": [
        "string",
        "null"
      ],
      "description": "CNPJ ou CPF, somente dígitos."
    },
    "name": {
      "type": [
        "string",
        "null"
      ]
    },
    "state_registration": {
      "type": [
        "string",
        "null"
      ]
    },
    "city": {
      "type": [
        "string",
        "null"
      ]
    },
    "city_code": {
      "type": [
        "string",
        "null"
      ],
      "description": "Código IBGE do município."
    },
    "state": {
      "type": [
        "string",
        "null"
      ]
    }
  }
}