Schema: Dashboard

All schemas · API reference · Data mapping guide

Fields

Field	Required	Type / allowed values
financial	Yes	object
rips	Yes	object
recentDocuments	Yes	array

JSON definition

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

{
  "type": "object",
  "properties": {
    "financial": {
      "type": "object",
      "properties": {
        "totalInvoiced": {
          "type": "number"
        },
        "totalCredited": {
          "type": "number"
        },
        "totalDebited": {
          "type": "number"
        },
        "netRevenue": {
          "type": "number"
        },
        "invoiceCount": {
          "type": "integer"
        },
        "creditNoteCount": {
          "type": "integer"
        },
        "debitNoteCount": {
          "type": "integer"
        }
      },
      "required": [
        "totalInvoiced",
        "totalCredited",
        "totalDebited",
        "netRevenue",
        "invoiceCount",
        "creditNoteCount",
        "debitNoteCount"
      ]
    },
    "rips": {
      "type": "object",
      "properties": {
        "accepted": {
          "type": "integer"
        },
        "rejected": {
          "type": "integer"
        },
        "pending": {
          "type": "integer"
        },
        "unknown": {
          "type": "integer"
        }
      },
      "required": [
        "accepted",
        "rejected",
        "pending",
        "unknown"
      ]
    },
    "recentDocuments": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "date": {
            "type": "string",
            "description": "Fecha y hora ISO 8601 (UTC).",
            "example": "2026-10-15T12:00:00.000Z"
          },
          "documentType": {
            "type": "string",
            "enum": [
              "Invoice",
              "CreditNote",
              "DebitNote"
            ]
          },
          "number": {
            "type": "string"
          },
          "clientName": {
            "type": "string"
          },
          "totalAmount": {
            "type": "number"
          },
          "status": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "date",
          "documentType",
          "number",
          "clientName",
          "totalAmount",
          "status"
        ]
      }
    }
  },
  "required": [
    "financial",
    "rips",
    "recentDocuments"
  ],
  "description": "Resumen del mes en curso (UTC)."
}