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

## Fields

| Field | Required | Type / allowed values |
| --- | --- | --- |
| `id` | Yes | string |
| `clientId` | Yes | string |
| `clientName` | Yes | string |
| `locationId` | Yes | string or null |
| `totalAmount` | Yes | number |
| `creditedAmount` | Yes | number |
| `status` | Yes | [HealthDocumentStatus](/reference/schemas/health-document-status/) |
| `statusMessage` | Yes | string or null |
| `assignedInvoiceNumber` | Yes | string or null |
| `cufe` | Yes | string or null |
| `dianStatusCode` | Yes | string or null |
| `submittedByUserId` | Yes | string or null |
| `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.

```json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "clientId": {
      "type": "string"
    },
    "clientName": {
      "type": "string"
    },
    "locationId": {
      "type": [
        "string",
        "null"
      ]
    },
    "totalAmount": {
      "type": "number"
    },
    "creditedAmount": {
      "type": "number",
      "description": "Suma de notas crédito aceptadas o en curso."
    },
    "status": {
      "$ref": "#/components/schemas/HealthDocumentStatus"
    },
    "statusMessage": {
      "type": [
        "string",
        "null"
      ]
    },
    "assignedInvoiceNumber": {
      "type": [
        "string",
        "null"
      ]
    },
    "cufe": {
      "type": [
        "string",
        "null"
      ]
    },
    "dianStatusCode": {
      "type": [
        "string",
        "null"
      ]
    },
    "submittedByUserId": {
      "type": [
        "string",
        "null"
      ]
    },
    "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",
    "clientId",
    "clientName",
    "locationId",
    "totalAmount",
    "creditedAmount",
    "status",
    "statusMessage",
    "assignedInvoiceNumber",
    "cufe",
    "dianStatusCode",
    "submittedByUserId",
    "isActive",
    "createdAt",
    "updatedAt"
  ]
}
```