Schema: Client

All schemas · API reference · Data mapping guide

Fields

Field	Required	Type / allowed values
id	Yes	string
nit	Yes	string
verificationDigit	Yes	string or null
companyName	Yes	string
commercialName	Yes	string or null
displayName	Yes	string
taxRegime	Yes	string or null
economicActivityCode	Yes	string or null
address	Yes	string or null
departmentCode	Yes	string or null
municipalityCode	Yes	string or null
phoneNumber	Yes	string or null
email	Yes	string or null
typeOrganizationId	Yes	integer
typeDocumentIdentificationId	Yes	integer
isActive	Yes	boolean
createdAt	Yes	string
updatedAt	Yes	string

JSON definition

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

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "nit": {
      "type": "string"
    },
    "verificationDigit": {
      "type": [
        "string",
        "null"
      ]
    },
    "companyName": {
      "type": "string"
    },
    "commercialName": {
      "type": [
        "string",
        "null"
      ]
    },
    "displayName": {
      "type": "string"
    },
    "taxRegime": {
      "type": [
        "string",
        "null"
      ]
    },
    "economicActivityCode": {
      "type": [
        "string",
        "null"
      ]
    },
    "address": {
      "type": [
        "string",
        "null"
      ]
    },
    "departmentCode": {
      "type": [
        "string",
        "null"
      ]
    },
    "municipalityCode": {
      "type": [
        "string",
        "null"
      ]
    },
    "phoneNumber": {
      "type": [
        "string",
        "null"
      ]
    },
    "email": {
      "type": [
        "string",
        "null"
      ]
    },
    "typeOrganizationId": {
      "type": "integer"
    },
    "typeDocumentIdentificationId": {
      "type": "integer"
    },
    "isActive": {
      "type": "boolean"
    },
    "createdAt": {
      "type": "string",
      "description": "Fecha y hora ISO 8601 (UTC).",
      "example": "2026-10-15T12:00:00.000Z"
    },
    "updatedAt": {
      "type": "string",
      "description": "Fecha y hora ISO 8601 (UTC).",
      "example": "2026-10-15T12:00:00.000Z"
    }
  },
  "required": [
    "id",
    "nit",
    "verificationDigit",
    "companyName",
    "commercialName",
    "displayName",
    "taxRegime",
    "economicActivityCode",
    "address",
    "departmentCode",
    "municipalityCode",
    "phoneNumber",
    "email",
    "typeOrganizationId",
    "typeDocumentIdentificationId",
    "isActive",
    "createdAt",
    "updatedAt"
  ],
  "description": "Pagador o entidad responsable a quien se emite la factura de salud."
}