Younium Developer Portal
  • Welcome
  • Get started
  • API:s
    • API 2.0
      • Accounts
      • Bookings
      • Chartofaccounts
      • Countries
      • Currency
      • Documenttemplate
      • Exchangerate
      • Invoices
      • Journals
      • Measurements
      • Orders
      • Paymentterms
      • Products
      • Quotes
      • Salesorders
      • Simpleproducts
      • Subscriptions
      • Taxtemplates
      • Unitofmeasurements
      • Usage
      • Webhooks
    • API 2.1
      • Accounts
      • Bookings
      • Chartofaccounts
      • Countries
      • Currency
      • Customfieldconfigurations
      • Documenttemplate
      • Exchangerate
      • Invoicebatches
      • Invoicebatchgroups
      • Invoices
      • Journals
      • Measurements
      • Orders
      • Payments
      • Paymentterms
      • Products
      • Quotes
      • Reports
      • Revenueschedule
      • Salesorders
      • Simpleproducts
      • Subscriptions
      • Taxtemplates
      • Unitofmeasurements
      • Usage
      • Webhooks
  • Documentation
    • Developer resources
    • Invoice operations
    • Product guide
    • Webhooks
    • Idempotent requests
  • Sandbox
Powered by GitBook
On this page

Was this helpful?

  1. API:s
  2. API 2.1

Bookings

PreviousAccountsNextChartofaccounts

Last updated 6 months ago

Was this helpful?

Get Bookings

get
Authorizations
Query parameters
FilterstringOptional

Filter the results. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20
OrderBystringOptional

Sorting the results. See ODATA specification for more information

Example: accountNumber Desc
ModifiedAfterstring · date-timeOptional

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

Example: 03/01/2025 00:00:00
ModifiedBeforestring · date-timeOptional

Filter is also applied on sub entities: 'bookingLines'

Example: 03/01/2025 00:00:00
PageSizeinteger · int32Optional

Page Size

Example: 20
PageNumberinteger · int32Optional

Page Number

Example: 1
Header parameters
api-versionstringOptional
Responses
200
Success
application/json
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
get
GET /Bookings HTTP/1.1
Host: api.younium.com
Accept: */*

{
  "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",
      "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
      },
      "effectiveDate": "2025-05-22T15:40:04.063Z",
      "bookingLines": [
        {
          "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-05-22T15:40:04.063Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "acv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-05-22T15:40:04.063Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "emrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-05-22T15:40:04.063Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "oneTimeFees": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-05-22T15:40:04.063Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "tcv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-05-22T15:40:04.063Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "fmrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-05-22T15:40:04.063Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "created": "2025-05-22T15:40:04.063Z",
          "modified": "2025-05-22T15:40:04.063Z"
        }
      ],
      "classification": {
        "name": "text",
        "description": "text",
        "chartColor": "text",
        "isSystemClassification": true,
        "classificationType": "NewCustomer"
      },
      "created": "2025-05-22T15:40:04.063Z",
      "modified": "2025-05-22T15:40:04.063Z",
      "order": {
        "orderNumber": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "externalERPId": "text",
        "externalCRMId": "text"
      },
      "notes": "text"
    }
  ]
}

Get Bookings by Id

get
Authorizations
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
Responses
200
Success
application/json
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
404
Not Found
application/json
get
GET /Bookings/{id} HTTP/1.1
Host: api.younium.com
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "currency": "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
  },
  "effectiveDate": "2025-05-22T15:40:04.063Z",
  "bookingLines": [
    {
      "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-05-22T15:40:04.063Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-05-22T15:40:04.063Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-05-22T15:40:04.063Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-05-22T15:40:04.063Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-05-22T15:40:04.063Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "fmrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-05-22T15:40:04.063Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "created": "2025-05-22T15:40:04.063Z",
      "modified": "2025-05-22T15:40:04.063Z"
    }
  ],
  "classification": {
    "name": "text",
    "description": "text",
    "chartColor": "text",
    "isSystemClassification": true,
    "classificationType": "NewCustomer"
  },
  "created": "2025-05-22T15:40:04.063Z",
  "modified": "2025-05-22T15:40:04.063Z",
  "order": {
    "orderNumber": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "externalERPId": "text",
    "externalCRMId": "text"
  },
  "notes": "text"
}
  • GETGet Bookings
  • GETGet Bookings by Id