Orders

Last updated 3 months ago

Was this helpful?

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.

get

/Orders/{id}

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.younium.com/Orders/{id}'

200

400

401

403

404

No body

Success

Get Charge by Id

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

get

/Orders/Charges/{id}

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.younium.com/Orders/Charges/{id}'

200

400

401

403

404

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

Success

Update order product charge

patch

/Orders/Charges/{id}

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Body

descriptionstring | nullable

remarksstring | nullable

externalERPIdstring | nullable

externalCRMIdstring | nullable

customFieldsobject | nullable

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.younium.com/Orders/Charges/{id}' \
  --header 'Content-Type: application/merge-patch+json' \
  --data '{"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"}}'

200

400

401

403

No body

Success

Get Charges by order id

get

/Orders/{id}/charges

Authorizations

Path parameters

idstring · uuidrequired

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/Orders/{id}/charges'

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

Success

Get Charges by order product id

get

/Orders/Products/{id}/charges

Authorizations

Path parameters

idstring · uuidrequired

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

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

Success

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'

post

/Orders/Charges/{id}/InvoicedTo

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Body

invoicedToDatestring · date-time

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.younium.com/Orders/Charges/{id}/InvoicedTo' \
  --header 'Content-Type: application/json'

204

400

401

403

404

No body

No Content