← HomeFleetPay / Schema

StatusData

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.

CompanySummary ↗Environment ↗

companyobjectRequired

CompanySummary ↗

environmentobjectRequired

Environment ↗

certificateobjectRequired

documentsobjectRequired

Original JSON Definition (Portuguese Descriptions)

{
  "type": "object",
  "required": [
    "company",
    "environment",
    "certificate",
    "documents"
  ],
  "properties": {
    "company": {
      "$ref": "#/components/schemas/CompanySummary"
    },
    "environment": {
      "$ref": "#/components/schemas/Environment"
    },
    "certificate": {
      "type": "object",
      "required": [
        "configured",
        "valid_until"
      ],
      "properties": {
        "configured": {
          "type": "boolean"
        },
        "valid_until": {
          "type": [
            "string",
            "null"
          ],
          "format": "date"
        }
      }
    },
    "documents": {
      "type": "object",
      "required": [
        "nfe",
        "cte",
        "ciot",
        "mdfe"
      ],
      "properties": {
        "nfe": {
          "type": "boolean"
        },
        "cte": {
          "type": "boolean"
        },
        "ciot": {
          "type": "boolean"
        },
        "mdfe": {
          "type": "boolean"
        }
      }
    }
  }
}