Orders

Get any version of a SalesOrder or Subscription by id.

get

Can be used when an orderId can be both a SalesOrder and a Subscription and any version. Response body will be either a SalesOrderResponse or a SubscriptionResponse.

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

get

HTTPcURLJavaScriptPython

GET /Orders/{id} HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content

Get Charge by Id

get

Get any version of a subscription or a sales order Charge.

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

HTTPcURLJavaScriptPython

GET /Orders/Charges/{id} HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "chargeNumber": "OPC-000001",
  "version": 1,
  "isLastVersion": true,
  "name": "text",
  "chargeType": "OneOff",
  "priceModel": "Flat",
  "effectiveStartDate": "2025-06-23T08:58:39.260Z",
  "effectiveEndDate": "2025-06-23T08:58:39.260Z",
  "quantity": 1,
  "unitCode": "text",
  "startOn": "AlignToSubscription",
  "endOn": "AlignToSubscription",
  "chargedThroughDate": "2025-06-23T08:58:39.260Z",
  "lastRenewalDate": "2025-06-23T08:58:39.260Z",
  "lastPriceAdjustmentDate": "2025-06-23T08:58:39.260Z",
  "pricePeriod": "Monthly",
  "usageRating": "Sum",
  "revenueRecognitionRule": "text",
  "billingDay": "None",
  "specificBillingDay": 1,
  "billingPeriod": "Monthly",
  "billingTiming": "InAdvance",
  "periodAlignment": "None",
  "alignmentDate": "2025-06-23T08:58:39.260Z",
  "taxTemplate": "text",
  "taxIncluded": true,
  "createInvoiceLinesPerTier": true,
  "estimatedUsage": 1,
  "estimatedQuantity": 1,
  "remainingQuantity": 1,
  "orderedQuantity": 1,
  "remarks": "text",
  "accountsReceivableAccount": "text",
  "deferredRevenueAccount": "text",
  "recognizedRevenueAccount": "text",
  "changeState": "NotChanged",
  "displayPrice": 1,
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "priceDetails": [
    {
      "tier": 1,
      "price": 1,
      "listPrice": 1,
      "description": "text",
      "fromQuantity": 1,
      "toQuantity": 1,
      "priceBase": "Flat",
      "lineDiscountPercent": 1,
      "lineDiscountAmount": 1
    }
  ],
  "recurringMonthlyAmount": 1,
  "recurringMonthlyAmountBase": 1,
  "features": [
    {
      "code": "text",
      "description": "text"
    }
  ],
  "orderDiscounts": [
    {
      "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
      "chargeId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "externalERPId": "text",
  "externalCRMId": "text",
  "cmrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-06-23T08:58:39.260Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "acv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-06-23T08:58:39.260Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "tcv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-06-23T08:58:39.260Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "emrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-06-23T08:58:39.260Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "oneTimeFees": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-06-23T08:58:39.260Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
  "orderId": "123e4567-e89b-12d3-a456-426614174000",
  "chargeId": "123e4567-e89b-12d3-a456-426614174000",
  "created": "2025-06-23T08:58:39.260Z",
  "modified": "2025-06-23T08:58:39.260Z"
}

Update order product charge

patch

Authorizations

Path parameters

idstring · uuidRequired

Header parameters

api-versionstringOptional

Body

all ofOptional

Responses

200

Success

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

patch

HTTPcURLJavaScriptPython

PATCH /Orders/Charges/{id} HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/merge-patch+json
Accept: */*
Content-Length: 139

{
  "description": "text",
  "remarks": "text",
  "externalERPId": "text",
  "externalCRMId": "text",
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

No content

Get Charges by order id

get

Authorizations

Path parameters

idstring · uuidRequired

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

HTTPcURLJavaScriptPython

GET /Orders/{id}/charges HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "pageNumber": 1,
  "pageSize": 1,
  "totalPages": 1,
  "totalCount": 1,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com",
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "chargeNumber": "OPC-000001",
      "version": 1,
      "isLastVersion": true,
      "name": "text",
      "chargeType": "OneOff",
      "priceModel": "Flat",
      "effectiveStartDate": "2025-06-23T08:58:39.260Z",
      "effectiveEndDate": "2025-06-23T08:58:39.260Z",
      "quantity": 1,
      "unitCode": "text",
      "startOn": "AlignToSubscription",
      "endOn": "AlignToSubscription",
      "chargedThroughDate": "2025-06-23T08:58:39.260Z",
      "lastRenewalDate": "2025-06-23T08:58:39.260Z",
      "lastPriceAdjustmentDate": "2025-06-23T08:58:39.260Z",
      "pricePeriod": "Monthly",
      "usageRating": "Sum",
      "revenueRecognitionRule": "text",
      "billingDay": "None",
      "specificBillingDay": 1,
      "billingPeriod": "Monthly",
      "billingTiming": "InAdvance",
      "periodAlignment": "None",
      "alignmentDate": "2025-06-23T08:58:39.260Z",
      "taxTemplate": "text",
      "taxIncluded": true,
      "createInvoiceLinesPerTier": true,
      "estimatedUsage": 1,
      "estimatedQuantity": 1,
      "remainingQuantity": 1,
      "orderedQuantity": 1,
      "remarks": "text",
      "accountsReceivableAccount": "text",
      "deferredRevenueAccount": "text",
      "recognizedRevenueAccount": "text",
      "changeState": "NotChanged",
      "displayPrice": 1,
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "priceDetails": [
        {
          "tier": 1,
          "price": 1,
          "listPrice": 1,
          "description": "text",
          "fromQuantity": 1,
          "toQuantity": 1,
          "priceBase": "Flat",
          "lineDiscountPercent": 1,
          "lineDiscountAmount": 1
        }
      ],
      "recurringMonthlyAmount": 1,
      "recurringMonthlyAmountBase": 1,
      "features": [
        {
          "code": "text",
          "description": "text"
        }
      ],
      "orderDiscounts": [
        {
          "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
          "chargeId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "externalERPId": "text",
      "externalCRMId": "text",
      "cmrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-06-23T08:58:39.260Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-06-23T08:58:39.260Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-06-23T08:58:39.260Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-06-23T08:58:39.260Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-06-23T08:58:39.260Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "chargeId": "123e4567-e89b-12d3-a456-426614174000",
      "created": "2025-06-23T08:58:39.260Z",
      "modified": "2025-06-23T08:58:39.260Z"
    }
  ]
}

Get Charges by order product id

get

Authorizations

Path parameters

idstring · uuidRequired

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

HTTPcURLJavaScriptPython

GET /Orders/Products/{id}/charges HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "pageNumber": 1,
  "pageSize": 1,
  "totalPages": 1,
  "totalCount": 1,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com",
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "chargeNumber": "OPC-000001",
      "version": 1,
      "isLastVersion": true,
      "name": "text",
      "chargeType": "OneOff",
      "priceModel": "Flat",
      "effectiveStartDate": "2025-06-23T08:58:39.260Z",
      "effectiveEndDate": "2025-06-23T08:58:39.260Z",
      "quantity": 1,
      "unitCode": "text",
      "startOn": "AlignToSubscription",
      "endOn": "AlignToSubscription",
      "chargedThroughDate": "2025-06-23T08:58:39.260Z",
      "lastRenewalDate": "2025-06-23T08:58:39.260Z",
      "lastPriceAdjustmentDate": "2025-06-23T08:58:39.260Z",
      "pricePeriod": "Monthly",
      "usageRating": "Sum",
      "revenueRecognitionRule": "text",
      "billingDay": "None",
      "specificBillingDay": 1,
      "billingPeriod": "Monthly",
      "billingTiming": "InAdvance",
      "periodAlignment": "None",
      "alignmentDate": "2025-06-23T08:58:39.260Z",
      "taxTemplate": "text",
      "taxIncluded": true,
      "createInvoiceLinesPerTier": true,
      "estimatedUsage": 1,
      "estimatedQuantity": 1,
      "remainingQuantity": 1,
      "orderedQuantity": 1,
      "remarks": "text",
      "accountsReceivableAccount": "text",
      "deferredRevenueAccount": "text",
      "recognizedRevenueAccount": "text",
      "changeState": "NotChanged",
      "displayPrice": 1,
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "priceDetails": [
        {
          "tier": 1,
          "price": 1,
          "listPrice": 1,
          "description": "text",
          "fromQuantity": 1,
          "toQuantity": 1,
          "priceBase": "Flat",
          "lineDiscountPercent": 1,
          "lineDiscountAmount": 1
        }
      ],
      "recurringMonthlyAmount": 1,
      "recurringMonthlyAmountBase": 1,
      "features": [
        {
          "code": "text",
          "description": "text"
        }
      ],
      "orderDiscounts": [
        {
          "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
          "chargeId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "externalERPId": "text",
      "externalCRMId": "text",
      "cmrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-06-23T08:58:39.260Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-06-23T08:58:39.260Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-06-23T08:58:39.260Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-06-23T08:58:39.260Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-06-23T08:58:39.260Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "chargeId": "123e4567-e89b-12d3-a456-426614174000",
      "created": "2025-06-23T08:58:39.260Z",
      "modified": "2025-06-23T08:58:39.260Z"
    }
  ]
}

Edit InvoicedToDate on Charge

post

Set or edit invoiced to date on order product charge The Invoiced To date cannot be before the charges effective start date or the current invoiced to date. In the order product charge response the field for invoiced to date is referred to as 'chargedThroughDate'

Authorizations

Path parameters

idstring · uuidRequired

Header parameters

api-versionstringOptional

younium-idempotency-keystringOptional

younium-idempotency-durationInHoursintegerOptional

Body

all ofOptional

Responses

204

No Content

400

Bad Request.

application/json

401

Unauthorized

403

Forbidden

404

Not Found

application/json

post

HTTPcURLJavaScriptPython

POST /Orders/Charges/{id}/InvoicedTo HTTP/1.1
Host: api.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "invoicedToDate": "2025-06-23T08:58:39.260Z"
}

No content

---