[All schemas](/reference/schemas/) · [API reference](/reference/) · [Data mapping guide](/guides/data-model/)

## Fields

| Field | Required | Type / allowed values |
| --- | --- | --- |
| `invoice` | Yes | object or null |
| `patients` | Yes | array |
| `rips` | Yes | object or null |
| `availableResolutions` | Yes | array |
| `canCreateDebitNote` | Yes | boolean |
| `validationMessage` | Yes | string or null |

## JSON definition

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

```json
{
  "type": "object",
  "properties": {
    "invoice": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "id": {
          "type": "string"
        },
        "invoiceNumber": {
          "type": [
            "string",
            "null"
          ]
        },
        "cufe": {
          "type": [
            "string",
            "null"
          ]
        },
        "issueDate": {
          "type": "string",
          "description": "Fecha y hora ISO 8601 (UTC).",
          "example": "2026-10-15T12:00:00.000Z"
        },
        "totalAmount": {
          "type": "number"
        },
        "clientName": {
          "type": "string"
        },
        "clientId": {
          "type": "string"
        },
        "locationId": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "id",
        "invoiceNumber",
        "cufe",
        "issueDate",
        "totalAmount",
        "clientName",
        "clientId",
        "locationId"
      ]
    },
    "patients": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "consecutivo": {
            "type": "number"
          },
          "tipoDocumentoIdentificacion": {
            "type": "string"
          },
          "numDocumentoIdentificacion": {
            "type": "string"
          },
          "patientName": {
            "type": [
              "string",
              "null"
            ]
          },
          "totalAmount": {
            "type": "number"
          },
          "services": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "category": {
                  "type": "string"
                },
                "consecutivo": {
                  "type": "number"
                },
                "description": {
                  "type": "string"
                },
                "amount": {
                  "type": "number"
                },
                "serviceDate": {
                  "type": [
                    "string",
                    "null"
                  ]
                }
              },
              "required": [
                "category",
                "consecutivo",
                "description",
                "amount",
                "serviceDate"
              ]
            }
          }
        },
        "required": [
          "consecutivo",
          "tipoDocumentoIdentificacion",
          "numDocumentoIdentificacion",
          "patientName",
          "totalAmount",
          "services"
        ]
      }
    },
    "rips": {
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "numDocumentoIdObligado": {
          "type": [
            "string",
            "null"
          ],
          "description": "Opcional en borrador. Su presencia, formato y condiciones para envío se verifican al validar la revisión."
        },
        "numFactura": {
          "type": [
            "string",
            "null"
          ],
          "description": "Opcional en borrador. Su presencia, formato y condiciones para envío se verifican al validar la revisión."
        },
        "tipoNota": {
          "type": [
            "string",
            "null"
          ],
          "description": "Opcional en borrador. Su presencia, formato y condiciones para envío se verifican al validar la revisión."
        },
        "numNota": {
          "type": [
            "string",
            "null"
          ],
          "description": "Opcional en borrador. Su presencia, formato y condiciones para envío se verifican al validar la revisión."
        },
        "usuarios": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/components/schemas/DraftUsuarioDTO"
          },
          "description": "Opcional en borrador. Su presencia, formato y condiciones para envío se verifican al validar la revisión."
        }
      },
      "additionalProperties": {},
      "description": "Demografía autorizada de los pacientes de la factura, con todas las listas de servicios vacías. Seleccione los pacientes y agregue los servicios adicionales. null impide preparar una nota con origen RIPS verificado."
    },
    "availableResolutions": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/Resolution"
      }
    },
    "canCreateDebitNote": {
      "type": "boolean"
    },
    "validationMessage": {
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "invoice",
    "patients",
    "rips",
    "availableResolutions",
    "canCreateDebitNote",
    "validationMessage"
  ],
  "description": "Factura aceptada, pacientes originales y resoluciones para una nota débito. Los servicios se muestran como referencia, no se copian: capture los servicios adicionales en rips. No aplica el saldo de notas crédito."
}
```
