APapaleo
Routing

Get all routings.

<br>You must have at least one of these scopes: 'routings.read, setup.read, setup.manage'.<br>For fine-grained clients, you must have this permission: 'core.routings.read'.

get/finance/v1/routings

Request

  • Base URL
    https://api.apaleo.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.apaleo.com/finance/v1/routings
  • Auth
    OAuth 2
    Implicit: https://identity.apaleo.com/connect/authorize
    Scopes: routings.read, setup.read, setup.manage, admin

Query parameters

routingIdsstring[]

Return routings with any of the specified ids

bookingIdsstring[]

Return routings within any of the specified bookings

propertyIdsstring[]

Return routings within any of the specified properties

sourceFolioIdsstring[]

Return routings with any of the specified folios as a source

destinationFolioIdsstring[]

Return routings with any of the specified folios as destination

pageNumberinteger

Page number to retrieve. Default: 1. If the page has no items, the API returns 204 No Content.

pageSizeinteger

Items per page. Default: 500. Maximum: 500.

expandstring[]

List of all embedded resources that should be expanded in the response. Possible values are: actions. All other values will be silently ignored.

Response

Success.

countinteger required

Total count of items

Example response

{
  "routings": [
    {
      "id": "PKLJUASV",
      "bookingId": "XPGMSXGF",
      "propertyId": "MUC",
      "filter": {
        "folioIds": [
          "XPGMSXGF-1-1"
        ],
        "subAccounts": [
          {
            "id": "MUC-ACC",
            "name": "Accommodation"
          }
        ],
        "serviceTypes": [
          "Accommodation",
          "FoodAndBeverages"
        ],
        "services": [
          {
            "id": "MUC-BRK",
            "name": "Breakfast"
          }
        ]
      },
      "destinationFolio": {
        "id": "XPGMSXGF-2-1",
        "debitorType": "PrimaryGuest"
      }
    },
    {
      "id": "PKLABCYV",
      "bookingId": "XPGMSXGF",
      "propertyId": "MUC",
      "filter": {
        "serviceTypes": [
          "Accommodation"
        ],
        "from": "2024-01-01",
        "to": "2024-01-07"
      },
      "destinationFolio": {
        "id": "XPGMSXGF-2-2",
        "debitorType": "PrimaryGuest"
      }
    }
  ],
  "count": 1
}

Changes

No recorded changes to this operation across all 3 revisions of this API.