Simpleproducts

Get SimpleProducts

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

Apply a separate filter to only get records that has been modified Before the specified date time.

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
get
GET /SimpleProducts HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
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",
      "productNumber": "text",
      "name": "text",
      "category": "text",
      "chargeType": "OneOff",
      "priceModel": "Flat",
      "pricePeriod": "Monthly",
      "defaultQuantity": 1,
      "unitCode": "text",
      "billingPeriod": "Monthly",
      "billingDay": "None",
      "specificBillingDay": 1,
      "periodAlignment": "None",
      "billingTiming": "InAdvance",
      "taxTemplate": "text",
      "taxIncluded": true,
      "deferredRevenueAccount": "text",
      "recognizedRevenueAccount": "text",
      "externalERPid": "text",
      "externalCRMId": "text",
      "activationDate": "2025-06-27T04:39:37.919Z",
      "endOfNewSalesDate": "2025-06-27T04:39:37.919Z",
      "endOfRenewalDate": "2025-06-27T04:39:37.919Z",
      "endOfLifeDate": "2025-06-27T04:39:37.919Z",
      "usageRating": "Sum",
      "createInvoiceLinesPerTier": true,
      "priceDetails": [
        {
          "currency": "text",
          "price": 1,
          "tier": 1,
          "description": "text",
          "fromQuantity": 1,
          "toQuantity": 1,
          "priceBase": "Flat"
        }
      ],
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

Get SimpleProducts by Id

get
Authorizations
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
Responses
200
Success
application/json
get
GET /SimpleProducts/{id} HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "productNumber": "text",
  "name": "text",
  "category": "text",
  "chargeType": "OneOff",
  "priceModel": "Flat",
  "pricePeriod": "Monthly",
  "defaultQuantity": 1,
  "unitCode": "text",
  "billingPeriod": "Monthly",
  "billingDay": "None",
  "specificBillingDay": 1,
  "periodAlignment": "None",
  "billingTiming": "InAdvance",
  "taxTemplate": "text",
  "taxIncluded": true,
  "deferredRevenueAccount": "text",
  "recognizedRevenueAccount": "text",
  "externalERPid": "text",
  "externalCRMId": "text",
  "activationDate": "2025-06-27T04:39:37.919Z",
  "endOfNewSalesDate": "2025-06-27T04:39:37.919Z",
  "endOfRenewalDate": "2025-06-27T04:39:37.919Z",
  "endOfLifeDate": "2025-06-27T04:39:37.919Z",
  "usageRating": "Sum",
  "createInvoiceLinesPerTier": true,
  "priceDetails": [
    {
      "currency": "text",
      "price": 1,
      "tier": 1,
      "description": "text",
      "fromQuantity": 1,
      "toQuantity": 1,
      "priceBase": "Flat"
    }
  ],
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
PreviousSalesordersNextSubscriptions

Last updated

Was this helpful?