Salesorders
Last updated
Was this helpful?
Last updated
Was this helpful?
/SalesOrders
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
curl -L \
--url 'https://api.younium.com/SalesOrders'
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderNumber": "text",
"version": 1,
"isLastVersion": true,
"description": "text",
"remarks": "text",
"orderDate": "2025-02-22T08:56:49.748Z",
"created": "2025-02-22T08:56:49.748Z",
"modified": "2025-02-22T08:56:49.748Z",
"lastUpdated": "2025-02-22T08:56:49.748Z",
"invoiceSeparatly": true,
"yourReference": "text",
"ourReference": "text",
"yourOrderNumber": "text",
"buyerReference": "text",
"paymentTerm": "text",
"invoiceBatchGroup": "text",
"useAccountInvoiceBatchGroup": true,
"currency": "text",
"accountsReceivableAccount": "text",
"externalERPId": "text",
"externalCRMId": "text",
"invoicingCurrency": "text",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"products": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"productNumber": "text",
"chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
"chargePlanName": "text",
"chargePlanNumber": "text",
"productLineNumber": 1,
"name": "text",
"externalERPId": "text",
"externalCRMId": "text",
"created": "2025-02-22T08:56:49.748Z",
"modified": "2025-02-22T08:56:49.748Z",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"charges": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"chargeNumber": "OPC-000001",
"version": 1,
"isLastVersion": true,
"name": "text",
"effectiveStartDate": "2025-02-22T08:56:49.748Z",
"effectiveEndDate": "2025-02-22T08:56:49.748Z",
"quantity": 1,
"unitCode": "text",
"chargedThroughDate": "2025-02-22T08:56:49.748Z",
"lastRenewalDate": "2025-02-22T08:56:49.748Z",
"lastPriceAdjustmentDate": "2025-02-22T08:56:49.748Z",
"revenueRecognitionRule": "text",
"specificBillingDay": 1,
"alignmentDate": "2025-02-22T08:56:49.748Z",
"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:56:49.748Z",
"modified": "2025-02-22T08:56:49.748Z",
"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:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
],
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
],
"milestones": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"milestoneDate": "2025-02-22T08:56:49.748Z",
"plannedDate": "2025-02-22T08:56:49.748Z"
}
],
"orderDiscounts": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"startDate": "2025-02-22T08:56:49.748Z",
"endDate": "2025-02-22T08:56:49.748Z",
"percent": 1,
"onSpecificCharges": true,
"orderProductCharges": [
{
"orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000"
}
],
"startOn": "AlignToOrder",
"endOn": "AlignToOrder",
"discountType": "Percent"
}
],
"status": "Draft",
"orderType": "Subscription",
"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"
},
"orderPaymentMethod": "Invoice",
"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"
}
}
]
Success
/SalesOrders
Obsolete field. Use order date instead. order Date will override this value
Allowed as string input: Name, PaymentTerm-Id.
NET30
Allowed as string input: AccountNumber, Account-Id, Name.
A-000001
Allowed as string input: AccountNumber, Account-Id, Name.
A-000001
Allowed as string input: Code, Currency-Id.
SEK
curl -L \
--request POST \
--url 'https://api.younium.com/SalesOrders' \
--header 'Content-Type: application/json' \
--data '{"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"products":[{"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"charges":[{"customFields":{"ANY_ADDITIONAL_PROPERTY":"anything"},"priceDetails":[{"priceBase":"Flat"}],"features":[{"feature":{}}],"orderDiscountMappingKey":[null],"charge":{},"chargeType":"OneOff","priceModel":"Flat","unitCode":"pcs","startOn":"AlignToSubscription","endOn":"AlignToSubscription","pricePeriod":"Monthly","usageRating":"Sum","revenueRecognitionRule":{},"billingDay":"None","billingPeriod":"Monthly","billingTiming":"InAdvance","periodAlignment":"None","taxTemplate":"Sweden standard","deferredRevenueAccount":"1510","recognizedRevenueAccount":"1510","changeState":"NotChanged"}],"product":"P-000001","chargePlan":"CP-000001"}],"milestones":[{"name":"text"}],"orderDiscounts":[{"orderProductCharges":[{"charge":"OPC-000001","operation":"Remove"}],"operation":"Change","OrderDiscountId":"GUID","startOn":"AlignToOrder","endOn":"AlignToOrder"}],"status":"OrderDraft","orderType":"SalesOrder","orderPaymentMethod":"Invoice","paymentTerm":"NET30","account":"A-000001","invoiceAccount":"A-000001","currency":"SEK","invoiceBatchGroup":{}}'
No body
The salesOrders for the request.
/SalesOrders/{id}
curl -L \
--url 'https://api.younium.com/SalesOrders/{id}'
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderNumber": "text",
"version": 1,
"isLastVersion": true,
"description": "text",
"remarks": "text",
"orderDate": "2025-02-22T08:56:49.748Z",
"created": "2025-02-22T08:56:49.748Z",
"modified": "2025-02-22T08:56:49.748Z",
"lastUpdated": "2025-02-22T08:56:49.748Z",
"invoiceSeparatly": true,
"yourReference": "text",
"ourReference": "text",
"yourOrderNumber": "text",
"buyerReference": "text",
"paymentTerm": "text",
"invoiceBatchGroup": "text",
"useAccountInvoiceBatchGroup": true,
"currency": "text",
"accountsReceivableAccount": "text",
"externalERPId": "text",
"externalCRMId": "text",
"invoicingCurrency": "text",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"products": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"productNumber": "text",
"chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
"chargePlanName": "text",
"chargePlanNumber": "text",
"productLineNumber": 1,
"name": "text",
"externalERPId": "text",
"externalCRMId": "text",
"created": "2025-02-22T08:56:49.748Z",
"modified": "2025-02-22T08:56:49.748Z",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"charges": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"chargeNumber": "OPC-000001",
"version": 1,
"isLastVersion": true,
"name": "text",
"effectiveStartDate": "2025-02-22T08:56:49.748Z",
"effectiveEndDate": "2025-02-22T08:56:49.748Z",
"quantity": 1,
"unitCode": "text",
"chargedThroughDate": "2025-02-22T08:56:49.748Z",
"lastRenewalDate": "2025-02-22T08:56:49.748Z",
"lastPriceAdjustmentDate": "2025-02-22T08:56:49.748Z",
"revenueRecognitionRule": "text",
"specificBillingDay": 1,
"alignmentDate": "2025-02-22T08:56:49.748Z",
"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:56:49.748Z",
"modified": "2025-02-22T08:56:49.748Z",
"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:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
],
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
],
"milestones": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"milestoneDate": "2025-02-22T08:56:49.748Z",
"plannedDate": "2025-02-22T08:56:49.748Z"
}
],
"orderDiscounts": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"startDate": "2025-02-22T08:56:49.748Z",
"endDate": "2025-02-22T08:56:49.748Z",
"percent": 1,
"onSpecificCharges": true,
"orderProductCharges": [
{
"orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000"
}
],
"startOn": "AlignToOrder",
"endOn": "AlignToOrder",
"discountType": "Percent"
}
],
"status": "Draft",
"orderType": "Subscription",
"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"
},
"orderPaymentMethod": "Invoice",
"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"
}
}
Success
/SalesOrders/{id}/version
curl -L \
--url 'https://api.younium.com/SalesOrders/{id}/version'
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderNumber": "text",
"version": 1,
"isLastVersion": true,
"description": "text",
"remarks": "text",
"orderDate": "2025-02-22T08:56:49.748Z",
"created": "2025-02-22T08:56:49.748Z",
"modified": "2025-02-22T08:56:49.748Z",
"lastUpdated": "2025-02-22T08:56:49.748Z",
"invoiceSeparatly": true,
"yourReference": "text",
"ourReference": "text",
"yourOrderNumber": "text",
"buyerReference": "text",
"paymentTerm": "text",
"invoiceBatchGroup": "text",
"useAccountInvoiceBatchGroup": true,
"currency": "text",
"accountsReceivableAccount": "text",
"externalERPId": "text",
"externalCRMId": "text",
"invoicingCurrency": "text",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"products": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"productNumber": "text",
"chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
"chargePlanName": "text",
"chargePlanNumber": "text",
"productLineNumber": 1,
"name": "text",
"externalERPId": "text",
"externalCRMId": "text",
"created": "2025-02-22T08:56:49.748Z",
"modified": "2025-02-22T08:56:49.748Z",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"charges": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"chargeNumber": "OPC-000001",
"version": 1,
"isLastVersion": true,
"name": "text",
"effectiveStartDate": "2025-02-22T08:56:49.748Z",
"effectiveEndDate": "2025-02-22T08:56:49.748Z",
"quantity": 1,
"unitCode": "text",
"chargedThroughDate": "2025-02-22T08:56:49.748Z",
"lastRenewalDate": "2025-02-22T08:56:49.748Z",
"lastPriceAdjustmentDate": "2025-02-22T08:56:49.748Z",
"revenueRecognitionRule": "text",
"specificBillingDay": 1,
"alignmentDate": "2025-02-22T08:56:49.748Z",
"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:56:49.748Z",
"modified": "2025-02-22T08:56:49.748Z",
"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:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
],
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
],
"milestones": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"milestoneDate": "2025-02-22T08:56:49.748Z",
"plannedDate": "2025-02-22T08:56:49.748Z"
}
],
"orderDiscounts": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"startDate": "2025-02-22T08:56:49.748Z",
"endDate": "2025-02-22T08:56:49.748Z",
"percent": 1,
"onSpecificCharges": true,
"orderProductCharges": [
{
"orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000"
}
],
"startOn": "AlignToOrder",
"endOn": "AlignToOrder",
"discountType": "Percent"
}
],
"status": "Draft",
"orderType": "Subscription",
"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"
},
"orderPaymentMethod": "Invoice",
"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"
}
}
Success
/SalesOrders/{orderNumber}/versions
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.
11/01/2024 00:00:00
Filter is also applied on sub entities: 'orderProducts', 'orderCharges', 'chargeDetails', 'orderDiscounts', 'milestones' and 'customFields' on these entities
11/01/2024 00:00:00
Page Size
20
Page Number
1
curl -L \
--url 'https://api.younium.com/SalesOrders/{orderNumber}/versions'
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderNumber": "text",
"version": 1,
"isLastVersion": true,
"description": "text",
"remarks": "text",
"orderDate": "2025-02-22T08:56:49.748Z",
"created": "2025-02-22T08:56:49.748Z",
"modified": "2025-02-22T08:56:49.748Z",
"lastUpdated": "2025-02-22T08:56:49.748Z",
"invoiceSeparatly": true,
"yourReference": "text",
"ourReference": "text",
"yourOrderNumber": "text",
"buyerReference": "text",
"paymentTerm": "text",
"invoiceBatchGroup": "text",
"useAccountInvoiceBatchGroup": true,
"currency": "text",
"accountsReceivableAccount": "text",
"externalERPId": "text",
"externalCRMId": "text",
"invoicingCurrency": "text",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"products": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"productNumber": "text",
"chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
"chargePlanName": "text",
"chargePlanNumber": "text",
"productLineNumber": 1,
"name": "text",
"externalERPId": "text",
"externalCRMId": "text",
"created": "2025-02-22T08:56:49.748Z",
"modified": "2025-02-22T08:56:49.748Z",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"charges": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"chargeNumber": "OPC-000001",
"version": 1,
"isLastVersion": true,
"name": "text",
"effectiveStartDate": "2025-02-22T08:56:49.748Z",
"effectiveEndDate": "2025-02-22T08:56:49.748Z",
"quantity": 1,
"unitCode": "text",
"chargedThroughDate": "2025-02-22T08:56:49.748Z",
"lastRenewalDate": "2025-02-22T08:56:49.748Z",
"lastPriceAdjustmentDate": "2025-02-22T08:56:49.748Z",
"revenueRecognitionRule": "text",
"specificBillingDay": 1,
"alignmentDate": "2025-02-22T08:56:49.748Z",
"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:56:49.748Z",
"modified": "2025-02-22T08:56:49.748Z",
"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:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
],
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
],
"milestones": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"milestoneDate": "2025-02-22T08:56:49.748Z",
"plannedDate": "2025-02-22T08:56:49.748Z"
}
],
"orderDiscounts": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"startDate": "2025-02-22T08:56:49.748Z",
"endDate": "2025-02-22T08:56:49.748Z",
"percent": 1,
"onSpecificCharges": true,
"orderProductCharges": [
{
"orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000"
}
],
"startOn": "AlignToOrder",
"endOn": "AlignToOrder",
"discountType": "Percent"
}
],
"status": "Draft",
"orderType": "Subscription",
"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"
},
"orderPaymentMethod": "Invoice",
"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"
}
}
]
Success
/SalesOrders/{orderNumber}/versions/{version}
curl -L \
--url 'https://api.younium.com/SalesOrders/{orderNumber}/versions/{version}'
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderNumber": "text",
"version": 1,
"isLastVersion": true,
"description": "text",
"remarks": "text",
"orderDate": "2025-02-22T08:56:49.748Z",
"created": "2025-02-22T08:56:49.748Z",
"modified": "2025-02-22T08:56:49.748Z",
"lastUpdated": "2025-02-22T08:56:49.748Z",
"invoiceSeparatly": true,
"yourReference": "text",
"ourReference": "text",
"yourOrderNumber": "text",
"buyerReference": "text",
"paymentTerm": "text",
"invoiceBatchGroup": "text",
"useAccountInvoiceBatchGroup": true,
"currency": "text",
"accountsReceivableAccount": "text",
"externalERPId": "text",
"externalCRMId": "text",
"invoicingCurrency": "text",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"products": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"productNumber": "text",
"chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
"chargePlanName": "text",
"chargePlanNumber": "text",
"productLineNumber": 1,
"name": "text",
"externalERPId": "text",
"externalCRMId": "text",
"created": "2025-02-22T08:56:49.748Z",
"modified": "2025-02-22T08:56:49.748Z",
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"charges": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"chargeNumber": "OPC-000001",
"version": 1,
"isLastVersion": true,
"name": "text",
"effectiveStartDate": "2025-02-22T08:56:49.748Z",
"effectiveEndDate": "2025-02-22T08:56:49.748Z",
"quantity": 1,
"unitCode": "text",
"chargedThroughDate": "2025-02-22T08:56:49.748Z",
"lastRenewalDate": "2025-02-22T08:56:49.748Z",
"lastPriceAdjustmentDate": "2025-02-22T08:56:49.748Z",
"revenueRecognitionRule": "text",
"specificBillingDay": 1,
"alignmentDate": "2025-02-22T08:56:49.748Z",
"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:56:49.748Z",
"modified": "2025-02-22T08:56:49.748Z",
"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:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
],
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"emrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"oneTimeFees": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-02-22T08:56:49.748Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
],
"milestones": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"name": "text",
"description": "text",
"milestoneDate": "2025-02-22T08:56:49.748Z",
"plannedDate": "2025-02-22T08:56:49.748Z"
}
],
"orderDiscounts": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"startDate": "2025-02-22T08:56:49.748Z",
"endDate": "2025-02-22T08:56:49.748Z",
"percent": 1,
"onSpecificCharges": true,
"orderProductCharges": [
{
"orderDiscountId": "123e4567-e89b-12d3-a456-426614174000",
"chargeId": "123e4567-e89b-12d3-a456-426614174000"
}
],
"startOn": "AlignToOrder",
"endOn": "AlignToOrder",
"discountType": "Percent"
}
],
"status": "Draft",
"orderType": "Subscription",
"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"
},
"orderPaymentMethod": "Invoice",
"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"
}
}
Success
/SalesOrders/activate/{id}
curl -L \
--request POST \
--url 'https://api.younium.com/SalesOrders/activate/{id}'
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"message": "text"
}
Success