Schema: ClientInput

All schemas · API reference · Data mapping guide

Fields

Field	Required	Type / allowed values
nit	Yes	string
verificationDigit	No	string or null
companyName	Yes	string
commercialName	No	string or null
taxRegime	No	string or null
economicActivityCode	No	string or null
address	No	string or null
departmentCode	No	string or null
municipalityCode	No	string or null
phoneNumber	No	string or null
email	No	string or null
typeOrganizationId	No	integer
typeDocumentIdentificationId	No	integer

JSON definition

The JSON retains the source contract descriptions. Do not translate property names or enum values.

{
  "type": "object",
  "properties": {
    "nit": {
      "type": "string",
      "pattern": "^\\d{3,20}$",
      "description": "NIT sin dígito de verificación."
    },
    "verificationDigit": {
      "type": [
        "string",
        "null"
      ],
      "pattern": "^\\d$"
    },
    "companyName": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "commercialName": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 200
    },
    "taxRegime": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 40
    },
    "economicActivityCode": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 20
    },
    "address": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 300
    },
    "departmentCode": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 5
    },
    "municipalityCode": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 8
    },
    "phoneNumber": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 30
    },
    "email": {
      "type": [
        "string",
        "null"
      ],
      "maxLength": 254,
      "format": "email"
    },
    "typeOrganizationId": {
      "type": "integer",
      "minimum": 1,
      "maximum": 9
    },
    "typeDocumentIdentificationId": {
      "type": "integer",
      "minimum": 1,
      "maximum": 20
    }
  },
  "required": [
    "nit",
    "companyName"
  ],
  "additionalProperties": false,
  "description": "Entidad pagadora, distinta del paciente y del prestador. Ejemplo sintético.",
  "example": {
    "nit": "900123456",
    "companyName": "Entidad pagadora de ejemplo",
    "address": "Calle de ejemplo 1",
    "departmentCode": "11",
    "municipalityCode": "11001",
    "email": "pagador@example.invalid"
  }
}