BObookingexperts
Channel Costs

GET costs

Changed on

Returns the costs that are available to the current channel

get/v3/channels/{channel_id}/costs

Request

Path parameters

channel_idstring required

Channel ID

Query parameters

page[number]integer

Page number

page[size]integer

Page size

sortstring

Sort. Specify a comma separated list of attributes to sort on. Prefix attribute with a - to sort in descending order. Allowed attributes: id, name, created_at, updated_at

fields[cost]string

Fieldset. Specify a comma separated list of attributes to return

includestring

Includes list. Specify a comma separated list of resources to include.

filter[id]string

Filter on ID

filter[name]string

Filter on name

filter[description]string

Filter on description

filter[invoiced_as]string

Filter on invoiced_as

filter[cost_type]string

Filter on cost_type

filter[counts_seniors]string

Filter on counts_seniors

filter[counts_adults]string

Filter on counts_adults

filter[counts_adolescents]string

Filter on counts_adolescents

filter[counts_children]string

Filter on counts_children

filter[counts_babies]string

Filter on counts_babies

filter[counts_from]string

Filter on counts_from

filter[counts_till]string

Filter on counts_till

filter[preference_type]string

Filter on preference_type

filter[applies_for_late_checkout]string

Filter on applies_for_late_checkout

filter[applies_to_all_rentable_types]string

Filter on applies_to_all_rentable_types

filter[limit_calculation]string

Filter on limit_calculation

filter[created_at]string

Filter on created_at

filter[updated_at]string

Filter on updated_at

filter[administration]string

Filter on administration. Specify a comma separated list of IDs to filter on.

filter[ledger_account]string

Filter on ledger_account. Specify a comma separated list of IDs to filter on.

filter[amenities]string

Filter on amenities. Specify a comma separated list of IDs to filter on.

Headers

Accept-Languagestring

Supported languages. A comma separated list with one or more of the following locales: cs, da-DK, de, de-AT, de-CH, en-US, en-GB, es, fr, fr-BE, fr-LU, it, nb, nl, nl-BE, pl, pt, tr, en, da. Default: 'en'.

Response

CostCollectionResponse

Example response

{
  "data": [
    {
      "id": "1",
      "type": "cost",
      "relationships": {
        "administration": {
          "data": {
            "type": "administration"
          }
        },
        "ledger_account": {
          "data": {
            "type": "ledger_account"
          }
        },
        "amenities": {
          "data": [
            {
              "type": "amenity"
            }
          ]
        }
      }
    }
  ],
  "included": [
    {
      "id": "1",
      "type": "administration",
      "relationships": {
        "city": {
          "data": {
            "type": "city"
          }
        },
        "checkin_timetable": {
          "data": {
            "type": "timetable"
          }
        },
        "checkout_timetable": {
          "data": {
            "type": "timetable"
          }
        },
        "interactive_map": {
          "data": {
            "type": "interactive_map"
          }
        },
        "payment_handlers": {
          "data": [
            {
              "type": "payment_handler"
            }
          ]
        }
      }
    }
  ]
}

Changes

  • ff81bc4fefa9Revision changes
    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property /////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      added the optional property //////// to the response with the status

    • info

      the response optional property /////// became read-only for the status

    • info

      the response optional property /////// became read-only for the status

    • info

      the response optional property /////// became read-only for the status

    • info

      the response optional property /////// became read-only for the status

    • info

      the response optional property /////// became read-only for the status

    • info

      the response optional property /////// became read-only for the status