Simpleproducts

Get SimpleProducts

GEThttps://api.sandbox.younium.com/SimpleProducts

Authorization

oauth2

Query parameters

Header parameters

Response

200400401403

Success

Body

application/json

pageNumberinteger (int32)

pageSizeinteger (int32)

totalPagesnullable integer (int32)

totalCountinteger (int32)

nextPagenullable string (uri)

previousPagenullable string (uri)

firstPagenullable string (uri)

lastPagenullable string (uri)

datanullable array of SimpleProduct (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/SimpleProducts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "pageNumber": 0,
  "pageSize": 0,
  "totalPages": 0,
  "totalCount": 0,
  "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": {},
      "priceModel": {},
      "pricePeriod": {},
      "defaultQuantity": 0,
      "unitCode": "text",
      "billingPeriod": {},
      "billingDay": {},
      "specificBillingDay": 0,
      "periodAlignment": {},
      "billingTiming": {},
      "taxTemplate": "text",
      "taxIncluded": false,
      "deferredRevenueAccount": "text",
      "recognizedRevenueAccount": "text",
      "externalERPid": "text",
      "externalCRMId": "text",
      "activationDate": "2024-12-22T11:06:38.025Z",
      "endOfNewSalesDate": "2024-12-22T11:06:38.025Z",
      "endOfRenewalDate": "2024-12-22T11:06:38.025Z",
      "endOfLifeDate": "2024-12-22T11:06:38.025Z",
      "usageRating": {},
      "createInvoiceLinesPerTier": false,
      "priceDetails": [
        {
          "currency": "text",
          "price": 0,
          "tier": 0,
          "description": "text",
          "fromQuantity": 0,
          "toQuantity": 0,
          "priceBase": {}
        }
      ]
    }
  ]
}

Get SimpleProducts by Id

GEThttps://api.sandbox.younium.com/SimpleProducts/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Response

200400401403404

Success

Body

application/json

idstring (uuid)

productNumbernullable string

name*string

category*string

chargeTypeall of

priceModelall of

pricePeriodnullable all of

defaultQuantitynullable number (double)

unitCodenullable string

billingPeriodnullable all of

billingDayall of

specificBillingDaynullable integer (int32)

periodAlignmentnullable all of

billingTimingnullable all of

taxTemplatenullable string

taxIncludedboolean

deferredRevenueAccountnullable string

recognizedRevenueAccountnullable string

externalERPidnullable string

externalCRMIdnullable string

activationDatenullable string (date-time)

endOfNewSalesDatenullable string (date-time)

endOfRenewalDatenullable string (date-time)

endOfLifeDatenullable string (date-time)

usageRatingnullable all of

createInvoiceLinesPerTiernullable boolean

priceDetailsnullable array of PriceDetailsResponse (object)

customFieldsnullable object

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/SimpleProducts/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "productNumber": "text",
  "name": "text",
  "category": "text",
  "chargeType": {},
  "priceModel": {},
  "pricePeriod": {},
  "defaultQuantity": 0,
  "unitCode": "text",
  "billingPeriod": {},
  "billingDay": {},
  "specificBillingDay": 0,
  "periodAlignment": {},
  "billingTiming": {},
  "taxTemplate": "text",
  "taxIncluded": false,
  "deferredRevenueAccount": "text",
  "recognizedRevenueAccount": "text",
  "externalERPid": "text",
  "externalCRMId": "text",
  "activationDate": "2024-12-22T11:06:38.025Z",
  "endOfNewSalesDate": "2024-12-22T11:06:38.025Z",
  "endOfRenewalDate": "2024-12-22T11:06:38.025Z",
  "endOfLifeDate": "2024-12-22T11:06:38.025Z",
  "usageRating": {},
  "createInvoiceLinesPerTier": false,
  "priceDetails": [
    {
      "currency": "text",
      "price": 0,
      "tier": 0,
      "description": "text",
      "fromQuantity": 0,
      "toQuantity": 0,
      "priceBase": {}
    }
  ]
}

---