Products

PreviousPaymentterms NextQuotes

Last updated 3 months ago

Was this helpful?

Get Product from ChargePlan Id

get

/Products/FromChargePlan/{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/FromChargePlan/{id}'

200

400

401

403

404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "productNumber": "text",
  "name": "text",
  "category": "text",
  "activationDate": "2025-02-22T08:40:08.627Z",
  "endOfNewSalesDate": "2025-02-22T08:40:08.627Z",
  "endOfRenewalDate": "2025-02-22T08:40:08.627Z",
  "endOfLifeDate": "2025-02-22T08:40:08.627Z",
  "isFrameworkProduct": true,
  "externalERPId": "text",
  "externalCRMId": "text",
  "created": "2025-02-22T08:40:08.627Z",
  "modified": "2025-02-22T08:40:08.627Z",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "chargePlans": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "chargePlanNumber": "text",
      "name": "text",
      "effectiveStartDate": "2025-02-22T08:40:08.627Z",
      "endOfNewSalesDate": "2025-02-22T08:40:08.627Z",
      "effectiveEndDate": "2025-02-22T08:40:08.627Z",
      "created": "2025-02-22T08:40:08.627Z",
      "modified": "2025-02-22T08:40:08.627Z",
      "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:08.627Z",
          "modified": "2025-02-22T08:40:08.627Z",
          "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

Get Product from Charge Id

get

/Products/FromCharge/{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/FromCharge/{id}'

200

400

401

403

404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "productNumber": "text",
  "name": "text",
  "category": "text",
  "activationDate": "2025-02-22T08:40:08.627Z",
  "endOfNewSalesDate": "2025-02-22T08:40:08.627Z",
  "endOfRenewalDate": "2025-02-22T08:40:08.627Z",
  "endOfLifeDate": "2025-02-22T08:40:08.627Z",
  "isFrameworkProduct": true,
  "externalERPId": "text",
  "externalCRMId": "text",
  "created": "2025-02-22T08:40:08.627Z",
  "modified": "2025-02-22T08:40:08.627Z",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "chargePlans": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "chargePlanNumber": "text",
      "name": "text",
      "effectiveStartDate": "2025-02-22T08:40:08.627Z",
      "endOfNewSalesDate": "2025-02-22T08:40:08.627Z",
      "effectiveEndDate": "2025-02-22T08:40:08.627Z",
      "created": "2025-02-22T08:40:08.627Z",
      "modified": "2025-02-22T08:40:08.627Z",
      "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:08.627Z",
          "modified": "2025-02-22T08:40:08.627Z",
          "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

Get Product Features

get

/Products/productFeatures

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/Products/productFeatures'

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": {
    "code": "text",
    "description": "text"
  }
}

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

Get Products

get

/Products

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

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

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

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",
      "activationDate": "2025-02-22T08:40:08.627Z",
      "endOfNewSalesDate": "2025-02-22T08:40:08.627Z",
      "endOfRenewalDate": "2025-02-22T08:40:08.627Z",
      "endOfLifeDate": "2025-02-22T08:40:08.627Z",
      "isFrameworkProduct": true,
      "externalERPId": "text",
      "externalCRMId": "text",
      "created": "2025-02-22T08:40:08.627Z",
      "modified": "2025-02-22T08:40:08.627Z",
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "chargePlans": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "chargePlanNumber": "text",
          "name": "text",
          "effectiveStartDate": "2025-02-22T08:40:08.627Z",
          "endOfNewSalesDate": "2025-02-22T08:40:08.627Z",
          "effectiveEndDate": "2025-02-22T08:40:08.627Z",
          "created": "2025-02-22T08:40:08.627Z",
          "modified": "2025-02-22T08:40:08.627Z",
          "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:08.627Z",
              "modified": "2025-02-22T08:40:08.627Z",
              "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

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:08.627Z",
  "endOfNewSalesDate": "2025-02-22T08:40:08.627Z",
  "endOfRenewalDate": "2025-02-22T08:40:08.627Z",
  "endOfLifeDate": "2025-02-22T08:40:08.627Z",
  "isFrameworkProduct": true,
  "externalERPId": "text",
  "externalCRMId": "text",
  "created": "2025-02-22T08:40:08.627Z",
  "modified": "2025-02-22T08:40:08.627Z",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "chargePlans": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "chargePlanNumber": "text",
      "name": "text",
      "effectiveStartDate": "2025-02-22T08:40:08.627Z",
      "endOfNewSalesDate": "2025-02-22T08:40:08.627Z",
      "effectiveEndDate": "2025-02-22T08:40:08.627Z",
      "created": "2025-02-22T08:40:08.627Z",
      "modified": "2025-02-22T08:40:08.627Z",
      "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:08.627Z",
          "modified": "2025-02-22T08:40:08.627Z",
          "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