For the complete documentation index, see llms.txt. This page is also available as Markdown.

Quotes

Convert Quote to new Order.

post

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.

Required scopes
This endpoint requires the following scopes:
  • : Access Younium API
Authorizations
OAuth2passwordRequired
Token URL:
Header parameters
api-versionstringOptional
younium-idempotency-keystringOptional
younium-idempotency-durationInHoursintegerOptional
Body
activateOrderbooleanOptional
Responses
200

Success

application/json
quoteIdstring · uuidOptional
quoteNumberstring · nullableOptional
orderIdstring · uuidOptional
orderNumberstring · nullableOptional
orderTypestring · enumOptionalPossible values:
orderStatusstring · enumOptionalPossible values:
post/Quotes/convertToOrder

Get Quotes

get
Required scopes
This endpoint requires the following scopes:
  • : Access Younium API
Authorizations
OAuth2passwordRequired
Token URL:
Query parameters
FilterstringOptional

Filter the results. See developer resources for more information. On endpoints whose entity supports custom fields you can also filter by custom field: customFieldEq('fieldName', 'value') (equals) or customFieldExist('fieldName') (field has a non-empty value). Custom-field functions may only be combined with and.

Example: name eq 'Adam' and age gt 20 and customFieldEq('region', 'EU')
OrderBystringOptional

Sorting the results. See developer resources for more information

Example: accountNumber Desc
ModifiedAfterstring · date-timeOptional

Apply a separate modified After filter. See 'ModifiedBefore' filter for further details.

Example: 2026-07-01
ModifiedBeforestring · date-timeOptional

Filter is also applied on sub entities: 'products', 'charges', 'priceDetails' and 'customFields' on these entities

Example: 2026-07-01
PageSizeinteger · int32Optional

Page Size

Example: 20
PageNumberinteger · int32Optional

Page Number

Example: 1
Header parameters
api-versionstringOptional
Responses
200

Success

application/json
pageNumberinteger · int32Optional
pageSizeinteger · int32Optional
totalPagesinteger · int32 · nullableOptional
totalCountinteger · int32Optional
nextPagestring · uri · nullableOptional
previousPagestring · uri · nullableOptional
firstPagestring · uri · nullableOptional
lastPagestring · uri · nullableOptional
get/Quotes

Get Quotes by Id

get
Required scopes
This endpoint requires the following scopes:
  • : Access Younium API
Authorizations
OAuth2passwordRequired
Token URL:
Path parameters
idstring · uuidRequired
Header parameters
api-versionstringOptional
Responses
200

Success

application/json
idstring · uuidOptional
numberstring · nullableOptional
versioninteger · int32Optional
statusstring · enumOptionalPossible values:
descriptionstring · nullableOptional
quoteTypestring · enumOptionalPossible values:
changeOrderIdstring · uuid · nullableOptional
orderTypestring · enumOptionalPossible values:
currencystring · nullableOptional
quoteDatestring · date-timeOptional
validToDatestring · date-timeOptional
yourReferencestring · nullableOptional
ourReferencestring · nullableOptional
remarksstring · nullableOptional

Additional information, copied to the order remark

initialTerminteger · int32Optional
orderEffectiveChangeDatestring · date-time · nullableOptional
effectiveStartDatestring · date-timeOptional
effectiveEndDatestring · date-timeOptional
termTypestring · enumOptionalPossible values:
renewalTerminteger · int32Optional
autoRenewalbooleanOptional
noticePeriodinteger · int32Optional
createdstring · date-timeOptional
modifiedstring · date-timeOptional
get/Quotes/{id}

Last updated