Salesorders
Last updated
Was this helpful?
Last updated
Was this helpful?
GET /SalesOrders/{id} HTTP/1.1
Host: api.younium.com
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderNumber": "text",
"version": 1,
"isLastVersion": true,
"status": "Draft",
"description": "text",
"remarks": "text",
"orderDate": "2025-04-15T13:45:12.827Z",
"created": "2025-04-15T13:45:12.827Z",
"modified": "2025-04-15T13:45:12.827Z",
"lastUpdated": "2025-04-15T13:45:12.827Z",
"orderType": "Subscription",
"invoiceSeparatly": true,
"yourReference": "text",
"ourReference": "text",
"yourOrderNumber": "text",
"buyerReference": "text",
"invoiceAddress": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"description": "text",
"name": "text",
"street": "text",
"street2": "text",
"city": "text",
"county": "text",
"state": "text",
"zip": "text",
"country": "text"
},
"deliveryAddress": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"description": "text",
"name": "text",
"street": "text",
"street2": "text",
"city": "text",
"county": "text",
"state": "text",
"zip": "text",
"country": "text"
},
"paymentTerm": "text",
"orderPaymentMethod": "Invoice",
"invoiceBatchGroup": "text",
"useAccountInvoiceBatchGroup": true,
"account": {
"name": "text",
"accountNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"invoiceAccount": {
"name": "text",
"accountNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"currency": "text",
"accountsReceivableAccount": "text",
"externalERPId": "text",
"externalCRMId": "text",
"products": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"productNumber": "text",
"chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
"chargePlanName": "text",
"chargePlanNumber": "text",
"productLineNumber": 1,
"name": "text",
"charges": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"chargeNumber": "OPC-000001",
"version": 1,
"isLastVersion": true,
"name": "text",
"chargeType": "OneOff",
"priceModel": "Flat",
"effectiveStartDate": "2025-04-15T13:45:12.827Z",
"effectiveEndDate": "2025-04-15T13:45:12.827Z",
"quantity": 1,
"unitCode": "text",
"startOn": "AlignToSubscription",
"endOn": "AlignToSubscription",
"chargedThroughDate": "2025-04-15T13:45:12.827Z",
"lastRenewalDate": "2025-04-15T13:45:12.827Z",
"lastPriceAdjustmentDate": "2025-04-15T13:45:12.827Z",
"pricePeriod": "Monthly",
"usageRating": "Sum",
"revenueRecognitionRule": "text",
"billingDay": "None",
"specificBillingDay": 1,
"billingPeriod": "Monthly",
"billingTiming": "InAdvance",
"periodAlignment": "None",
"alignmentDate": "2025-04-15T13:45:12.827Z",
"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-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"orderProductId": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000",
"created": "2025-04-15T13:45:12.827Z",
"modified": "2025-04-15T13:45:12.827Z"
}
],
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"externalERPId": "text",
"externalCRMId": "text",
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"created": "2025-04-15T13:45:12.827Z",
"modified": "2025-04-15T13:45:12.827Z"
}
],
"milestones": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"milestoneDate": "2025-04-15T13:45:12.827Z",
"plannedDate": "2025-04-15T13:45:12.827Z"
}
],
"orderDiscounts": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"startOn": "AlignToOrder",
"endOn": "AlignToOrder",
"startDate": "2025-04-15T13:45:12.827Z",
"endDate": "2025-04-15T13:45:12.827Z",
"percent": 1,
"discountType": "Percent",
"orderProductCharges": [
{
"orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000"
}
],
"onSpecificCharges": true
}
],
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"invoicingCurrency": "text"
}
GET /SalesOrders/{id}/version HTTP/1.1
Host: api.younium.com
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderNumber": "text",
"version": 1,
"isLastVersion": true,
"status": "Draft",
"description": "text",
"remarks": "text",
"orderDate": "2025-04-15T13:45:12.827Z",
"created": "2025-04-15T13:45:12.827Z",
"modified": "2025-04-15T13:45:12.827Z",
"lastUpdated": "2025-04-15T13:45:12.827Z",
"orderType": "Subscription",
"invoiceSeparatly": true,
"yourReference": "text",
"ourReference": "text",
"yourOrderNumber": "text",
"buyerReference": "text",
"invoiceAddress": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"description": "text",
"name": "text",
"street": "text",
"street2": "text",
"city": "text",
"county": "text",
"state": "text",
"zip": "text",
"country": "text"
},
"deliveryAddress": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"description": "text",
"name": "text",
"street": "text",
"street2": "text",
"city": "text",
"county": "text",
"state": "text",
"zip": "text",
"country": "text"
},
"paymentTerm": "text",
"orderPaymentMethod": "Invoice",
"invoiceBatchGroup": "text",
"useAccountInvoiceBatchGroup": true,
"account": {
"name": "text",
"accountNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"invoiceAccount": {
"name": "text",
"accountNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"currency": "text",
"accountsReceivableAccount": "text",
"externalERPId": "text",
"externalCRMId": "text",
"products": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"productNumber": "text",
"chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
"chargePlanName": "text",
"chargePlanNumber": "text",
"productLineNumber": 1,
"name": "text",
"charges": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"chargeNumber": "OPC-000001",
"version": 1,
"isLastVersion": true,
"name": "text",
"chargeType": "OneOff",
"priceModel": "Flat",
"effectiveStartDate": "2025-04-15T13:45:12.827Z",
"effectiveEndDate": "2025-04-15T13:45:12.827Z",
"quantity": 1,
"unitCode": "text",
"startOn": "AlignToSubscription",
"endOn": "AlignToSubscription",
"chargedThroughDate": "2025-04-15T13:45:12.827Z",
"lastRenewalDate": "2025-04-15T13:45:12.827Z",
"lastPriceAdjustmentDate": "2025-04-15T13:45:12.827Z",
"pricePeriod": "Monthly",
"usageRating": "Sum",
"revenueRecognitionRule": "text",
"billingDay": "None",
"specificBillingDay": 1,
"billingPeriod": "Monthly",
"billingTiming": "InAdvance",
"periodAlignment": "None",
"alignmentDate": "2025-04-15T13:45:12.827Z",
"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-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"orderProductId": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000",
"created": "2025-04-15T13:45:12.827Z",
"modified": "2025-04-15T13:45:12.827Z"
}
],
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"externalERPId": "text",
"externalCRMId": "text",
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"created": "2025-04-15T13:45:12.827Z",
"modified": "2025-04-15T13:45:12.827Z"
}
],
"milestones": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"milestoneDate": "2025-04-15T13:45:12.827Z",
"plannedDate": "2025-04-15T13:45:12.827Z"
}
],
"orderDiscounts": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"startOn": "AlignToOrder",
"endOn": "AlignToOrder",
"startDate": "2025-04-15T13:45:12.827Z",
"endDate": "2025-04-15T13:45:12.827Z",
"percent": 1,
"discountType": "Percent",
"orderProductCharges": [
{
"orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000"
}
],
"onSpecificCharges": true
}
],
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"invoicingCurrency": "text"
}
Filter the results. See ODATA documentation for more information
name eq 'Adam' and age gt 20
Sorting the results. See ODATA specification for more information
accountNumber Desc
Apply a separate modified After filter. See 'ModifiedBefore' filter for further details.
03/01/2025 00:00:00
Filter is also applied on sub entities: 'orderProducts', 'orderCharges', 'chargeDetails', 'orderDiscounts', 'milestones' and 'customFields' on these entities
03/01/2025 00:00:00
Page Size
20
Page Number
1
GET /SalesOrders/{orderNumber}/versions HTTP/1.1
Host: api.younium.com
Accept: */*
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderNumber": "text",
"version": 1,
"isLastVersion": true,
"status": "Draft",
"description": "text",
"remarks": "text",
"orderDate": "2025-04-15T13:45:12.827Z",
"created": "2025-04-15T13:45:12.827Z",
"modified": "2025-04-15T13:45:12.827Z",
"lastUpdated": "2025-04-15T13:45:12.827Z",
"orderType": "Subscription",
"invoiceSeparatly": true,
"yourReference": "text",
"ourReference": "text",
"yourOrderNumber": "text",
"buyerReference": "text",
"invoiceAddress": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"description": "text",
"name": "text",
"street": "text",
"street2": "text",
"city": "text",
"county": "text",
"state": "text",
"zip": "text",
"country": "text"
},
"deliveryAddress": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"description": "text",
"name": "text",
"street": "text",
"street2": "text",
"city": "text",
"county": "text",
"state": "text",
"zip": "text",
"country": "text"
},
"paymentTerm": "text",
"orderPaymentMethod": "Invoice",
"invoiceBatchGroup": "text",
"useAccountInvoiceBatchGroup": true,
"account": {
"name": "text",
"accountNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"invoiceAccount": {
"name": "text",
"accountNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"currency": "text",
"accountsReceivableAccount": "text",
"externalERPId": "text",
"externalCRMId": "text",
"products": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"productNumber": "text",
"chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
"chargePlanName": "text",
"chargePlanNumber": "text",
"productLineNumber": 1,
"name": "text",
"charges": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"chargeNumber": "OPC-000001",
"version": 1,
"isLastVersion": true,
"name": "text",
"chargeType": "OneOff",
"priceModel": "Flat",
"effectiveStartDate": "2025-04-15T13:45:12.827Z",
"effectiveEndDate": "2025-04-15T13:45:12.827Z",
"quantity": 1,
"unitCode": "text",
"startOn": "AlignToSubscription",
"endOn": "AlignToSubscription",
"chargedThroughDate": "2025-04-15T13:45:12.827Z",
"lastRenewalDate": "2025-04-15T13:45:12.827Z",
"lastPriceAdjustmentDate": "2025-04-15T13:45:12.827Z",
"pricePeriod": "Monthly",
"usageRating": "Sum",
"revenueRecognitionRule": "text",
"billingDay": "None",
"specificBillingDay": 1,
"billingPeriod": "Monthly",
"billingTiming": "InAdvance",
"periodAlignment": "None",
"alignmentDate": "2025-04-15T13:45:12.827Z",
"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-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"orderProductId": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000",
"created": "2025-04-15T13:45:12.827Z",
"modified": "2025-04-15T13:45:12.827Z"
}
],
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"externalERPId": "text",
"externalCRMId": "text",
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"created": "2025-04-15T13:45:12.827Z",
"modified": "2025-04-15T13:45:12.827Z"
}
],
"milestones": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"milestoneDate": "2025-04-15T13:45:12.827Z",
"plannedDate": "2025-04-15T13:45:12.827Z"
}
],
"orderDiscounts": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"startOn": "AlignToOrder",
"endOn": "AlignToOrder",
"startDate": "2025-04-15T13:45:12.827Z",
"endDate": "2025-04-15T13:45:12.827Z",
"percent": 1,
"discountType": "Percent",
"orderProductCharges": [
{
"orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000"
}
],
"onSpecificCharges": true
}
],
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"invoicingCurrency": "text"
}
]
GET /SalesOrders/{orderNumber}/versions/{version} HTTP/1.1
Host: api.younium.com
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderNumber": "text",
"version": 1,
"isLastVersion": true,
"status": "Draft",
"description": "text",
"remarks": "text",
"orderDate": "2025-04-15T13:45:12.827Z",
"created": "2025-04-15T13:45:12.827Z",
"modified": "2025-04-15T13:45:12.827Z",
"lastUpdated": "2025-04-15T13:45:12.827Z",
"orderType": "Subscription",
"invoiceSeparatly": true,
"yourReference": "text",
"ourReference": "text",
"yourOrderNumber": "text",
"buyerReference": "text",
"invoiceAddress": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"description": "text",
"name": "text",
"street": "text",
"street2": "text",
"city": "text",
"county": "text",
"state": "text",
"zip": "text",
"country": "text"
},
"deliveryAddress": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"description": "text",
"name": "text",
"street": "text",
"street2": "text",
"city": "text",
"county": "text",
"state": "text",
"zip": "text",
"country": "text"
},
"paymentTerm": "text",
"orderPaymentMethod": "Invoice",
"invoiceBatchGroup": "text",
"useAccountInvoiceBatchGroup": true,
"account": {
"name": "text",
"accountNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"invoiceAccount": {
"name": "text",
"accountNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"currency": "text",
"accountsReceivableAccount": "text",
"externalERPId": "text",
"externalCRMId": "text",
"products": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"productNumber": "text",
"chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
"chargePlanName": "text",
"chargePlanNumber": "text",
"productLineNumber": 1,
"name": "text",
"charges": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"chargeNumber": "OPC-000001",
"version": 1,
"isLastVersion": true,
"name": "text",
"chargeType": "OneOff",
"priceModel": "Flat",
"effectiveStartDate": "2025-04-15T13:45:12.827Z",
"effectiveEndDate": "2025-04-15T13:45:12.827Z",
"quantity": 1,
"unitCode": "text",
"startOn": "AlignToSubscription",
"endOn": "AlignToSubscription",
"chargedThroughDate": "2025-04-15T13:45:12.827Z",
"lastRenewalDate": "2025-04-15T13:45:12.827Z",
"lastPriceAdjustmentDate": "2025-04-15T13:45:12.827Z",
"pricePeriod": "Monthly",
"usageRating": "Sum",
"revenueRecognitionRule": "text",
"billingDay": "None",
"specificBillingDay": 1,
"billingPeriod": "Monthly",
"billingTiming": "InAdvance",
"periodAlignment": "None",
"alignmentDate": "2025-04-15T13:45:12.827Z",
"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-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"orderProductId": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000",
"created": "2025-04-15T13:45:12.827Z",
"modified": "2025-04-15T13:45:12.827Z"
}
],
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"externalERPId": "text",
"externalCRMId": "text",
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"created": "2025-04-15T13:45:12.827Z",
"modified": "2025-04-15T13:45:12.827Z"
}
],
"milestones": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"milestoneDate": "2025-04-15T13:45:12.827Z",
"plannedDate": "2025-04-15T13:45:12.827Z"
}
],
"orderDiscounts": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"startOn": "AlignToOrder",
"endOn": "AlignToOrder",
"startDate": "2025-04-15T13:45:12.827Z",
"endDate": "2025-04-15T13:45:12.827Z",
"percent": 1,
"discountType": "Percent",
"orderProductCharges": [
{
"orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000"
}
],
"onSpecificCharges": true
}
],
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"invoicingCurrency": "text"
}
POST /SalesOrders/activate/{id} HTTP/1.1
Host: api.younium.com
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"message": "text"
}
Skip number of records
10
Take number of records
5
Filter the resulsts. See ODATA documentation for more information
name eq 'Adam' and age gt 20
Sorting the results. See ODATA specificaion for more information
name
GET /SalesOrders HTTP/1.1
Host: api.younium.com
Accept: */*
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderNumber": "text",
"version": 1,
"isLastVersion": true,
"status": "Draft",
"description": "text",
"remarks": "text",
"orderDate": "2025-04-15T13:45:12.827Z",
"created": "2025-04-15T13:45:12.827Z",
"modified": "2025-04-15T13:45:12.827Z",
"lastUpdated": "2025-04-15T13:45:12.827Z",
"orderType": "Subscription",
"invoiceSeparatly": true,
"yourReference": "text",
"ourReference": "text",
"yourOrderNumber": "text",
"buyerReference": "text",
"invoiceAddress": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"description": "text",
"name": "text",
"street": "text",
"street2": "text",
"city": "text",
"county": "text",
"state": "text",
"zip": "text",
"country": "text"
},
"deliveryAddress": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"description": "text",
"name": "text",
"street": "text",
"street2": "text",
"city": "text",
"county": "text",
"state": "text",
"zip": "text",
"country": "text"
},
"paymentTerm": "text",
"orderPaymentMethod": "Invoice",
"invoiceBatchGroup": "text",
"useAccountInvoiceBatchGroup": true,
"account": {
"name": "text",
"accountNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"invoiceAccount": {
"name": "text",
"accountNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"currency": "text",
"accountsReceivableAccount": "text",
"externalERPId": "text",
"externalCRMId": "text",
"products": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"productNumber": "text",
"chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
"chargePlanName": "text",
"chargePlanNumber": "text",
"productLineNumber": 1,
"name": "text",
"charges": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"chargeNumber": "OPC-000001",
"version": 1,
"isLastVersion": true,
"name": "text",
"chargeType": "OneOff",
"priceModel": "Flat",
"effectiveStartDate": "2025-04-15T13:45:12.827Z",
"effectiveEndDate": "2025-04-15T13:45:12.827Z",
"quantity": 1,
"unitCode": "text",
"startOn": "AlignToSubscription",
"endOn": "AlignToSubscription",
"chargedThroughDate": "2025-04-15T13:45:12.827Z",
"lastRenewalDate": "2025-04-15T13:45:12.827Z",
"lastPriceAdjustmentDate": "2025-04-15T13:45:12.827Z",
"pricePeriod": "Monthly",
"usageRating": "Sum",
"revenueRecognitionRule": "text",
"billingDay": "None",
"specificBillingDay": 1,
"billingPeriod": "Monthly",
"billingTiming": "InAdvance",
"periodAlignment": "None",
"alignmentDate": "2025-04-15T13:45:12.827Z",
"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-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"orderProductId": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000",
"created": "2025-04-15T13:45:12.827Z",
"modified": "2025-04-15T13:45:12.827Z"
}
],
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"externalERPId": "text",
"externalCRMId": "text",
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-04-15T13:45:12.827Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"created": "2025-04-15T13:45:12.827Z",
"modified": "2025-04-15T13:45:12.827Z"
}
],
"milestones": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"milestoneDate": "2025-04-15T13:45:12.827Z",
"plannedDate": "2025-04-15T13:45:12.827Z"
}
],
"orderDiscounts": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"startOn": "AlignToOrder",
"endOn": "AlignToOrder",
"startDate": "2025-04-15T13:45:12.827Z",
"endDate": "2025-04-15T13:45:12.827Z",
"percent": 1,
"discountType": "Percent",
"orderProductCharges": [
{
"orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000"
}
],
"onSpecificCharges": true
}
],
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"invoicingCurrency": "text"
}
]
POST /SalesOrders HTTP/1.1
Host: api.younium.com
Content-Type: application/json
Accept: */*
Content-Length: 2822
{
"status": "OrderDraft",
"description": "text",
"remarks": "text",
"effectiveStartDate": "2025-04-15T13:45:12.827Z",
"orderDate": "2025-04-15T13:45:12.827Z",
"orderType": "SalesOrder",
"orderPaymentMethod": "Invoice",
"invoiceSeparatly": true,
"yourReference": "text",
"ourReference": "text",
"yourOrderNumber": "text",
"buyerReference": "text",
"invoiceAddressId": "123e4567-e89b-12d3-a456-426614174000",
"deliveryAddressId": "123e4567-e89b-12d3-a456-426614174000",
"paymentTerm": "NET30",
"useAccountInvoiceBatchGroup": true,
"externalERPId": "text",
"externalCRMId": "text",
"account": "A-000001",
"invoiceAccount": "A-000001",
"currency": "SEK",
"invoicingCurrency": "text",
"products": [
{
"product": "P-000001",
"chargePlan": "CP-000001",
"productLineNumber": 1,
"name": "text",
"charges": [
{
"charge": {
"key": "text",
"value": "text"
},
"name": "text",
"chargeType": "OneOff",
"priceModel": "Flat",
"effectiveStartDate": "2025-04-15T13:45:12.827Z",
"effectiveEndDate": "2025-04-15T13:45:12.827Z",
"startMilestone": "text",
"endMilestone": "text",
"quantity": 1,
"unitCode": "pcs",
"startOn": "AlignToSubscription",
"endOn": "AlignToSubscription",
"chargedThroughDate": "2025-04-15T13:45:12.827Z",
"lastRenewalDate": "2025-04-15T13:45:12.827Z",
"lastPriceAdjustmentDate": "2025-04-15T13:45:12.827Z",
"pricePeriod": "Monthly",
"usageRating": "Sum",
"revenueRecognitionRule": {
"key": "text",
"value": "text"
},
"billingDay": "None",
"specificBillingDay": 1,
"billingPeriod": "Monthly",
"billingTiming": "InAdvance",
"periodAlignment": "None",
"alignmentDate": "2025-04-15T13:45:12.827Z",
"taxTemplate": "Sweden standard",
"taxIncluded": true,
"createInvoiceLinesPerTier": true,
"remarks": "text",
"deferredRevenueAccount": "1510",
"recognizedRevenueAccount": "1510",
"changeState": "NotChanged",
"displayPrice": 1,
"priceDetails": [
{
"toQuantity": 1,
"tier": 1,
"price": 1,
"listPrice": 1,
"description": "text",
"fromQuantity": 1,
"priceBase": "Flat",
"lineDiscountPercent": 1,
"lineDiscountAmount": 1
}
],
"features": [
{
"feature": {
"key": "text",
"value": "text"
}
}
],
"estimatedUsage": 1,
"estimatedQuantity": 1,
"orderedQuantity": 1,
"recurringMonthlyAmount": 1,
"externalERPId": "text",
"externalCRMId": "text",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"orderDiscountMappingKey": [
"text"
]
}
],
"externalERPId": "text",
"externalCRMId": "text",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}
],
"milestones": [
{
"name": "text",
"description": "text",
"plannedDate": "2025-04-15T13:45:12.827Z"
}
],
"orderDiscounts": [
{
"operation": "Change",
"OrderDiscountId": "GUID",
"startOn": "AlignToOrder",
"endOn": "AlignToOrder",
"startDate": "2025-04-15T13:45:12.827Z",
"endDate": "2025-04-15T13:45:12.827Z",
"percent": 1,
"onSpecificCharges": true,
"orderProductCharges": [
{
"charge": "OPC-000001",
"operation": "Remove"
}
],
"chargeMappingKey": "text"
}
],
"invoiceTemplateId": "123e4567-e89b-12d3-a456-426614174000",
"invoiceBatchGroup": {
"key": "text",
"value": "text"
},
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
}
}
No Content