Scopes

All OAuth 2.0 clients and access tokens have a scope. The scope restricts the endpoints to which a client has access, and whether a client has read or write access to an endpoint. For example, if you want to access endpoints that contain reservation data, then your app must have the reservations.read access scope.

Following scopes are supported by apaleo:

{
  "scopes": [
    {
      "name": "api",
      "description": "Core API",
      "scopes": [
        {
          "name": "companies.read",
          "displayName": "Read companies"
        },
        {
          "name": "companies.manage",
          "displayName": "Modify companies"
        },
        {
          "name": "reports.read",
          "displayName": "Retrieve report data"
        },
        {
          "name": "logs.read",
          "displayName": "Read logs"
        },
        {
          "name": "invoices.manage",
          "displayName": "Mark invoices as paid"
        },
        {
          "name": "invoices.read",
          "displayName": "Retrieve invoices and preview invoices as data or PDF"
        },
        {
          "name": "folios.manage",
          "displayName": "Perform actions on folios"
        },
        {
          "name": "folios.read",
          "displayName": "Read folios, including charges and payments"
        },
        {
          "name": "account.manage",
          "displayName": "Update the current account"
        },
        {
          "name": "reservations.force-manage",
          "displayName": "Modify stay dates regardless of availability or restrictions"
        },
        {
          "name": "reservations.manage",
          "displayName": "Modify, check in/out, cancel reservations"
        },
        {
          "name": "reservations.read",
          "displayName": "Read reservations"
        },
        {
          "name": "availability.read",
          "displayName": "Retrieve availability information"
        },
        {
          "name": "offer-index.read",
          "displayName": "Request offer index"
        },
        {
          "name": "offers.read",
          "displayName": "Request offers"
        },
        {
          "name": "rateplans.read-corporate",
          "displayName": "Read corporate rate plans"
        },
        {
          "name": "rates.manage",
          "displayName": "Update rates and restrictions"
        },
        {
          "name": "rates.read",
          "displayName": "Read rates and restrictions"
        },
        {
          "name": "maintenances.manage",
          "displayName": "Change maintenance windows"
        },
        {
          "name": "maintenances.read",
          "displayName": "Read maintenance information"
        },
        {
          "name": "setup.read",
          "displayName": "This scope allows the app to read settings and configurations for the whole account and all properties, including reading units, unit groups, and rate plans."
        },
        {
          "name": "setup.manage",
          "displayName": "This scope allows the app to modify settings and configurations for the whole account and all properties, including creating, modifying and deleting units, unit groups, rate plans and properties."
        },
        {
          "name": "accounting.read",
          "displayName": "Read accounting details"
        },
        {
          "name": "operations.trigger-night-audit",
          "displayName": "Trigger night audit"
        },
        {
          "name": "operations.change-room-state",
          "displayName": "Change room state"
        },
        {
          "name": "availability.manage",
          "displayName": "This scope allows to modify the availability"
        }
      ]
    },
    {
      "name": "distribution",
      "description": "Distribution API",
      "scopes": [
        {
          "name": "distribution:subscriptions.manage",
          "displayName": "Manage ARI notification configuration"
        },
        {
          "name": "distribution:reservations.manage",
          "displayName": "Create and modify bookings and reservations"
        }
      ]
    },
    {
      "name": "identity_server",
      "description": "Identity API",
      "scopes": [
        {
          "name": "identity:account-users.read",
          "displayName": "Read users"
        },
        {
          "name": "identity:account-users.manage",
          "displayName": "Manage users"
        }
      ]
    },
    {
      "name": "notifications",
      "description": "Notifications API"
    },
    {
      "name": "integration",
      "description": "Integration API",
      "scopes": [
        {
          "name": "integration:ui-integrations.manage",
          "displayName": "Include apaleo One content"
        }
      ]
    },
    {
      "name": "rendering",
      "description": "Rendering API",
      "scopes": [
        {
          "name": "rendering:upload-logo",
          "displayName": "Upload invoice logo"
        },
        {
          "name": "rendering:manage-configuration",
          "displayName": "Manage invoice configuration settings"
        },
        {
          "name": "rendering:render-invoice",
          "displayName": "Render invoices"
        },
        {
          "name": "rendering:read-configuration",
          "displayName": "Read invoice configuration settings"
        }
      ]
    },
    {
      "name": "fiscalization",
      "description": "The Fiscalization API",
      "scopes": [
        {
          "name": "fiscalization:configuration.manage",
          "displayName": "Full access to fiscalization configuration"
        }
      ]
    },
    {
      "name": "fiscalization-austria",
      "description": "The Fiscalization Austria API",
      "scopes": [
        {
          "name": "fiscalization-austria:snapshots.get",
          "displayName": "Get snapshots"
        },
        {
          "name": "fiscalization-austria:configuration.manage",
          "displayName": "Full access to fiscalization configuration"
        },
        {
          "name": "fiscalization-austria:receipts.read",
          "displayName": "Read receipts"
        }
      ]
    }
  ]
}