Products

PreviousPaymentterms NextQuotes

Last updated 3 months ago

Was this helpful?

Get Products

get

/Products

Authorizations

Query parameters

Skipinteger · int32

Skip number of records

Example: 10

Takeinteger · int32

Take number of records

Example: 5

Filterstring

Filter the resulsts. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20

Sortstring

Sorting the results. See ODATA specificaion for more information

Example: name

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.younium.com/Products'

200

400

401

403

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "productNumber": "text",
    "name": "text",
    "category": "text",
    "activationDate": "2025-02-22T08:40:35.583Z",
    "endOfNewSalesDate": "2025-02-22T08:40:35.583Z",
    "endOfRenewalDate": "2025-02-22T08:40:35.583Z",
    "endOfLifeDate": "2025-02-22T08:40:35.583Z",
    "isFrameworkProduct": true,
    "externalERPId": "text",
    "externalCRMId": "text",
    "created": "2025-02-22T08:40:35.583Z",
    "modified": "2025-02-22T08:40:35.583Z",
    "customFields": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "chargePlans": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "chargePlanNumber": "text",
        "name": "text",
        "effectiveStartDate": "2025-02-22T08:40:35.583Z",
        "endOfNewSalesDate": "2025-02-22T08:40:35.583Z",
        "effectiveEndDate": "2025-02-22T08:40:35.583Z",
        "created": "2025-02-22T08:40:35.583Z",
        "modified": "2025-02-22T08:40:35.583Z",
        "customFields": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "charges": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "chargeNumber": "C-000001",
            "name": "text",
            "unitCode": "text",
            "defaultQuantity": 1,
            "createInvoiceLinesPerTier": true,
            "specificBillingDay": 1,
            "taxTemplate": "text",
            "taxIncluded": true,
            "externalERPId": "text",
            "externalCRMId": "text",
            "created": "2025-02-22T08:40:35.583Z",
            "modified": "2025-02-22T08:40:35.583Z",
            "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"
              }
            ],
            "model": "Flat",
            "chargeType": "OneOff",
            "pricePeriod": "Monthly",
            "usageRating": "Sum",
            "billingDay": "None",
            "billingPeriod": "Monthly",
            "periodAlignment": "None",
            "billingTiming": "InAdvance"
          }
        ]
      }
    ],
    "productType": "Simple"
  }
]

Success

Create Product

post

/Products

Authorizations

Header parameters

api-versionstring

Body

namestring | nullable

activationDatestring · date-time | nullable

externalERPIdstring | nullable

externalCRMIdstring | nullable

customFieldsobject | nullable

chargePlansobject[] | nullable

productTypeall of

categoryall of | nullable

Allowed as string input: Name, ProductCategory-Id.

Example: Add-on

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.younium.com/Products' \
  --header 'Content-Type: application/json' \
  --data '{"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"chargePlans":[{"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"charges":[{"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"PriceDetails":[{"currency":"SEK","priceBase":"Flat"}],"features":[{"feature":{}}],"model":"Flat","chargeType":"OneOff","unit":"pcs","pricePeriod":"Monthly","usageRating":"Sum","measurementsRule":"LatestDate","billingPeriod":"Monthly","periodAlignment":"None","billingDay":"None","billingTiming":"InAdvance","revenueRecognition":{},"taxTemplate":"Sweden standard","deferredRevenueAccount":"1510","recognizedRevenueAccount":"1510"}]}],"productType":"Simple","category":"Add-on"}'

201

400

401

403

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "text"
}

Created

Update Product

patch

/Products/{id}

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Body

namestring | nullable

activationDatestring · date-time | nullable

externalERPIdstring | nullable

externalCRMIdstring | nullable

customFieldsobject | nullable

chargePlansobject[] | nullable

productTypeall of | nullable

categoryall of | nullable

Allowed as string input: Name, ProductCategory-Id.

Example: Add-on

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.younium.com/Products/{id}' \
  --header 'Content-Type: application/merge-patch+json' \
  --data '{"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"chargePlans":[{"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"charges":[{"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"PriceDetails":[{"operation":"Change","currency":"SEK","priceBase":"Flat"}],"features":[{"operation":"Remove","feature":{}}],"charge":{},"operation":"Change","model":"Flat","chargeType":"OneOff","unit":"pcs","pricePeriod":"Monthly","usageRating":"Sum","measurementsRule":"LatestDate","billingPeriod":"Monthly","periodAlignment":"None","billingDay":"None","billingTiming":"InAdvance","revenueRecognition":{},"taxTemplate":"Sweden standard","deferredRevenueAccount":"1510","recognizedRevenueAccount":"1510"}],"operation":"Change","chargePlan":"CP-000001"}],"productType":"Simple","category":"Add-on"}'

204

400

401

403

404

No body

No Content

Delete product

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

delete

/Products/{id}

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.younium.com/Products/{id}'

200

400

401

403

404

No body

Success

Get Products by Id

get

/Products/{id}

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.younium.com/Products/{id}'

200

400

401

403

404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "productNumber": "text",
  "name": "text",
  "category": "text",
  "activationDate": "2025-02-22T08:40:35.583Z",
  "endOfNewSalesDate": "2025-02-22T08:40:35.583Z",
  "endOfRenewalDate": "2025-02-22T08:40:35.583Z",
  "endOfLifeDate": "2025-02-22T08:40:35.583Z",
  "isFrameworkProduct": true,
  "externalERPId": "text",
  "externalCRMId": "text",
  "created": "2025-02-22T08:40:35.583Z",
  "modified": "2025-02-22T08:40:35.583Z",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "chargePlans": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "chargePlanNumber": "text",
      "name": "text",
      "effectiveStartDate": "2025-02-22T08:40:35.583Z",
      "endOfNewSalesDate": "2025-02-22T08:40:35.583Z",
      "effectiveEndDate": "2025-02-22T08:40:35.583Z",
      "created": "2025-02-22T08:40:35.583Z",
      "modified": "2025-02-22T08:40:35.583Z",
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "charges": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "chargeNumber": "C-000001",
          "name": "text",
          "unitCode": "text",
          "defaultQuantity": 1,
          "createInvoiceLinesPerTier": true,
          "specificBillingDay": 1,
          "taxTemplate": "text",
          "taxIncluded": true,
          "externalERPId": "text",
          "externalCRMId": "text",
          "created": "2025-02-22T08:40:35.583Z",
          "modified": "2025-02-22T08:40:35.583Z",
          "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"
            }
          ],
          "model": "Flat",
          "chargeType": "OneOff",
          "pricePeriod": "Monthly",
          "usageRating": "Sum",
          "billingDay": "None",
          "billingPeriod": "Monthly",
          "periodAlignment": "None",
          "billingTiming": "InAdvance"
        }
      ]
    }
  ],
  "productType": "Simple"
}

Success

Delete charge plan

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

delete

/Products/chargePlans/{id}

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.younium.com/Products/chargePlans/{id}'

200

400

401

403

404

No body

Success

Delete charges

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

delete

/Products/charges/{id}

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.younium.com/Products/charges/{id}'

200

400

401

403

404

No body

Success