Simpleproducts

Get Simple Products

get

Required scopes

This endpoint requires the following scopes:

: Access Younium API

Authorizations

OAuth2passwordRequired

Token URL:

Query parameters

Skipinteger · int32Optional

Skip number of records

Example: 10

Takeinteger · int32Optional

Take number of records

Example: 5

FilterstringOptional

Filter the resulsts. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20

SortstringOptional

Sorting the results. See ODATA specificaion for more information

Example: name

Header parameters

api-versionstringOptional

Responses

200

Success

application/json

idstring · uuidOptional

productNumberstring · nullableOptional

namestring · min: 1Required

categorystring · min: 1Required

chargeTypestring · enumOptionalPossible values:

priceModelstring · enumOptionalPossible values:

pricePeriodstring · enumOptionalPossible values:

defaultQuantitynumber · double · nullableOptional

unitCodestring · nullableOptional

billingPeriodstring · enumOptionalPossible values:

billingDaystring · enumOptionalPossible values:

specificBillingDayinteger · int32 · nullableOptional

periodAlignmentstring · enumOptionalPossible values:

billingTimingstring · enumOptionalPossible values:

taxTemplatestring · nullableOptional

taxIncludedbooleanOptional

deferredRevenueAccountstring · nullableOptional

recognizedRevenueAccountstring · nullableOptional

externalERPidstring · nullableOptional

externalCRMIdstring · nullableOptional

activationDatestring · date-time · nullableOptional

endOfNewSalesDatestring · date-time · nullableOptional

endOfRenewalDatestring · date-time · nullableOptional

endOfLifeDatestring · date-time · nullableOptional

usageRatingstring · enumOptionalPossible values:

createInvoiceLinesPerTierboolean · nullableOptional

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

get/SimpleProducts

GET /SimpleProducts HTTP/1.1
Host: api.sandbox.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": "2026-01-01T00:00:00.000Z",
    "endOfNewSalesDate": "2026-01-01T00:00:00.000Z",
    "endOfRenewalDate": "2026-01-01T00:00:00.000Z",
    "endOfLifeDate": "2026-01-01T00:00:00.000Z",
    "usageRating": "Sum",
    "createInvoiceLinesPerTier": true,
    "priceDetails": [
      {
        "currency": "text",
        "price": 1,
        "tier": 1,
        "description": "text",
        "fromQuantity": 1,
        "toQuantity": 1,
        "priceBase": "Flat",
        "tierDecimalPrecision": 1
      }
    ],
    "customFields": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
]

get

Required scopes

This endpoint requires the following scopes:

: Access Younium API

Authorizations

OAuth2passwordRequired

Token URL:

Path parameters

idstring · uuidRequired

Header parameters

api-versionstringOptional

Responses

200

Success

application/json

idstring · uuidOptional

productNumberstring · nullableOptional

namestring · min: 1Required

categorystring · min: 1Required

chargeTypestring · enumOptionalPossible values:

priceModelstring · enumOptionalPossible values:

pricePeriodstring · enumOptionalPossible values:

defaultQuantitynumber · double · nullableOptional

unitCodestring · nullableOptional

billingPeriodstring · enumOptionalPossible values:

billingDaystring · enumOptionalPossible values:

specificBillingDayinteger · int32 · nullableOptional

periodAlignmentstring · enumOptionalPossible values:

billingTimingstring · enumOptionalPossible values:

taxTemplatestring · nullableOptional

taxIncludedbooleanOptional

deferredRevenueAccountstring · nullableOptional

recognizedRevenueAccountstring · nullableOptional

externalERPidstring · nullableOptional

externalCRMIdstring · nullableOptional

activationDatestring · date-time · nullableOptional

endOfNewSalesDatestring · date-time · nullableOptional

endOfRenewalDatestring · date-time · nullableOptional

endOfLifeDatestring · date-time · nullableOptional

usageRatingstring · enumOptionalPossible values:

createInvoiceLinesPerTierboolean · nullableOptional

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

404

Not Found

application/json

get/SimpleProducts/{id}

GET /SimpleProducts/{id} HTTP/1.1
Host: api.sandbox.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": "2026-01-01T00:00:00.000Z",
  "endOfNewSalesDate": "2026-01-01T00:00:00.000Z",
  "endOfRenewalDate": "2026-01-01T00:00:00.000Z",
  "endOfLifeDate": "2026-01-01T00:00:00.000Z",
  "usageRating": "Sum",
  "createInvoiceLinesPerTier": true,
  "priceDetails": [
    {
      "currency": "text",
      "price": 1,
      "tier": 1,
      "description": "text",
      "fromQuantity": 1,
      "toQuantity": 1,
      "priceBase": "Flat",
      "tierDecimalPrecision": 1
    }
  ],
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

PreviousSalesorders

NextSubscriptions

Last updated 1 year ago