← HomeFleetPay / Schema

NfeImportBatch

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.

idintegerRequired
file_namestringRequired
statusstringRequired
totalintegerRequired
minimum0
importedintegerRequired
minimum0
duplicatedintegerRequired
minimum0
failedintegerRequired
minimum0
created_atstring | null · date-timeRequired
Original JSON Definition (Portuguese Descriptions)
{
  "type": "object",
  "required": [
    "id",
    "file_name",
    "status",
    "total",
    "imported",
    "duplicated",
    "failed",
    "results",
    "created_at"
  ],
  "properties": {
    "id": {
      "type": "integer"
    },
    "file_name": {
      "type": "string"
    },
    "status": {
      "type": "string"
    },
    "total": {
      "type": "integer",
      "minimum": 0
    },
    "imported": {
      "type": "integer",
      "minimum": 0
    },
    "duplicated": {
      "type": "integer",
      "minimum": 0
    },
    "failed": {
      "type": "integer",
      "minimum": 0
    },
    "results": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/NfeImportResult"
      }
    },
    "created_at": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time"
    }
  }
}