### Dynamic Documentation Query Example Source: https://developer.younium.com/documentation/developer-resources/api-v3-name To get information not explicitly present on a page, perform an HTTP GET request to the page URL with an `ask` query parameter containing your question in natural language. ```http GET https://developer.younium.com/documentation/developer-resources/api-v3-name.md?ask= ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://developer.younium.com/documentation/environments To get dynamic information or clarifications not explicitly present on a page, perform an HTTP GET request to the page URL with the 'ask' query parameter. The question should be specific and self-contained. ```http GET https://developer.younium.com/documentation/environments.md?ask= ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://developer.younium.com/api-s/api-2.1/accounts Perform an HTTP GET request to the current page URL with the `ask` query parameter to dynamically query the documentation. The question should be specific and self-contained. ```http GET https://developer.younium.com/api-s/api-2.1/accounts.md?ask= ``` -------------------------------- ### Query Documentation Dynamically Source: https://developer.younium.com/get-started To get information not explicitly present on the page, make a GET request to the page URL with an 'ask' query parameter containing your question. ```http GET https://developer.younium.com/get-started.md?ask= ``` -------------------------------- ### Query Documentation Dynamically Source: https://developer.younium.com/documentation/idempotent-requests To get additional information not directly present on the page, perform an HTTP GET request with the `ask` query parameter. The question should be specific and self-contained. ```http GET https://developer.younium.com/documentation/idempotent-requests.md?ask= ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://developer.younium.com/api-s/api-2.1/subscriptions Perform an HTTP GET request on a documentation URL with the 'ask' query parameter to ask a specific, self-contained question in natural language. The response will contain a direct answer and relevant excerpts. ```http GET https://developer.younium.com/api-s/api-2.1/subscriptions.md?ask= ``` -------------------------------- ### Querying Documentation Dynamically Source: https://developer.younium.com/documentation/developer-resources/api-v3-name Provides instructions on how to dynamically query the documentation using an HTTP GET request with the `ask` query parameter to get specific information not explicitly present on the page. ```APIDOC # Agent Instructions: Querying This Documentation Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://developer.younium.com/documentation/developer-resources/api-v3-name.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. ``` -------------------------------- ### Filter API Results by String Start Source: https://developer.younium.com/documentation/developer-resources/developer-resources Filter string fields to find values that start with a specific prefix. Use the 'startswith' function. ```http https://api.sandbox.younium.com/ChartOfAccounts?filter=startswith(code, '3') ``` -------------------------------- ### Get All Exchange Rates Source: https://developer.younium.com/api-s/api-2.1/exchangerate Retrieves a list of all available exchange rates. This endpoint is useful for getting an overview of all currency conversion rates. ```APIDOC ## GET /ExchangeRate ### Description Retrieves a list of all exchange rates. ### Method GET ### Endpoint /ExchangeRate ### Response (Schema defined in youniumv2-prod.json) ``` -------------------------------- ### Get All Simple Products Source: https://developer.younium.com/api-s/api-2.1/simpleproducts Retrieves a list of all simple products available in the system. ```APIDOC ## GET /SimpleProducts ### Description Retrieves a list of all simple products. ### Method GET ### Endpoint /SimpleProducts ### Response #### Success Response (200) - **products** (array) - A list of simple product objects. #### Response Example { "products": [ { "id": "string", "name": "string", "description": "string", "price": 0, "currency": "string" } ] } ``` -------------------------------- ### Example Insights API Request Source: https://developer.younium.com/documentation/developer-resources/insights-api A comprehensive example demonstrating the use of multiple OData query parameters to retrieve and filter recurring revenue data. It includes counting records, setting format, ordering, skipping, topping, filtering by date and ARR, and grouping with aggregation. ```http GET https://api.younium.com/insights/Odata/recurringrevenue ?$count=true &$format=application/json; odata.metadata=none &$orderby=AccountName desc &$skip=0 &$top=1000 &$apply=filter(YearMonth ge 202501 AND YearMonth le 202501 AND ARR ne 0)/ groupby((AccountName,ChargeNumber,YearMonth), aggregate(ARR with sum as ARR)) ``` -------------------------------- ### Get All Users Source: https://developer.younium.com/api-s/api-2.1/users Retrieves a list of all users in the system. ```APIDOC ## GET /Users ### Description Retrieves a list of all users. ### Method GET ### Endpoint /Users ``` -------------------------------- ### Get Product by ID Source: https://developer.younium.com/api-s/api-2.1/products Retrieves a specific product by its ID. ```APIDOC ## GET /Products/{id} ### Description Retrieves a specific product by its ID. ### Method GET ### Endpoint /Products/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the product. ``` -------------------------------- ### Get All Roles Source: https://developer.younium.com/api-s/api-2.1/users Retrieves a list of all available roles in the system. ```APIDOC ## GET /Users/roles ### Description Retrieves a list of all user roles. ### Method GET ### Endpoint /Users/roles ``` -------------------------------- ### Get All Subscription Products Source: https://developer.younium.com/api-s/api-data_export/subscriptionproducts Retrieves a list of all available subscription products. ```APIDOC ## GET /subscription-products ### Description Retrieves a comprehensive list of all subscription products available in the system. ### Method GET ### Endpoint /subscription-products ### Response #### Success Response (200) - The response will contain a list of subscription products. ``` -------------------------------- ### Full Product Response Example Source: https://developer.younium.com/documentation/product-guide Demonstrates the structure of a full product response, which can include multiple charge plans, each with multiple charges. ```json "product": { "productNumber": "P-000001", "chargePlans": [ { "chargePlanNumber": "CP-000001", "charges": [ { "chargeNumber": "C-000001", "priceDetails": [...] }, { "chargeNumber": "C-000002", "priceDetails": [...] } ] }, { "chargePlanNumber": "CP-000002", "charges": [ { "chargeNumber": "C-000003", "priceDetails": [...] }, { "chargeNumber": "C-000004", "priceDetails": [...] }, { "chargeNumber": "C-000005", "priceDetails": [...] } ] }, ] } ``` -------------------------------- ### Get All Currencies Source: https://developer.younium.com/api-s/api-2.1/currency Retrieves a list of all available currencies. ```APIDOC ## GET /Currency ### Description Retrieves a list of all available currencies. ### Method GET ### Endpoint /Currency ``` -------------------------------- ### Get Product Features Source: https://developer.younium.com/api-s/api-2.1/products Retrieves a list of available product features. ```APIDOC ## GET /Products/productFeatures ### Description Fetches a list of all available product features. ### Method GET ### Endpoint /Products/productFeatures ``` -------------------------------- ### Simple Product Response Example Source: https://developer.younium.com/documentation/product-guide Illustrates the structure of a simple product response, containing one charge plan with a single charge. ```json "product": { "productNumber": "P-000001", "chargePlans": [ { "chargePlanNumber": "CP-000001", "charges": [ { "chargeNumber": "C-000001", "priceDetails": [...] } ] } ] } ``` -------------------------------- ### Get All Usage Records Source: https://developer.younium.com/api-s/api-2.1/usage Retrieves a list of all usage records. ```APIDOC ## GET /Usage ### Description Retrieves a list of all usage records. ### Method GET ### Endpoint /Usage ``` -------------------------------- ### Get All Tax Templates Source: https://developer.younium.com/api-s/api-2.1/taxtemplates Retrieves a list of all available tax templates. ```APIDOC ## GET /TaxTemplates ### Description Retrieves a list of all available tax templates. ### Method GET ### Endpoint /TaxTemplates ### Response #### Success Response (200) - **taxTemplates** (array) - A list of tax template objects. ``` -------------------------------- ### Get Subscription Products Source: https://developer.younium.com/api-s/api-data_export/subscriptions Retrieves the products associated with a specific subscription. ```APIDOC ## GET /subscriptions/{id}/subscription-products ### Description Retrieves the products associated with a specific subscription. ### Method GET ### Endpoint /subscriptions/{id}/subscription-products ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the subscription. ### Response #### Success Response (200) - **[Response fields will be detailed in the OpenAPI schema]** #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Get Subscription Discounts Source: https://developer.younium.com/api-s/api-data_export/subscriptions Retrieves the discounts applied to a specific subscription. ```APIDOC ## GET /subscriptions/{id}/discounts ### Description Retrieves the discounts applied to a specific subscription. ### Method GET ### Endpoint /subscriptions/{id}/discounts ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the subscription. ### Response #### Success Response (200) - **[Response fields will be detailed in the OpenAPI schema]** #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Get Base Currency Source: https://developer.younium.com/api-s/api-2.1/currency Retrieves the base currency information. ```APIDOC ## GET /Currency/BaseCurrency ### Description Retrieves the base currency information. ### Method GET ### Endpoint /Currency/BaseCurrency ``` -------------------------------- ### Get Subscription Product Metrics Source: https://developer.younium.com/api-s/api-data_export/subscriptionproducts Retrieves metrics for a specific subscription product. ```APIDOC ## GET /subscription-products/{id}/metrics ### Description Retrieves metrics associated with a specific subscription product identified by its ID. ### Method GET ### Endpoint /subscription-products/{id}/metrics ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the subscription product. ### Response #### Success Response (200) - The response will contain detailed metrics for the specified subscription product. ``` -------------------------------- ### Get Simple Product by ID Source: https://developer.younium.com/api-s/api-2.1/simpleproducts Retrieves details for a specific simple product using its unique identifier. ```APIDOC ## GET /SimpleProducts/{id} ### Description Retrieves details for a specific simple product by its ID. ### Method GET ### Endpoint /SimpleProducts/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the simple product. ### Response #### Success Response (200) - **product** (object) - The simple product object with its details. #### Response Example { "product": { "id": "string", "name": "string", "description": "string", "price": 0, "currency": "string" } } ``` -------------------------------- ### Get All Custom Field Configurations Source: https://developer.younium.com/api-s/api-2.1/customfieldconfigurations Retrieves a list of all custom field configurations. ```APIDOC ## GET /CustomFieldConfigurations ### Description Retrieves a list of all custom field configurations. ### Method GET ### Endpoint /CustomFieldConfigurations ``` -------------------------------- ### Get Account Summary Source: https://developer.younium.com/api-s/api-2.1/accounts Retrieves a summary of information for a specific account. ```APIDOC ## GET /Accounts/{id}/Summary ### Description Retrieves a summary of information for a specific account. ### Method GET ### Endpoint /Accounts/{id}/Summary ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the account. ``` -------------------------------- ### Create Minimal Subscription Source: https://developer.younium.com/documentation/subscription-guide Use this to create a draft subscription without products. The subscription starts on the first of the next month by default. Reference an existing account. ```json { "account": "A-000002", "status": "active", "effectiveStartDate": "2025-07-01", "currency": "SEK", "products": [ { "product": "P-000001" } ] } ``` -------------------------------- ### Get Subscription Metrics Source: https://developer.younium.com/api-s/api-data_export/subscriptions Retrieves performance metrics for a specific subscription. ```APIDOC ## GET /subscriptions/{id}/metrics ### Description Retrieves performance metrics for a specific subscription. ### Method GET ### Endpoint /subscriptions/{id}/metrics ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the subscription. ### Response #### Success Response (200) - **[Response fields will be detailed in the OpenAPI schema]** #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Get All Chart of Accounts Source: https://developer.younium.com/api-s/api-2.1/chartofaccounts Retrieves a list of all chart of accounts entries. ```APIDOC ## GET /ChartOfAccounts ### Description Retrieves a list of all chart of accounts entries. ### Method GET ### Endpoint /ChartOfAccounts ``` -------------------------------- ### Get Product by Charge ID Source: https://developer.younium.com/api-s/api-2.1/products Retrieves product information associated with a specific charge ID. ```APIDOC ## GET /Products/FromCharge/{id} ### Description Retrieves product information linked to a given charge ID. ### Method GET ### Endpoint /Products/FromCharge/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the charge. ``` -------------------------------- ### Get All Subscription Product Charges Source: https://developer.younium.com/api-s/api-data_export/subscriptionproductcharges Retrieves a list of all subscription product charges. This endpoint is useful for obtaining an overview of all charges. ```APIDOC ## GET /subscription-product-charges ### Description Retrieves a list of all subscription product charges. ### Method GET ### Endpoint /subscription-product-charges ### Response #### Success Response (200) - The response will contain a list of subscription product charges. (Specific fields not detailed in source) ``` -------------------------------- ### Create Full Product Example Source: https://developer.younium.com/documentation/product-guide Defines a 'SaaS' product with 'Starter' and 'Professional' charge plans. Use this structure to set up recurring base fees and tiered seat pricing for different currencies. ```json { "name": "SaaS", "productType": "Full", "category": "Core service", "isFrameworkProduct": false, "chargePlans": [ { "name": "Starter", "charges": [ { "name": "Starter base fee", "model": "Flat", "chargeType": "Recurring", "priceDetails": [ { "currency": "EUR", "price": 99 }, { "currency": "USD", "price": 99 } ] }, { "name": "Starter seats fee", "model": "Tiered", "chargeType": "Recurring", "defaultQuantity": 5, "unit": { "key": "unit", "value": "seats" }, "priceDetails": [ { "tier": 0, "currency": "EUR", "toQuantity": 5, "priceBase": "perUnit", "price": 0 }, { "tier": 1, "currency": "EUR", "toQuantity": 20, "priceBase": "perUnit", "price": 30 }, { "tier": 2, "currency": "EUR", "isInfinite": true, "priceBase": "perUnit", "price": 20 }, { "tier": 0, "currency": "USD", "toQuantity": 5, "priceBase": "perUnit", "price": 0 }, { "tier": 1, "currency": "USD", "toQuantity": 20, "priceBase": "perUnit", "price": 30 }, { "tier": 2, "currency": "USD", "isInfinite": true, "priceBase": "perUnit", "price": 20 } ] } ] }, { "name": "Professional", "charges": [ { "name": "Professional base fee", "model": "Flat", "chargeType": "Recurring", "priceDetails": [ { "currency": "EUR", "price": 400 }, { "currency": "USD", "price": 400 } ] }, { "name": "Professional seats fee", "model": "Tiered", "chargeType": "Recurring", "defaultQuantity": 15, "unit": { "key": "unit", "value": "seats" }, "priceDetails": [ { "tier": 0, "currency": "EUR", "toQuantity": 5, "priceBase": "perUnit", "price": 0 }, { "tier": 1, "currency": "EUR", "toQuantity": 20, "priceBase": "perUnit", "price": 30 }, { "tier": 2, "currency": "EUR", "isInfinite": true, ``` -------------------------------- ### Get Subscription Product Charges Source: https://developer.younium.com/api-s/api-data_export/subscriptionproducts Retrieves charges associated with a specific subscription product. ```APIDOC ## GET /subscription-products/{id}/subscription-product-charges ### Description Retrieves all charges related to a specific subscription product, identified by its ID. ### Method GET ### Endpoint /subscription-products/{id}/subscription-product-charges ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the subscription product. ### Response #### Success Response (200) - The response will contain a list of charges for the specified subscription product. ``` -------------------------------- ### Get Product by Charge Plan ID Source: https://developer.younium.com/api-s/api-2.1/products Retrieves product information associated with a specific charge plan ID. ```APIDOC ## GET /Products/FromChargePlan/{id} ### Description Retrieves product information linked to a given charge plan ID. ### Method GET ### Endpoint /Products/FromChargePlan/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the charge plan. ``` -------------------------------- ### Create Product Source: https://developer.younium.com/documentation/product-guide Use the POST /products endpoint to create new products. This example demonstrates creating a simple subscription product with a monthly recurring flat fee. ```APIDOC ## POST /products ### Description Creates a new product in the system. ### Method POST ### Endpoint /products ### Request Body - **name** (string) - Required - The name of the product. - **productType** (string) - Required - The type of product (e.g., "Simple"). - **category** (string) - Required - The product category for organization. - **isFrameworkProduct** (boolean) - Required - Indicates if the product is a framework product. - **chargePlans** (array) - Required - A list of charge plans associated with the product. - **name** (string) - Required - The name of the charge plan. - **charges** (array) - Required - A list of charges within the charge plan. - **name** (string) - Required - The name of the charge. - **model** (string) - Required - The pricing model (e.g., "Flat"). - **chargeType** (string) - Required - The type of charge (e.g., "Recurring"). - **pricePeriod** (string) - Required - The period for the price (e.g., "Monthly"). - **billingDay** (string) - Required - The billing day rule (e.g., "FromOrder"). - **specificBillingDay** (integer) - Optional - Specific day for billing if applicable. - **billingPeriod** (string) - Required - The billing period (e.g., "Annual"). - **periodAlignment** (string) - Required - Alignment of the billing period (e.g., "AlignToOrder"). - **billingTiming** (string) - Required - Timing of the billing (e.g., "InAdvance"). - **taxTemplate** (string) - Required - The tax template to apply. - **taxIncluded** (boolean) - Required - Whether tax is included in the price. - **deferredRevenueAccount** (string) - Optional - Account for deferred revenue. - **recognizedRevenueAccount** (string) - Optional - Account for recognized revenue. - **customFields** (object) - Optional - Custom fields for the charge. - **priceDetails** (array) - Required - Pricing rules for the charge. - **currency** (string) - Required - The currency code (e.g., "SEK"). - **price** (number) - Required - The price for the currency. - **tierIndex** (integer) - Optional - The index of the tier (defaults to 0 if not specified for flat/quantity models). - **toQuantity** (number) - Optional - The upper limit for the tier. - **isInfinite** (boolean) - Optional - Indicates if the tier has an infinite quantity. - **customFields** (object) - Optional - Custom fields for the product. ### Request Example ```json { "name": "SaaS", "productType": "Simple", "category": "Core service", "isFrameworkProduct": false, "chargePlans": [ { "name": "SaaS charge plan", "charges": [ { "name": "SaaS monthly fee", "model": "Flat", "chargeType": "Recurring", "pricePeriod": "Monthly", "billingDay": "FromOrder", "specificBillingDay": 0, "billingPeriod": "Annual", "periodAlignment": "AlignToOrder", "billingTiming": "InAdvance", "taxTemplate": "Sweden Standard", "taxIncluded": false, "deferredRevenueAccount": "24xx", "recognizedRevenueAccount": "30xx", "customFields": { "customChargeField": "string" }, "priceDetails": [ { "currency": "SEK", "price": 1099.00 }, { "currency": "EUR", "price": 99.00 }, { "currency": "DKK", "price": 749.00 }, { "currency": "USD", "price": 99.00 }, { "currency": "NOK", "price": 1099.00 } ] } ] } ], "customFields": { "customProductField": "string" } } ``` ### Response #### Success Response (200) - **productId** (string) - The unique identifier of the created product. - **message** (string) - Confirmation message. ``` -------------------------------- ### Filter API Results by GUID Equality Source: https://developer.younium.com/documentation/developer-resources/developer-resources Filter records by a GUID/UUID value. Specify the type as 'guid' before the value. ```http https://api.sandbox.younium.com/Accounts?filter=invoiceBatchGroupId eq guid'f68a9sa3-ff43-4f95-44b4-08f84be1dda4' ``` -------------------------------- ### Get Users By Role Source: https://developer.younium.com/api-s/api-2.1/users Retrieves a list of users associated with a specific role. ```APIDOC ## GET /Users/ByRole/{roleId} ### Description Retrieves users based on their assigned role. ### Method GET ### Endpoint /Users/ByRole/{roleId} ### Parameters #### Path Parameters - **roleId** (string) - Required - The ID of the role to filter users by. ``` -------------------------------- ### Create Product Source: https://developer.younium.com/api-s/api-2.1/products Creates a new product in the system. ```APIDOC ## POST /Products ### Description Creates a new product. ### Method POST ### Endpoint /Products ### Request Body (Schema not provided in source) ``` -------------------------------- ### Add Order Discount for All Charges Source: https://developer.younium.com/documentation/subscription-guide Use this to create an order discount that applies to all charges within a subscription. Specify start and end dates for its validity. ```json { "effectiveChangeDate": "2025-07-01", "products": [...], "orderDiscounts": [ { "operation": "create", "percent": 12, "onSpecificCharges": false, "startOn": "specificDate", "endOn": "specificDate", "startDate": "2024-07-01", "endDate": "2024-09-01" } ] } ``` -------------------------------- ### Webhook Subscription Response Source: https://developer.younium.com/documentation/webhooks This is an example of a successful response when subscribing to webhook events. It confirms the subscription details and provides a token for verification. ```json { "id": "49d5c950-925c-4863-f731-08dabe4f3d15", "url": "", "events": [ "AccountChanged", ... //List of events that the webhook will listen to. ], "token": "g67g5fd7-s7d0-32a5-bd7e-df0dwas67c6", //All triggered webhook requests will contain this token. "webhookStatus": "Enabled" } ``` -------------------------------- ### Perform HTTP GET Request with `ask` Parameter Source: https://developer.younium.com/api-s/api-2.1/invoices Use this method to query documentation dynamically. The `ask` parameter should contain a specific, self-contained question in natural language. The response includes a direct answer and relevant excerpts. ```http GET https://developer.younium.com/api-s/api-2.1/invoices.md?ask= ``` -------------------------------- ### Get Subscription Product Charges Metrics Source: https://developer.younium.com/api-s/api-data_export/subscriptionproductcharges Retrieves metrics related to subscription product charges. This endpoint is useful for analyzing charge-related data. ```APIDOC ## GET /subscription-product-charges/{id}/metrics ### Description Retrieves metrics for a specific subscription product charge. ### Method GET ### Endpoint /subscription-product-charges/{id}/metrics ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the subscription product charge. ### Response #### Success Response (200) - The response will contain metrics data related to the specified subscription product charge. (Specific fields not detailed in source) ``` -------------------------------- ### Get Invoice Batch Group by ID Source: https://developer.younium.com/api-s/api-2.1/invoicebatchgroups Retrieves a specific invoice batch group by its unique identifier. Use this endpoint to get detailed information about a single invoice batch group. ```APIDOC ## GET /InvoiceBatchGroups/{id} ### Description Retrieves a specific invoice batch group by its ID. ### Method GET ### Endpoint /InvoiceBatchGroups/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the invoice batch group. ### Response #### Success Response (200) - **body** (object) - The details of the requested invoice batch group. ``` -------------------------------- ### Pagination Example Source: https://developer.younium.com/documentation/developer-resources/api-v3-name Illustrates how to use `pageNumber` and `pageSize` query parameters for paginating through large datasets. It also shows the structure of a paginated response, including the `items` and `nextPage` properties. ```APIDOC ## Pagination Pagination can be managed using the `pageNumber` and `pageSize` query parameters. * Some endpoints may have a maximum `pageSize` limit of 5000 records per request. * If not specified, the default `pageSize` is 100. ### Request Example ``` https://api.younium.com/v3/Subscriptions?pageSize=5000&pageNumber=2 ``` When retrieving multiple records, the response includes an `items` property with the records and a `nextPage` property indicating if more records are available. If the `nextPage` is absent, there are no more records to fetch. If no records exist, an empty list of items will be returned. ### Response Example ```json { "items": [ {...} ], "nextPage": "/subscriptions?pageNumber=2&pagesize=200" } ``` ``` -------------------------------- ### Get Charges for an Order Product Source: https://developer.younium.com/api-s/api-2.1/orders Retrieves charges associated with a specific product within an order. ```APIDOC ## GET /Orders/Products/{id}/charges ### Description Retrieves charges associated with a specific product within an order. ### Method GET ### Endpoint /Orders/Products/{id}/charges ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the product. ``` -------------------------------- ### Perform HTTP GET Request with 'ask' Parameter Source: https://developer.younium.com/api-s/api-2.1/products Use this method to query documentation dynamically when information is not directly available. The question should be specific and self-contained. The response includes the answer and relevant excerpts. ```http GET https://developer.younium.com/api-s/api-2.1/products.md?ask= ``` -------------------------------- ### Get Subscription Product Charge Details Source: https://developer.younium.com/api-s/api-data_export/subscriptionproductcharges Retrieves detailed information about a specific subscription product charge. This endpoint is useful for in-depth analysis of individual charges. ```APIDOC ## GET /subscription-product-charges/{id}/details ### Description Retrieves detailed information for a specific subscription product charge. ### Method GET ### Endpoint /subscription-product-charges/{id}/details ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the subscription product charge. ### Response #### Success Response (200) - The response will contain detailed information about the specified subscription product charge. (Specific fields not detailed in source) ``` -------------------------------- ### Create Active Subscription with Product and Charge Plan Source: https://developer.younium.com/documentation/subscription-guide Create an active subscription that includes at least one order product. Specify the product and charge plan, and optionally define explicit charges with quantities. ```json { "account": "A-000002", "status": "active", "effectiveStartDate": "2025-07-01", "currency": "SEK", "products": [ { "product": "P-000001", "chargePlan": "CP-000001", "charges": [ { "charge": "C-000001", "quantity": 20 } ] } ] } ``` -------------------------------- ### Get Invoice Attachments Source: https://developer.younium.com/api-s/api-2.1/invoices Retrieves attachments for a specific invoice. ```APIDOC ## GET /Invoices/{id}/Attachments ### Description Retrieves attachments associated with a specific invoice. ### Method GET ### Endpoint /Invoices/{id}/Attachments ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the invoice. ``` -------------------------------- ### Query Documentation Dynamically Source: https://developer.younium.com/documentation Perform an HTTP GET request to the documentation URL with the 'ask' query parameter to retrieve specific information. The question should be natural language, self-contained, and specific. Use this for clarifications, additional context, or related sections when information is not explicitly present. ```HTTP GET https://developer.younium.com/documentation.md?ask= ``` -------------------------------- ### Get Custom Field Configuration by Entity and Key Source: https://developer.younium.com/api-s/api-2.1/customfieldconfigurations Retrieves a custom field configuration based on entity and key. ```APIDOC ## GET /CustomFieldConfigurations/{entity}/{key} ### Description Retrieves a custom field configuration based on entity and key. ### Method GET ### Endpoint /CustomFieldConfigurations/{entity}/{key} ### Parameters #### Path Parameters - **entity** (string) - Required - The entity for which to retrieve the custom field configuration. - **key** (string) - Required - The key of the custom field configuration. ``` -------------------------------- ### Get Subscription Milestones Source: https://developer.younium.com/api-s/api-2.1/subscriptions Retrieves the milestones associated with a subscription. ```APIDOC ## GET /Subscriptions/{id}/milestones ### Description Retrieves the milestones associated with a subscription. ### Method GET ### Endpoint /Subscriptions/{id}/milestones ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the subscription to retrieve milestones for. ``` -------------------------------- ### Get Webhook by ID Source: https://developer.younium.com/api-s/api-2.1/webhooks Retrieves a specific webhook by its ID. ```APIDOC ## GET /Webhooks/{id} ### Description Retrieves a specific webhook by its ID. ### Method GET ### Endpoint /Webhooks/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the webhook. ### Response #### Success Response (200) - **field1** (type) - Description ``` -------------------------------- ### Perform HTTP GET Request to Query Documentation Source: https://developer.younium.com/api-s/api-2.1/journals Use this method to dynamically query documentation. The question should be specific, self-contained, and in natural language. The response will contain a direct answer and relevant excerpts. ```http GET https://developer.younium.com/api-s/api-2.1/journals.md?ask= ``` -------------------------------- ### Error Response for JWT Token Generation Source: https://developer.younium.com/get-started An example of an error response if authentication fails. This typically indicates invalid credentials or other authentication issues. ```json { errors: [""] } ``` -------------------------------- ### Create Simple Subscription Product Source: https://developer.younium.com/documentation/product-guide Use this JSON payload to create a new product with a monthly recurring flat fee subscription. Ensure price details are provided for each desired currency. ```json { "name": "SaaS", "productType": "Simple", "category": "Core service", "isFrameworkProduct": false, "chargePlans": [ { "name": "SaaS charge plan", "charges": [ { "name": "SaaS monthly fee", "model": "Flat", "chargeType": "Recurring", "pricePeriod": "Monthly", "billingDay": "FromOrder", "specificBillingDay": 0, "billingPeriod": "Annual", "periodAlignment": "AlignToOrder", "billingTiming": "InAdvance", "taxTemplate": "Sweden Standard", "taxIncluded": false, "deferredRevenueAccount": "24xx", "recognizedRevenueAccount": "30xx", "customFields": { "customChargeField": "string" }, "priceDetails": [ { "currency": "SEK", "price": 1099.00 }, { "currency": "EUR", "price": 99.00 }, { "currency": "DKK", "price": 749.00 }, { "currency": "USD", "price": 99.00 }, { "currency": "NOK", "price": 1099.00 } ] } ] } ], "customFields": { "customProductField": "string" } } ``` -------------------------------- ### List Products Source: https://developer.younium.com/api-s/api-2.1/products Retrieves a list of all products. ```APIDOC ## GET /Products ### Description Retrieves a list of all products. ### Method GET ### Endpoint /Products ``` -------------------------------- ### Create Account Source: https://developer.younium.com/api-s/api-2.1/accounts Creates a new account. ```APIDOC ## POST /Accounts ### Description Creates a new account. ### Method POST ### Endpoint /Accounts ``` -------------------------------- ### Successful JWT Token Response Source: https://developer.younium.com/get-started This is an example of a successful response when generating a JWT token. The access token is valid for 24 hours. ```json { "access_token": "eyJhbGciOiJSUzI1NiIsInR5cC...", "refresh_token": "4baf4774-5ef9-4983-a8d8-f4fdae7f7000", "expires_in": 86400, "expires": "Thu, 27 Sep 2025 11:12:01 GMT" } ``` -------------------------------- ### Get Subscription Milestones Source: https://developer.younium.com/api-s/api-data_export/subscriptions Retrieves the milestones associated with a specific subscription. ```APIDOC ## GET /subscriptions/{id}/milestones ### Description Retrieves the milestones associated with a specific subscription. ### Method GET ### Endpoint /subscriptions/{id}/milestones ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the subscription. ### Response #### Success Response (200) - **[Response fields will be detailed in the OpenAPI schema]** #### Response Example ```json { "example": "response body" } ``` ``` -------------------------------- ### Change Subscription: Create Order Product Source: https://developer.younium.com/documentation/subscription-guide Create a new order product for a subscription, referencing a product from the product catalog. Ensure the `effectiveChangeDate` is set. ```json { "effectiveChangeDate": "2024-09-01", "products": [ { "operation": "Create", "product": "P-000001", "chargePlan": "CP-000003" } ] } ``` -------------------------------- ### Get Account Invoices Source: https://developer.younium.com/api-s/api-2.1/accounts Retrieves a list of invoices for a specific account. ```APIDOC ## GET /Accounts/{id}/Invoices ### Description Retrieves a list of invoices for a specific account. ### Method GET ### Endpoint /Accounts/{id}/Invoices ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the account. ``` -------------------------------- ### Get Journal Details Source: https://developer.younium.com/api-s/api-2.1/journals Retrieves detailed information about journal entries. ```APIDOC ## GET /Journals/JournalDetails ### Description Retrieves detailed information for journal entries. ### Method GET ### Endpoint /Journals/JournalDetails ### Response #### Success Response (200) - **[Response fields will be detailed in the OpenAPI schema]** ``` -------------------------------- ### Create and Post Payment Source: https://developer.younium.com/api-s/api-2.1/payments Creates a payment and immediately posts it. ```APIDOC ## POST /Payments/CreateAndPost ### Description Creates and posts a payment. ### Method POST ### Endpoint /Payments/CreateAndPost ### Request Body (Schema not provided in source) ### Response (Schema not provided in source) ``` -------------------------------- ### Create Currency Source: https://developer.younium.com/api-s/api-2.1/currency Creates a new currency entry. ```APIDOC ## POST /Currency ### Description Creates a new currency entry. ### Method POST ### Endpoint /Currency ``` -------------------------------- ### Create Webhook Source: https://developer.younium.com/api-s/api-2.1/webhooks Creates a new webhook subscription. ```APIDOC ## POST /Webhooks ### Description Creates a new webhook subscription. ### Method POST ### Endpoint /Webhooks ### Request Body - **field1** (type) - Required/Optional - Description ### Response #### Success Response (200) - **field1** (type) - Description ``` -------------------------------- ### Get Charges for an Order Source: https://developer.younium.com/api-s/api-2.1/orders Retrieves all charges associated with a specific order. ```APIDOC ## GET /Orders/{id}/charges ### Description Retrieves all charges associated with a specific order. ### Method GET ### Endpoint /Orders/{id}/charges ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the order. ``` -------------------------------- ### Create Order Discount (All Charges) Source: https://developer.younium.com/documentation/subscription-guide Apply a discount to all charges within an order. Ensure the `onSpecificCharges` field is set to `false`. ```json { "account": "A-000002", "status": "active", "effectiveStartDate": "2025-07-01", "currency": "SEK", "products": [...], "orderDiscounts": [{ "operation": "create", "percent": 10, "onSpecificCharges": false, "startOn": "alignToOrder", "endOn": "alignToOrder", }], } ``` -------------------------------- ### Get Currency by ID Source: https://developer.younium.com/api-s/api-2.1/currency Retrieves a specific currency entry by its ID. ```APIDOC ## GET /Currency/{id} ### Description Retrieves a specific currency entry by its ID. ### Method GET ### Endpoint /Currency/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the currency to retrieve. ``` -------------------------------- ### Create Order Discount (Specific Charges) Source: https://developer.younium.com/documentation/subscription-guide Apply a discount to specific charges within an order by providing the `orderProductCharges` list. The `onSpecificCharges` field must be `true`. ```json { "account": "A-000002", "status": "active", "effectiveStartDate": "2025-07-01", "currency": "SEK", "products": [ { "product": "P-000001", "chargePlan": "CP-000001", "charges": [ { "charge": "C-000002", "quantity": 20, } ] }, { "product": "P-000002", "chargePlan": "CP-000004", "charges": [ { "charge": "C-000010", "quantity": 20, } ] } ], "orderDiscounts": [ { "operation": "Create", "percent": 5, "onSpecificCharges": true, "orderProductCharges": [{ "charge": "C-000002" }], } ], } ``` -------------------------------- ### Get Subscription by ID Source: https://developer.younium.com/api-s/api-2.1/subscriptions Retrieves a specific subscription using its unique identifier. ```APIDOC ## GET /Subscriptions/{id} ### Description Retrieves a specific subscription by its ID. ### Method GET ### Endpoint /Subscriptions/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the subscription. ``` -------------------------------- ### API V3 Pagination Example Source: https://developer.younium.com/documentation/developer-resources/api-v3-name Manage pagination by using the `pageSize` and `pageNumber` query parameters. Some endpoints have a maximum `pageSize` of 5000, with a default of 100 if not specified. The response includes a `nextPage` property to indicate if more records are available. ```url https://api.younium.com/v3/Subscriptions?pageSize=5000&pageNumber=2 ``` ```json { "items": [ {...} ], "nextPage": "/subscriptions?pageNumber=2&pagesize=200" } ``` -------------------------------- ### Get Account Subscriptions Source: https://developer.younium.com/api-s/api-2.1/accounts Retrieves a list of subscriptions associated with a specific account. ```APIDOC ## GET /Accounts/{id}/Subscriptions ### Description Retrieves a list of subscriptions associated with a specific account. ### Method GET ### Endpoint /Accounts/{id}/Subscriptions ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the account. ``` -------------------------------- ### List Webhooks Source: https://developer.younium.com/api-s/api-2.1/webhooks Retrieves a list of all configured webhooks. ```APIDOC ## GET /Webhooks ### Description Retrieves a list of all configured webhooks. ### Method GET ### Endpoint /Webhooks ### Response #### Success Response (200) - **field1** (type) - Description ``` -------------------------------- ### Get Accounting Transactions by Year Source: https://developer.younium.com/api-s/api-2.1/journals Retrieves accounting transactions for a specified year. ```APIDOC ## GET /Journals/AccountingTransactions/{year} ### Description Retrieves accounting transactions for a given year. ### Method GET ### Endpoint /Journals/AccountingTransactions/{year} ### Parameters #### Path Parameters - **year** (string) - Required - The year for which to retrieve transactions. ### Response #### Success Response (200) - **[Response fields will be detailed in the OpenAPI schema]** ``` -------------------------------- ### Get Account by ID Source: https://developer.younium.com/api-s/api-2.1/accounts Retrieves a specific account using its unique identifier. ```APIDOC ## GET /Accounts/{id} ### Description Retrieves a specific account using its unique identifier. ### Method GET ### Endpoint /Accounts/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the account. ``` -------------------------------- ### Get Role By ID Source: https://developer.younium.com/api-s/api-2.1/users Retrieves details for a specific role identified by its ID. ```APIDOC ## GET /Users/roles/{id} ### Description Retrieves a specific role by its unique identifier. ### Method GET ### Endpoint /Users/roles/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the role. ``` -------------------------------- ### Get Specific Usage Record Source: https://developer.younium.com/api-s/api-2.1/usage Retrieves a specific usage record by its ID. ```APIDOC ## GET /Usage/{id} ### Description Retrieves a specific usage record by its ID. ### Method GET ### Endpoint /Usage/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the usage record to retrieve. ``` -------------------------------- ### Create Subscription Source: https://developer.younium.com/api-s/api-2.1/subscriptions Creates a new subscription. ```APIDOC ## POST /Subscriptions ### Description Creates a new subscription. ### Method POST ### Endpoint /Subscriptions ``` -------------------------------- ### Get User By ID Source: https://developer.younium.com/api-s/api-2.1/users Retrieves details for a specific user identified by their ID. ```APIDOC ## GET /Users/{id} ### Description Retrieves a specific user by their unique identifier. ### Method GET ### Endpoint /Users/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the user. ``` -------------------------------- ### Change Price Details on a Changed Order Charge Source: https://developer.younium.com/documentation/subscription-guide This example demonstrates how to modify price details for a changed order charge. It shows operations for changing existing price tiers, creating new ones, and handling infinite price tiers. ```json { "effectiveChangeDate": "2024-09-01", "products": [ { "operation": "Change", "product": "OP-000237", "charges": [ { "charge": "OPC-000301", "priceDetails": [ { "toQuantity": 100, "operation": "Change", "tier": 1, "price": 100, "listPrice": 100, }, { "toQuantity": 400, "operation": "Create", "tier": 4, "price": 120, "listPrice": 120, }, { "isInfinite": true, "operation": "Create", "tier": 5, "price": 150, "listPrice": 150, } ] } ] } ] } ``` -------------------------------- ### Get Sales Order Version Source: https://developer.younium.com/api-s/api-2.1/salesorders Retrieves a specific version of a sales order. ```APIDOC ## GET /SalesOrders/{id}/version ### Description Retrieves a specific version of a sales order. ### Method GET ### Endpoint /SalesOrders/{id}/version #### Path Parameters - **id** (string) - Required - The identifier of the sales order. ```