FirmExportResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/hackforddata-com/json-schema/hackforddata-com-firm-export-response-schema.json",
  "title": "FirmExportResponse",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/hackforddata-com-openapi.yml#/components/schemas/FirmExportResponse",
  "type": "object",
  "properties": {
    "delivery_id": {
      "type": [
        "string",
        "null"
      ],
      "format": "uuid"
    },
    "format": {
      "type": "string"
    },
    "count": {
      "type": "integer"
    },
    "exported_count": {
      "type": "integer"
    },
    "limit": {
      "type": "integer"
    },
    "fields": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "results": {
      "type": "array",
      "items": {
        "type": "object",
        "additionalProperties": {}
      }
    },
    "export_usage": {
      "$ref": "#/$defs/ExportUsage"
    }
  },
  "required": [
    "count",
    "export_usage",
    "exported_count",
    "fields",
    "format",
    "limit",
    "results"
  ],
  "$defs": {
    "ExportUsage": {
      "type": "object",
      "properties": {
        "credits_consumed": {
          "type": "integer"
        },
        "credits_remaining": {
          "type": "integer"
        },
        "quota": {
          "type": "integer"
        },
        "owner_type": {
          "$ref": "#/$defs/OwnerTypeEnum"
        },
        "resets_at": {
          "type": "string",
          "format": "date-time"
        }
      },
      "required": [
        "credits_consumed",
        "credits_remaining",
        "owner_type",
        "quota",
        "resets_at"
      ]
    },
    "OwnerTypeEnum": {
      "enum": [
        "individual",
        "organisation"
      ],
      "type": "string",
      "description": "* `individual` - individual\n* `organisation` - organisation"
    }
  }
}