{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/entur/json-schema/entur-page-company-response-schema.json",
  "title": "PageCompanyResponse",
  "description": "Paged content",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/entur-companies-api-openapi.yml#/components/schemas/PageCompanyResponse",
  "required": [
    "items",
    "totalItems",
    "totalPages"
  ],
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "description": "All items for this page",
      "items": {
        "$ref": "#/$defs/CompanyResponse"
      }
    },
    "totalItems": {
      "type": "integer",
      "description": "Total items which could be returned",
      "format": "int64"
    },
    "totalPages": {
      "type": "integer",
      "description": "Total number of pages",
      "format": "int64"
    }
  },
  "$defs": {
    "CompanyResponse": {
      "required": [
        "addressLine",
        "allowETickets",
        "allowLocalEmployees",
        "companyId",
        "employeeNoPrefix",
        "isDeleted",
        "name",
        "postalCode",
        "reportSeparator"
      ],
      "type": "object",
      "properties": {
        "companyId": {
          "type": "integer",
          "description": "The company ID",
          "format": "int64"
        },
        "name": {
          "type": "string",
          "description": "The company name"
        },
        "addressLine": {
          "type": "string",
          "description": "The company postal address"
        },
        "postalCode": {
          "type": "string",
          "description": "The company postal code"
        },
        "employeeNoPrefix": {
          "type": "string",
          "description": "A prefix to be prepended to all employee numbers connected to this company"
        },
        "allowLocalEmployees": {
          "type": "boolean",
          "description": "Whether local employees are allowed"
        },
        "allowETickets": {
          "type": "boolean",
          "description": "Whether the company allows the usage of e-tickets for its personnel tickets"
        },
        "isDeleted": {
          "type": "boolean",
          "description": "Whether the company is deleted"
        },
        "reportSeparator": {
          "type": "string",
          "description": "Which character to separate elements within tax report: ','(default) or ';'"
        },
        "deleted": {
          "type": "boolean",
          "writeOnly": true
        }
      },
      "description": "Companies are where employees are hired"
    }
  }
}