Bookings | Younium Developer Portal

Younium Developer Portal

Get Bookings

get

/Bookings

Authorizations

Query parameters

Filterstring

Filter the results. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20

OrderBystring

Sorting the results. See ODATA specification for more information

Example: accountNumber Desc

ModifiedAfterstring · date-time

Apply a separate modified After filter. See 'ModifiedBefore' filter for further details.

Example: 11/01/2024 00:00:00

ModifiedBeforestring · date-time

Filter is also applied on sub entities: 'bookingLines'

Example: 11/01/2024 00:00:00

PageSizeinteger · int32

Page Size

Example: 20

PageNumberinteger · int32

Page Number

Example: 1

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.younium.com/Bookings'

200

400

401

403

{
  "pageNumber": 1,
  "pageSize": 1,
  "totalPages": 1,
  "totalCount": 1,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com",
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "currency": "text",
      "effectiveDate": "2025-02-22T08:51:22.012Z",
      "created": "2025-02-22T08:51:22.012Z",
      "modified": "2025-02-22T08:51:22.012Z",
      "notes": "text",
      "bookingLines": [
        {
          "created": "2025-02-22T08:51:22.012Z",
          "modified": "2025-02-22T08:51:22.012Z",
          "charge": {
            "name": "text",
            "chargeNumber": "OPC-000001",
            "description": "text",
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "externalERPId": "text",
            "externalCRMId": "text"
          },
          "cmrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-02-22T08:51:22.012Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "acv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-02-22T08:51:22.012Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "emrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-02-22T08:51:22.012Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "oneTimeFees": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-02-22T08:51:22.012Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "tcv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-02-22T08:51:22.012Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "fmrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-02-22T08:51:22.012Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          }
        }
      ],
      "bookingType": "New",
      "accountCategory": "New",
      "changeType": "Upsell",
      "cmrr": {
        "amount": 1,
        "amountInBaseCurrency": 1
      },
      "acv": {
        "amount": 1,
        "amountInBaseCurrency": 1
      },
      "emrr": {
        "amount": 1,
        "amountInBaseCurrency": 1
      },
      "oneTimeFees": {
        "amount": 1,
        "amountInBaseCurrency": 1
      },
      "tcv": {
        "amount": 1,
        "amountInBaseCurrency": 1
      },
      "fmrr": {
        "amount": 1,
        "amountInBaseCurrency": 1
      },
      "classification": {
        "name": "text",
        "description": "text",
        "chartColor": "text",
        "isSystemClassification": true,
        "classificationType": "NewCustomer"
      },
      "order": {
        "orderNumber": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "externalERPId": "text",
        "externalCRMId": "text"
      }
    }
  ]
}

Success

Get Bookings by Id

get

/Bookings/{id}