Simpleproducts

PreviousSalesorders NextSubscriptions

Last updated 3 months ago

Was this helpful?

Get SimpleProducts

get

/SimpleProducts

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

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

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/SimpleProducts'

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",
      "productNumber": "text",
      "name": "text",
      "category": "text",
      "defaultQuantity": 1,
      "unitCode": "text",
      "specificBillingDay": 1,
      "taxTemplate": "text",
      "taxIncluded": true,
      "deferredRevenueAccount": "text",
      "recognizedRevenueAccount": "text",
      "externalERPid": "text",
      "externalCRMId": "text",
      "activationDate": "2025-02-22T08:51:21.370Z",
      "endOfNewSalesDate": "2025-02-22T08:51:21.370Z",
      "endOfRenewalDate": "2025-02-22T08:51:21.370Z",
      "endOfLifeDate": "2025-02-22T08:51:21.370Z",
      "createInvoiceLinesPerTier": true,
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "priceDetails": [
        {
          "currency": "text",
          "price": 1,
          "tier": 1,
          "description": "text",
          "fromQuantity": 1,
          "toQuantity": 1,
          "priceBase": "Flat"
        }
      ],
      "chargeType": "OneOff",
      "priceModel": "Flat",
      "pricePeriod": "Monthly",
      "billingPeriod": "Monthly",
      "billingDay": "None",
      "periodAlignment": "None",
      "billingTiming": "InAdvance",
      "usageRating": "Sum"
    }
  ]
}

Success

Get SimpleProducts by Id

get

/SimpleProducts/{id}