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

Products

PreviousPaymenttermsNextQuotes

Last updated 6 months ago

Was this helpful?

Get Product from ChargePlan 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 /Products/FromChargePlan/{id} HTTP/1.1
Host: api.younium.com
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "productNumber": "text",
  "name": "text",
  "productType": "Simple",
  "category": "text",
  "activationDate": "2025-05-07T09:01:15.400Z",
  "endOfNewSalesDate": "2025-05-07T09:01:15.400Z",
  "endOfRenewalDate": "2025-05-07T09:01:15.400Z",
  "endOfLifeDate": "2025-05-07T09:01:15.400Z",
  "isFrameworkProduct": true,
  "chargePlans": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "chargePlanNumber": "text",
      "name": "text",
      "effectiveStartDate": "2025-05-07T09:01:15.400Z",
      "endOfNewSalesDate": "2025-05-07T09:01:15.400Z",
      "effectiveEndDate": "2025-05-07T09:01:15.400Z",
      "charges": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "chargeNumber": "C-000001",
          "name": "text",
          "model": "Flat",
          "chargeType": "OneOff",
          "unitCode": "text",
          "defaultQuantity": 1,
          "pricePeriod": "Monthly",
          "usageRating": "Sum",
          "createInvoiceLinesPerTier": true,
          "billingDay": "None",
          "specificBillingDay": 1,
          "billingPeriod": "Monthly",
          "periodAlignment": "None",
          "billingTiming": "InAdvance",
          "taxTemplate": "text",
          "taxIncluded": true,
          "externalERPId": "text",
          "externalCRMId": "text",
          "created": "2025-05-07T09:01:15.400Z",
          "modified": "2025-05-07T09:01:15.400Z",
          "deferredRevenueAccount": "text",
          "recognizedRevenueAccount": "text",
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "priceDetails": [
            {
              "currency": "text",
              "price": 1,
              "tier": 1,
              "description": "text",
              "fromQuantity": 1,
              "toQuantity": 1,
              "priceBase": "Flat"
            }
          ],
          "features": [
            {
              "code": "text",
              "description": "text"
            }
          ]
        }
      ],
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "created": "2025-05-07T09:01:15.400Z",
      "modified": "2025-05-07T09:01:15.400Z"
    }
  ],
  "externalERPId": "text",
  "externalCRMId": "text",
  "created": "2025-05-07T09:01:15.400Z",
  "modified": "2025-05-07T09:01:15.400Z",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Get Product from Charge 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 /Products/FromCharge/{id} HTTP/1.1
Host: api.younium.com
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "productNumber": "text",
  "name": "text",
  "productType": "Simple",
  "category": "text",
  "activationDate": "2025-05-07T09:01:15.400Z",
  "endOfNewSalesDate": "2025-05-07T09:01:15.400Z",
  "endOfRenewalDate": "2025-05-07T09:01:15.400Z",
  "endOfLifeDate": "2025-05-07T09:01:15.400Z",
  "isFrameworkProduct": true,
  "chargePlans": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "chargePlanNumber": "text",
      "name": "text",
      "effectiveStartDate": "2025-05-07T09:01:15.400Z",
      "endOfNewSalesDate": "2025-05-07T09:01:15.400Z",
      "effectiveEndDate": "2025-05-07T09:01:15.400Z",
      "charges": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "chargeNumber": "C-000001",
          "name": "text",
          "model": "Flat",
          "chargeType": "OneOff",
          "unitCode": "text",
          "defaultQuantity": 1,
          "pricePeriod": "Monthly",
          "usageRating": "Sum",
          "createInvoiceLinesPerTier": true,
          "billingDay": "None",
          "specificBillingDay": 1,
          "billingPeriod": "Monthly",
          "periodAlignment": "None",
          "billingTiming": "InAdvance",
          "taxTemplate": "text",
          "taxIncluded": true,
          "externalERPId": "text",
          "externalCRMId": "text",
          "created": "2025-05-07T09:01:15.400Z",
          "modified": "2025-05-07T09:01:15.400Z",
          "deferredRevenueAccount": "text",
          "recognizedRevenueAccount": "text",
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "priceDetails": [
            {
              "currency": "text",
              "price": 1,
              "tier": 1,
              "description": "text",
              "fromQuantity": 1,
              "toQuantity": 1,
              "priceBase": "Flat"
            }
          ],
          "features": [
            {
              "code": "text",
              "description": "text"
            }
          ]
        }
      ],
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "created": "2025-05-07T09:01:15.400Z",
      "modified": "2025-05-07T09:01:15.400Z"
    }
  ],
  "externalERPId": "text",
  "externalCRMId": "text",
  "created": "2025-05-07T09:01:15.400Z",
  "modified": "2025-05-07T09:01:15.400Z",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Get Product Features

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 /Products/productFeatures HTTP/1.1
Host: api.younium.com
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": {
    "code": "text",
    "description": "text"
  }
}

Get Products

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

Filter is also applied on sub entities: 'chargePlans', 'charges', 'chargeDetails' and 'customFields' on these entities

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 /Products HTTP/1.1
Host: api.younium.com
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",
      "productType": "Simple",
      "category": "text",
      "activationDate": "2025-05-07T09:01:15.400Z",
      "endOfNewSalesDate": "2025-05-07T09:01:15.400Z",
      "endOfRenewalDate": "2025-05-07T09:01:15.400Z",
      "endOfLifeDate": "2025-05-07T09:01:15.400Z",
      "isFrameworkProduct": true,
      "chargePlans": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "chargePlanNumber": "text",
          "name": "text",
          "effectiveStartDate": "2025-05-07T09:01:15.400Z",
          "endOfNewSalesDate": "2025-05-07T09:01:15.400Z",
          "effectiveEndDate": "2025-05-07T09:01:15.400Z",
          "charges": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "chargeNumber": "C-000001",
              "name": "text",
              "model": "Flat",
              "chargeType": "OneOff",
              "unitCode": "text",
              "defaultQuantity": 1,
              "pricePeriod": "Monthly",
              "usageRating": "Sum",
              "createInvoiceLinesPerTier": true,
              "billingDay": "None",
              "specificBillingDay": 1,
              "billingPeriod": "Monthly",
              "periodAlignment": "None",
              "billingTiming": "InAdvance",
              "taxTemplate": "text",
              "taxIncluded": true,
              "externalERPId": "text",
              "externalCRMId": "text",
              "created": "2025-05-07T09:01:15.400Z",
              "modified": "2025-05-07T09:01:15.400Z",
              "deferredRevenueAccount": "text",
              "recognizedRevenueAccount": "text",
              "customFields": {
                "ANY_ADDITIONAL_PROPERTY": "anything"
              },
              "priceDetails": [
                {
                  "currency": "text",
                  "price": 1,
                  "tier": 1,
                  "description": "text",
                  "fromQuantity": 1,
                  "toQuantity": 1,
                  "priceBase": "Flat"
                }
              ],
              "features": [
                {
                  "code": "text",
                  "description": "text"
                }
              ]
            }
          ],
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "created": "2025-05-07T09:01:15.400Z",
          "modified": "2025-05-07T09:01:15.400Z"
        }
      ],
      "externalERPId": "text",
      "externalCRMId": "text",
      "created": "2025-05-07T09:01:15.400Z",
      "modified": "2025-05-07T09:01:15.400Z",
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ]
}

Delete product

delete

A product can only be deleted if it's not in use on any active orders.

Authorizations
Path parameters
idstring ยท uuidRequired
Header parameters
api-versionstringOptional
Responses
200
Success
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
404
Not Found
application/json
delete
DELETE /Products/{id} HTTP/1.1
Host: api.younium.com
Accept: */*

No content

Get Products 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 /Products/{id} HTTP/1.1
Host: api.younium.com
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "productNumber": "text",
  "name": "text",
  "productType": "Simple",
  "category": "text",
  "activationDate": "2025-05-07T09:01:15.400Z",
  "endOfNewSalesDate": "2025-05-07T09:01:15.400Z",
  "endOfRenewalDate": "2025-05-07T09:01:15.400Z",
  "endOfLifeDate": "2025-05-07T09:01:15.400Z",
  "isFrameworkProduct": true,
  "chargePlans": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "chargePlanNumber": "text",
      "name": "text",
      "effectiveStartDate": "2025-05-07T09:01:15.400Z",
      "endOfNewSalesDate": "2025-05-07T09:01:15.400Z",
      "effectiveEndDate": "2025-05-07T09:01:15.400Z",
      "charges": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "chargeNumber": "C-000001",
          "name": "text",
          "model": "Flat",
          "chargeType": "OneOff",
          "unitCode": "text",
          "defaultQuantity": 1,
          "pricePeriod": "Monthly",
          "usageRating": "Sum",
          "createInvoiceLinesPerTier": true,
          "billingDay": "None",
          "specificBillingDay": 1,
          "billingPeriod": "Monthly",
          "periodAlignment": "None",
          "billingTiming": "InAdvance",
          "taxTemplate": "text",
          "taxIncluded": true,
          "externalERPId": "text",
          "externalCRMId": "text",
          "created": "2025-05-07T09:01:15.400Z",
          "modified": "2025-05-07T09:01:15.400Z",
          "deferredRevenueAccount": "text",
          "recognizedRevenueAccount": "text",
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "priceDetails": [
            {
              "currency": "text",
              "price": 1,
              "tier": 1,
              "description": "text",
              "fromQuantity": 1,
              "toQuantity": 1,
              "priceBase": "Flat"
            }
          ],
          "features": [
            {
              "code": "text",
              "description": "text"
            }
          ]
        }
      ],
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "created": "2025-05-07T09:01:15.400Z",
      "modified": "2025-05-07T09:01:15.400Z"
    }
  ],
  "externalERPId": "text",
  "externalCRMId": "text",
  "created": "2025-05-07T09:01:15.400Z",
  "modified": "2025-05-07T09:01:15.400Z",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Delete charge plan

delete

A charge plan can only be deleted if it's not in use on any active orders.

Authorizations
Path parameters
idstring ยท uuidRequired
Header parameters
api-versionstringOptional
Responses
200
Success
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
404
Not Found
application/json
delete
DELETE /Products/chargePlans/{id} HTTP/1.1
Host: api.younium.com
Accept: */*

No content

Delete charges

delete

A charge can only be deleted if it's not in use on any active orders.

Authorizations
Path parameters
idstring ยท uuidRequired
Header parameters
api-versionstringOptional
Responses
200
Success
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
404
Not Found
application/json
delete
DELETE /Products/charges/{id} HTTP/1.1
Host: api.younium.com
Accept: */*

No content
  • GETGet Product from ChargePlan Id
  • GETGet Product from Charge Id
  • GETGet Product Features
  • POSTCreate Product
  • GETGet Products
  • PATCHUpdate Product
  • DELETEDelete product
  • GETGet Products by Id
  • DELETEDelete charge plan
  • DELETEDelete charges

Create Product

post
Authorizations
Header parameters
api-versionstringOptional
younium-idempotency-keystringOptional
younium-idempotency-durationInHoursintegerOptional
Body
all ofOptional
Responses
201
Created
application/json
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
post
POST /Products HTTP/1.1
Host: api.younium.com
Content-Type: application/json
Accept: */*
Content-Length: 1057

{
  "productType": "Simple",
  "chargePlans": [
    {
      "charges": [
        {
          "PriceDetails": [
            {
              "isInfinite": true,
              "currency": "SEK",
              "price": 1,
              "description": "text",
              "priceBase": "Flat",
              "tier": 1,
              "toQuantity": 1
            }
          ],
          "features": [
            {
              "feature": {
                "key": "text",
                "value": "text"
              }
            }
          ],
          "name": "text",
          "model": "Flat",
          "chargeType": "OneOff",
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "externalCRMId": "text",
          "externalERPId": "text",
          "unit": "pcs",
          "pricePeriod": "Monthly",
          "usageRating": "Sum",
          "measurementsRule": "LatestDate",
          "defaultQuantity": 1,
          "billingPeriod": "Monthly",
          "periodAlignment": "None",
          "billingDay": "None",
          "billingTiming": "InAdvance",
          "specificBillingDay": 1,
          "offsetBillingDays": 1,
          "taxIncluded": true,
          "revenueRecognition": {
            "key": "text",
            "value": "text"
          },
          "taxTemplate": "Sweden standard",
          "deferredRevenueAccount": "1510",
          "recognizedRevenueAccount": "1510"
        }
      ],
      "name": "text",
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "name": "text",
  "category": "Add-on",
  "activationDate": "2025-05-07T09:01:15.400Z",
  "externalERPId": "text",
  "externalCRMId": "text",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "text"
}

Update Product

patch
Authorizations
Path parameters
idstring ยท uuidRequired
Header parameters
api-versionstringOptional
Body
all ofOptional
Responses
204
No Content
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
404
Not Found
application/json
patch
PATCH /Products/{id} HTTP/1.1
Host: api.younium.com
Content-Type: application/merge-patch+json
Accept: */*
Content-Length: 1205

{
  "productType": "Simple",
  "chargePlans": [
    {
      "operation": "Change",
      "chargePlan": "CP-000001",
      "charges": [
        {
          "charge": {
            "key": "text",
            "value": "text"
          },
          "operation": "Change",
          "PriceDetails": [
            {
              "operation": "Change",
              "isInfinite": true,
              "currency": "SEK",
              "price": 1,
              "description": "text",
              "priceBase": "Flat",
              "tier": 1,
              "toQuantity": 1
            }
          ],
          "features": [
            {
              "operation": "Remove",
              "feature": {
                "key": "text",
                "value": "text"
              }
            }
          ],
          "name": "text",
          "model": "Flat",
          "chargeType": "OneOff",
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "externalCRMId": "text",
          "externalERPId": "text",
          "unit": "pcs",
          "pricePeriod": "Monthly",
          "usageRating": "Sum",
          "measurementsRule": "LatestDate",
          "defaultQuantity": 1,
          "billingPeriod": "Monthly",
          "periodAlignment": "None",
          "billingDay": "None",
          "billingTiming": "InAdvance",
          "specificBillingDay": 1,
          "offsetBillingDays": 1,
          "taxIncluded": true,
          "revenueRecognition": {
            "key": "text",
            "value": "text"
          },
          "taxTemplate": "Sweden standard",
          "deferredRevenueAccount": "1510",
          "recognizedRevenueAccount": "1510"
        }
      ],
      "name": "text",
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "name": "text",
  "category": "Add-on",
  "activationDate": "2025-05-07T09:01:15.400Z",
  "externalERPId": "text",
  "externalCRMId": "text",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
No content