Quotes
A Quote can only be identified using Id or a unique custom fields. By default the Quote will be converted to a orderDraft but can be converted into an Active order if activateOrder is true. If the Quote to be converted is for a new Account prospect, that Account will automatically be converted to a customer Account once the Quote is converted. Any attachments to the quote will follow to the converted order but notes will not. This operation can be also used for Change Quotes - so after convert, change will be applied to linked Order.
Authorizations
Header parameters
api-versionstringOptional
younium-idempotency-keystringOptional
younium-idempotency-durationInHoursintegerOptional
Body
all ofOptional
Responses
200
Success
application/json
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
post
POST /Quotes/convertToOrder HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 60
{
"quote": {
"key": "text",
"value": "text"
},
"activateOrder": true
}
{
"quoteId": "123e4567-e89b-12d3-a456-426614174000",
"quoteNumber": "text",
"quote": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"number": "text",
"version": 1,
"status": "Open",
"description": "text",
"quoteType": "New",
"changeOrderId": "123e4567-e89b-12d3-a456-426614174000",
"convertedToOrder": {
"orderNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"customer": {
"name": "text",
"accountNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"invoiceCustomer": {
"name": "text",
"accountNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"orderType": "Subscription",
"currency": "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"
},
"quoteDate": "2025-06-25T00:40:30.362Z",
"validToDate": "2025-06-25T00:40:30.362Z",
"yourReference": "text",
"ourReference": "text",
"remarks": "text",
"initialTerm": 1,
"orderEffectiveChangeDate": "2025-06-25T00:40:30.362Z",
"effectiveStartDate": "2025-06-25T00:40:30.362Z",
"effectiveEndDate": "2025-06-25T00:40:30.362Z",
"termType": "Termed",
"renewalTerm": 1,
"autoRenewal": true,
"noticePeriod": 1,
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-06-25T00:40:30.362Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-06-25T00:40:30.362Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-06-25T00:40:30.362Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"created": "2025-06-25T00:40:30.362Z",
"modified": "2025-06-25T00:40:30.362Z",
"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",
"quoteProductChargeId": "123e4567-e89b-12d3-a456-426614174000",
"chargeNumber": "text",
"name": "text",
"charge": {
"chargeNumber": "text",
"name": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"originalOrderProductChargeId": "123e4567-e89b-12d3-a456-426614174000",
"chargeType": "OneOff",
"priceModel": "Flat",
"startOn": "AlignToSubscription",
"endOn": "AlignToSubscription",
"effectiveStartDate": "2025-06-25T00:40:30.362Z",
"effectiveEndDate": "2025-06-25T00:40:30.362Z",
"quantity": 1,
"unitCode": "text",
"pricePeriod": "Monthly",
"usageRating": "Sum",
"billingPeriod": "Monthly",
"remarks": "text",
"displayPrice": 1,
"ppu": 1,
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"created": "2025-06-25T00:40:30.362Z",
"modified": "2025-06-25T00:40:30.362Z",
"priceDetails": [
{
"tier": 1,
"price": 1,
"listPrice": 1,
"description": "text",
"fromQuantity": 1,
"toQuantity": 1,
"priceBase": "Flat",
"lineDiscountPercent": 1,
"lineDiscountAmount": 1
}
],
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-06-25T00:40:30.362Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-06-25T00:40:30.362Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-06-25T00:40:30.362Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
],
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"created": "2025-06-25T00:40:30.362Z",
"modified": "2025-06-25T00:40:30.362Z",
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-06-25T00:40:30.362Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-06-25T00:40:30.362Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-06-25T00:40:30.362Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
],
"quoteESignings": [
{
"state": "Started",
"fileName": "text",
"validToDate": "2025-06-25T00:40:30.362Z"
}
]
},
"orderId": "123e4567-e89b-12d3-a456-426614174000",
"orderNumber": "text",
"orderType": "Subscription",
"orderStatus": "Draft"
}
get
Authorizations
Query parameters
Skipinteger · int32OptionalExample:
Skip number of records
10
Takeinteger · int32OptionalExample:
Take number of records
5
FilterstringOptionalExample:
Filter the resulsts. See ODATA documentation for more information
name eq 'Adam' and age gt 20
SortstringOptionalExample:
Sorting the results. See ODATA specificaion for more information
name
Header parameters
api-versionstringOptional
Responses
200
Success
application/json
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
get
GET /Quotes HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"number": "text",
"version": 1,
"status": "Open",
"description": "text",
"quoteType": "New",
"changeOrderId": "123e4567-e89b-12d3-a456-426614174000",
"convertedToOrder": {
"orderNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"customer": {
"name": "text",
"accountNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"invoiceCustomer": {
"name": "text",
"accountNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"orderType": "Subscription",
"currency": "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"
},
"quoteDate": "2025-06-25T00:40:30.362Z",
"validToDate": "2025-06-25T00:40:30.362Z",
"yourReference": "text",
"ourReference": "text",
"remarks": "text",
"initialTerm": 1,
"orderEffectiveChangeDate": "2025-06-25T00:40:30.362Z",
"effectiveStartDate": "2025-06-25T00:40:30.362Z",
"effectiveEndDate": "2025-06-25T00:40:30.362Z",
"termType": "Termed",
"renewalTerm": 1,
"autoRenewal": true,
"noticePeriod": 1,
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-06-25T00:40:30.362Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-06-25T00:40:30.362Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-06-25T00:40:30.362Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"created": "2025-06-25T00:40:30.362Z",
"modified": "2025-06-25T00:40:30.362Z",
"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",
"quoteProductChargeId": "123e4567-e89b-12d3-a456-426614174000",
"chargeNumber": "text",
"name": "text",
"charge": {
"chargeNumber": "text",
"name": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"originalOrderProductChargeId": "123e4567-e89b-12d3-a456-426614174000",
"chargeType": "OneOff",
"priceModel": "Flat",
"startOn": "AlignToSubscription",
"endOn": "AlignToSubscription",
"effectiveStartDate": "2025-06-25T00:40:30.362Z",
"effectiveEndDate": "2025-06-25T00:40:30.362Z",
"quantity": 1,
"unitCode": "text",
"pricePeriod": "Monthly",
"usageRating": "Sum",
"billingPeriod": "Monthly",
"remarks": "text",
"displayPrice": 1,
"ppu": 1,
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"created": "2025-06-25T00:40:30.362Z",
"modified": "2025-06-25T00:40:30.362Z",
"priceDetails": [
{
"tier": 1,
"price": 1,
"listPrice": 1,
"description": "text",
"fromQuantity": 1,
"toQuantity": 1,
"priceBase": "Flat",
"lineDiscountPercent": 1,
"lineDiscountAmount": 1
}
],
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-06-25T00:40:30.362Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-06-25T00:40:30.362Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-06-25T00:40:30.362Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
],
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"created": "2025-06-25T00:40:30.362Z",
"modified": "2025-06-25T00:40:30.362Z",
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-06-25T00:40:30.362Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-06-25T00:40:30.362Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-06-25T00:40:30.362Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
],
"quoteESignings": [
{
"state": "Started",
"fileName": "text",
"validToDate": "2025-06-25T00:40:30.362Z"
}
]
}
]
Authorizations
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
Responses
200
Success
application/json
400
Bad Request.
application/json
401
Unauthorized
403
Forbidden
404
Not Found
application/json
get
GET /Quotes/{id} HTTP/1.1
Host: api.sandbox.younium.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"number": "text",
"version": 1,
"status": "Open",
"description": "text",
"quoteType": "New",
"changeOrderId": "123e4567-e89b-12d3-a456-426614174000",
"convertedToOrder": {
"orderNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"customer": {
"name": "text",
"accountNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"invoiceCustomer": {
"name": "text",
"accountNumber": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"orderType": "Subscription",
"currency": "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"
},
"quoteDate": "2025-06-25T00:40:30.362Z",
"validToDate": "2025-06-25T00:40:30.362Z",
"yourReference": "text",
"ourReference": "text",
"remarks": "text",
"initialTerm": 1,
"orderEffectiveChangeDate": "2025-06-25T00:40:30.362Z",
"effectiveStartDate": "2025-06-25T00:40:30.362Z",
"effectiveEndDate": "2025-06-25T00:40:30.362Z",
"termType": "Termed",
"renewalTerm": 1,
"autoRenewal": true,
"noticePeriod": 1,
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-06-25T00:40:30.362Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-06-25T00:40:30.362Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-06-25T00:40:30.362Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"created": "2025-06-25T00:40:30.362Z",
"modified": "2025-06-25T00:40:30.362Z",
"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",
"quoteProductChargeId": "123e4567-e89b-12d3-a456-426614174000",
"chargeNumber": "text",
"name": "text",
"charge": {
"chargeNumber": "text",
"name": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"externalERPId": "text",
"externalCRMId": "text"
},
"originalOrderProductChargeId": "123e4567-e89b-12d3-a456-426614174000",
"chargeType": "OneOff",
"priceModel": "Flat",
"startOn": "AlignToSubscription",
"endOn": "AlignToSubscription",
"effectiveStartDate": "2025-06-25T00:40:30.362Z",
"effectiveEndDate": "2025-06-25T00:40:30.362Z",
"quantity": 1,
"unitCode": "text",
"pricePeriod": "Monthly",
"usageRating": "Sum",
"billingPeriod": "Monthly",
"remarks": "text",
"displayPrice": 1,
"ppu": 1,
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"created": "2025-06-25T00:40:30.362Z",
"modified": "2025-06-25T00:40:30.362Z",
"priceDetails": [
{
"tier": 1,
"price": 1,
"listPrice": 1,
"description": "text",
"fromQuantity": 1,
"toQuantity": 1,
"priceBase": "Flat",
"lineDiscountPercent": 1,
"lineDiscountAmount": 1
}
],
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-06-25T00:40:30.362Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-06-25T00:40:30.362Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-06-25T00:40:30.362Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
],
"customFields": {
"ANY_ADDITIONAL_PROPERTY": "anything"
},
"created": "2025-06-25T00:40:30.362Z",
"modified": "2025-06-25T00:40:30.362Z",
"cmrr": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-06-25T00:40:30.362Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"acv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-06-25T00:40:30.362Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
},
"tcv": {
"amount": 1,
"currencyCode": "text",
"currencyConversionDate": "2025-06-25T00:40:30.362Z",
"baseCurrencyAmount": 1,
"baseCurrencyCode": "text"
}
}
],
"quoteESignings": [
{
"state": "Started",
"fileName": "text",
"validToDate": "2025-06-25T00:40:30.362Z"
}
]
}
Last updated