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

Simpleproducts

PreviousSalesordersNextSubscriptions

Last updated 7 months ago

Was this helpful?


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
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
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-05-29T04:29:02.170Z",
      "endOfNewSalesDate": "2025-05-29T04:29:02.170Z",
      "endOfRenewalDate": "2025-05-29T04:29:02.170Z",
      "endOfLifeDate": "2025-05-29T04:29:02.170Z",
      "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
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
404
Not Found
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-05-29T04:29:02.170Z",
  "endOfNewSalesDate": "2025-05-29T04:29:02.170Z",
  "endOfRenewalDate": "2025-05-29T04:29:02.170Z",
  "endOfLifeDate": "2025-05-29T04:29:02.170Z",
  "usageRating": "Sum",
  "createInvoiceLinesPerTier": true,
  "priceDetails": [
    {
      "currency": "text",
      "price": 1,
      "tier": 1,
      "description": "text",
      "fromQuantity": 1,
      "toQuantity": 1,
      "priceBase": "Flat"
    }
  ],
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
  • GETGet SimpleProducts
  • GETGet SimpleProducts by Id