← HomeFleetPay / Schema

DashboardData

Structure preserved from the versioned API contract.

Technical descriptions are translated from the versioned contract. Original identifiers and JSON are preserved; data examples are omitted.

reference_monthstringRequired

pattern"^\\d{4}-\\d{2}$"

nfeobjectRequired

cteobjectRequired

mdfeobjectRequired

Original JSON Definition (Portuguese Descriptions)

{
  "type": "object",
  "required": [
    "reference_month",
    "nfe",
    "cte",
    "mdfe"
  ],
  "properties": {
    "reference_month": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}$"
    },
    "nfe": {
      "type": "object",
      "required": [
        "available_for_cte"
      ],
      "properties": {
        "available_for_cte": {
          "type": "integer",
          "minimum": 0
        }
      }
    },
    "cte": {
      "type": "object",
      "required": [
        "draft",
        "waiting",
        "authorized",
        "rejected",
        "awaiting_mdfe"
      ],
      "properties": {
        "draft": {
          "type": "integer",
          "minimum": 0
        },
        "waiting": {
          "type": "integer",
          "minimum": 0
        },
        "authorized": {
          "type": "integer",
          "minimum": 0
        },
        "rejected": {
          "type": "integer",
          "minimum": 0
        },
        "awaiting_mdfe": {
          "type": "integer",
          "minimum": 0
        }
      }
    },
    "mdfe": {
      "type": "object",
      "required": [
        "authorized",
        "closed",
        "open"
      ],
      "properties": {
        "authorized": {
          "type": "integer",
          "minimum": 0
        },
        "closed": {
          "type": "integer",
          "minimum": 0
        },
        "open": {
          "type": "integer",
          "minimum": 0
        }
      }
    }
  }
}