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
get
GET /Orders/{id} HTTP/1.1
Host: api.sandbox.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
get
GET /Orders/Charges/{id} HTTP/1.1
Host: api.sandbox.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-07-14T16:32:17.208Z",
  "effectiveEndDate": "2025-07-14T16:32:17.208Z",
  "quantity": 1,
  "unitCode": "text",
  "startOn": "AlignToSubscription",
  "endOn": "AlignToSubscription",
  "chargedThroughDate": "2025-07-14T16:32:17.208Z",
  "lastRenewalDate": "2025-07-14T16:32:17.208Z",
  "lastPriceAdjustmentDate": "2025-07-14T16:32:17.208Z",
  "pricePeriod": "Monthly",
  "usageRating": "Sum",
  "revenueRecognitionRule": "text",
  "billingDay": "None",
  "specificBillingDay": 1,
  "offsetBillingDays": 1,
  "billingPeriod": "Monthly",
  "billingTiming": "InAdvance",
  "periodAlignment": "None",
  "alignmentDate": "2025-07-14T16:32:17.208Z",
  "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-07-14T16:32:17.208Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "acv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-07-14T16:32:17.208Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "tcv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-07-14T16:32:17.208Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "emrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-07-14T16:32:17.208Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "oneTimeFees": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-07-14T16:32:17.208Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "price": 1,
  "listPrice": 1,
  "discountAmount": 1,
  "discountPercentage": 1,
  "totalPrice": 1,
  "totalListPrice": 1,
  "totalDiscountAmount": 1,
  "totalDiscountPercentage": 1,
  "totalPerInvoice": 1,
  "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
  "orderId": "123e4567-e89b-12d3-a456-426614174000",
  "chargeId": "123e4567-e89b-12d3-a456-426614174000",
  "created": "2025-07-14T16:32:17.208Z",
  "modified": "2025-07-14T16:32:17.208Z"
}

Update order product charge

patch
Authorizations
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
Body
all ofOptional
Responses
200
Success
patch
PATCH /Orders/Charges/{id} HTTP/1.1
Host: api.sandbox.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

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
post
POST /Orders/Charges/{id}/InvoicedTo HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "invoicedToDate": "2025-07-14T16:32:17.208Z"
}
No content
PreviousMeasurementsNextPaymentterms

Last updated