Orders

Get any version of a SalesOrder or Subscription by id.

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.

GEThttps://api.younium.com/Orders/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Response

200400401403404

Success

Request

JavaScriptCurlPython

const response = await fetch('https://api.younium.com/Orders/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

400404

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Get Charge by Id

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

GEThttps://api.younium.com/Orders/Charges/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Response

200400401403404

Success

Body

application/json

idstring (uuid)

chargeNumbernullable string

Example: "OPC-000001"

versioninteger (int32)

isLastVersionboolean

namenullable string

chargeTypeall of

priceModelall of

effectiveStartDatenullable string (date-time)

effectiveEndDatenullable string (date-time)

quantitynullable number (double)

unitCodenullable string

startOnall of

endOnall of

chargedThroughDatenullable string (date-time)

lastRenewalDatenullable string (date-time)

lastPriceAdjustmentDatenullable string (date-time)

pricePeriodall of

usageRatingall of

revenueRecognitionRulenullable string

billingDayall of

specificBillingDayinteger (int32)

billingPeriodall of

billingTimingall of

periodAlignmentall of

alignmentDatenullable string (date-time)

taxTemplatenullable string

taxIncludedboolean

createInvoiceLinesPerTierboolean

estimatedUsageinteger (int32)

estimatedQuantityinteger (int32)

remainingQuantitynullable number (double)

orderedQuantitynullable number (double)

remarksnullable string

accountsReceivableAccountnullable string

deferredRevenueAccountnullable string

recognizedRevenueAccountnullable string

changeStateall of

displayPricenullable number (double)

customFieldsnullable object

priceDetailsnullable array of OrderChargeDetailsResponse (object)

recurringMonthlyAmountnullable number (double)

recurringMonthlyAmountBasenullable number (double)

featuresnullable array of FeatureResponse (object)

orderDiscountsnullable array of OrderDiscountsChargeResponse (object)

externalERPIdnullable string

externalCRMIdnullable string

cmrrnullable all of

acvnullable all of

tcvnullable all of

emrrnullable all of

oneTimeFeesnullable all of

orderProductIdstring (uuid)

orderIdstring (uuid)

chargeIdnullable string (uuid)

Id of the charge used to create the order product charge. Not to be confused with field 'id'

createdstring (date-time)

modifiedstring (date-time)

Request

JavaScriptCurlPython

const response = await fetch('https://api.younium.com/Orders/Charges/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "chargeNumber": "OPC-000001",
  "version": 0,
  "isLastVersion": false,
  "name": "text",
  "chargeType": {},
  "priceModel": {},
  "effectiveStartDate": "2024-12-22T01:50:23.241Z",
  "effectiveEndDate": "2024-12-22T01:50:23.241Z",
  "quantity": 0,
  "unitCode": "text",
  "startOn": {},
  "endOn": {},
  "chargedThroughDate": "2024-12-22T01:50:23.241Z",
  "lastRenewalDate": "2024-12-22T01:50:23.241Z",
  "lastPriceAdjustmentDate": "2024-12-22T01:50:23.241Z",
  "pricePeriod": {},
  "usageRating": {},
  "revenueRecognitionRule": "text",
  "billingDay": {},
  "specificBillingDay": 0,
  "billingPeriod": {},
  "billingTiming": {},
  "periodAlignment": {},
  "alignmentDate": "2024-12-22T01:50:23.241Z",
  "taxTemplate": "text",
  "taxIncluded": false,
  "createInvoiceLinesPerTier": false,
  "estimatedUsage": 0,
  "estimatedQuantity": 0,
  "remainingQuantity": 0,
  "orderedQuantity": 0,
  "remarks": "text",
  "accountsReceivableAccount": "text",
  "deferredRevenueAccount": "text",
  "recognizedRevenueAccount": "text",
  "changeState": {},
  "displayPrice": 0,
  "priceDetails": [
    {
      "tier": 0,
      "price": 0,
      "listPrice": 0,
      "description": "text",
      "fromQuantity": 0,
      "toQuantity": 0,
      "priceBase": {},
      "lineDiscountPercent": 0,
      "lineDiscountAmount": 0
    }
  ],
  "recurringMonthlyAmount": 0,
  "recurringMonthlyAmountBase": 0,
  "features": [
    {
      "code": "text",
      "description": "text"
    }
  ],
  "orderDiscounts": [
    {
      "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
      "chargeId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "externalERPId": "text",
  "externalCRMId": "text",
  "cmrr": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T01:50:23.241Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "acv": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T01:50:23.241Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "tcv": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T01:50:23.241Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "emrr": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T01:50:23.241Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "oneTimeFees": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T01:50:23.241Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
  "orderId": "123e4567-e89b-12d3-a456-426614174000",
  "chargeId": "123e4567-e89b-12d3-a456-426614174000",
  "created": "2024-12-22T01:50:23.241Z",
  "modified": "2024-12-22T01:50:23.241Z"
}

Update order product charge

PATCHhttps://api.younium.com/Orders/Charges/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Body

application/merge-patch+json

descriptionnullable string

remarksnullable string

externalERPIdnullable string

externalCRMIdnullable string

customFieldsnullable object

Response

200400401403

Success

Request

JavaScriptCurlPython

const response = await fetch('https://api.younium.com/Orders/Charges/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/merge-patch+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Get Charges by order id

GEThttps://api.younium.com/Orders/{id}/charges

Authorization

oauth2

Path parameters

id*string (uuid)

Query parameters

Header parameters

Response

200400401403

Success

Body

application/json

pageNumberinteger (int32)

pageSizeinteger (int32)

totalPagesnullable integer (int32)

totalCountinteger (int32)

nextPagenullable string (uri)

previousPagenullable string (uri)

firstPagenullable string (uri)

lastPagenullable string (uri)

datanullable array of OrderProductChargeResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.younium.com/Orders/{id}/charges', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "pageNumber": 0,
  "pageSize": 0,
  "totalPages": 0,
  "totalCount": 0,
  "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": 0,
      "isLastVersion": false,
      "name": "text",
      "chargeType": {},
      "priceModel": {},
      "effectiveStartDate": "2024-12-22T01:50:23.241Z",
      "effectiveEndDate": "2024-12-22T01:50:23.241Z",
      "quantity": 0,
      "unitCode": "text",
      "startOn": {},
      "endOn": {},
      "chargedThroughDate": "2024-12-22T01:50:23.241Z",
      "lastRenewalDate": "2024-12-22T01:50:23.241Z",
      "lastPriceAdjustmentDate": "2024-12-22T01:50:23.241Z",
      "pricePeriod": {},
      "usageRating": {},
      "revenueRecognitionRule": "text",
      "billingDay": {},
      "specificBillingDay": 0,
      "billingPeriod": {},
      "billingTiming": {},
      "periodAlignment": {},
      "alignmentDate": "2024-12-22T01:50:23.241Z",
      "taxTemplate": "text",
      "taxIncluded": false,
      "createInvoiceLinesPerTier": false,
      "estimatedUsage": 0,
      "estimatedQuantity": 0,
      "remainingQuantity": 0,
      "orderedQuantity": 0,
      "remarks": "text",
      "accountsReceivableAccount": "text",
      "deferredRevenueAccount": "text",
      "recognizedRevenueAccount": "text",
      "changeState": {},
      "displayPrice": 0,
      "priceDetails": [
        {
          "tier": 0,
          "price": 0,
          "listPrice": 0,
          "description": "text",
          "fromQuantity": 0,
          "toQuantity": 0,
          "priceBase": {},
          "lineDiscountPercent": 0,
          "lineDiscountAmount": 0
        }
      ],
      "recurringMonthlyAmount": 0,
      "recurringMonthlyAmountBase": 0,
      "features": [
        {
          "code": "text",
          "description": "text"
        }
      ],
      "orderDiscounts": [
        {
          "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
          "chargeId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "externalERPId": "text",
      "externalCRMId": "text",
      "cmrr": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T01:50:23.241Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T01:50:23.241Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T01:50:23.241Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T01:50:23.241Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T01:50:23.241Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "chargeId": "123e4567-e89b-12d3-a456-426614174000",
      "created": "2024-12-22T01:50:23.241Z",
      "modified": "2024-12-22T01:50:23.241Z"
    }
  ]
}

Get Charges by order product id

GEThttps://api.younium.com/Orders/Products/{id}/charges

Authorization

oauth2

Path parameters

id*string (uuid)

Query parameters

Header parameters

Response

200400401403

Success

Body

application/json

pageNumberinteger (int32)

pageSizeinteger (int32)

totalPagesnullable integer (int32)

totalCountinteger (int32)

nextPagenullable string (uri)

previousPagenullable string (uri)

firstPagenullable string (uri)

lastPagenullable string (uri)

datanullable array of OrderProductChargeResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.younium.com/Orders/Products/{id}/charges', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "pageNumber": 0,
  "pageSize": 0,
  "totalPages": 0,
  "totalCount": 0,
  "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": 0,
      "isLastVersion": false,
      "name": "text",
      "chargeType": {},
      "priceModel": {},
      "effectiveStartDate": "2024-12-22T01:50:23.241Z",
      "effectiveEndDate": "2024-12-22T01:50:23.241Z",
      "quantity": 0,
      "unitCode": "text",
      "startOn": {},
      "endOn": {},
      "chargedThroughDate": "2024-12-22T01:50:23.241Z",
      "lastRenewalDate": "2024-12-22T01:50:23.241Z",
      "lastPriceAdjustmentDate": "2024-12-22T01:50:23.241Z",
      "pricePeriod": {},
      "usageRating": {},
      "revenueRecognitionRule": "text",
      "billingDay": {},
      "specificBillingDay": 0,
      "billingPeriod": {},
      "billingTiming": {},
      "periodAlignment": {},
      "alignmentDate": "2024-12-22T01:50:23.241Z",
      "taxTemplate": "text",
      "taxIncluded": false,
      "createInvoiceLinesPerTier": false,
      "estimatedUsage": 0,
      "estimatedQuantity": 0,
      "remainingQuantity": 0,
      "orderedQuantity": 0,
      "remarks": "text",
      "accountsReceivableAccount": "text",
      "deferredRevenueAccount": "text",
      "recognizedRevenueAccount": "text",
      "changeState": {},
      "displayPrice": 0,
      "priceDetails": [
        {
          "tier": 0,
          "price": 0,
          "listPrice": 0,
          "description": "text",
          "fromQuantity": 0,
          "toQuantity": 0,
          "priceBase": {},
          "lineDiscountPercent": 0,
          "lineDiscountAmount": 0
        }
      ],
      "recurringMonthlyAmount": 0,
      "recurringMonthlyAmountBase": 0,
      "features": [
        {
          "code": "text",
          "description": "text"
        }
      ],
      "orderDiscounts": [
        {
          "orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
          "chargeId": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "externalERPId": "text",
      "externalCRMId": "text",
      "cmrr": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T01:50:23.241Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T01:50:23.241Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T01:50:23.241Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "emrr": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T01:50:23.241Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "oneTimeFees": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T01:50:23.241Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "orderProductId": "123e4567-e89b-12d3-a456-426614174000",
      "orderId": "123e4567-e89b-12d3-a456-426614174000",
      "chargeId": "123e4567-e89b-12d3-a456-426614174000",
      "created": "2024-12-22T01:50:23.241Z",
      "modified": "2024-12-22T01:50:23.241Z"
    }
  ]
}

Edit InvoicedToDate on Charge

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'

POSThttps://api.younium.com/Orders/Charges/{id}/InvoicedTo

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Body

application/json

invoicedToDatestring (date-time)

Response

204400401403404

No Content

Request

JavaScriptCurlPython

const response = await fetch('https://api.younium.com/Orders/Charges/{id}/InvoicedTo', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400404

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

---