Quotes

Convert Quote to new Order.

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.

POSThttps://api.sandbox.younium.com/Quotes/convertToOrder

Authorization

oauth2

Header parameters

Body

application/json

quote*all of

activateOrderboolean

Response

200400401403

Success

Body

application/json

quoteIdstring (uuid)

quoteNumbernullable string

quotenullable all of

orderIdstring (uuid)

orderNumbernullable string

orderTypeall of

orderStatusall of

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Quotes/convertToOrder', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "quote": {}
    }),
});
const data = await response.json();

Response

200400

{
  "quoteId": "123e4567-e89b-12d3-a456-426614174000",
  "quoteNumber": "text",
  "quote": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "number": "text",
    "version": 0,
    "status": {},
    "description": "text",
    "quoteType": {},
    "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": {},
    "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": "2024-12-22T11:19:51.063Z",
    "validToDate": "2024-12-22T11:19:51.063Z",
    "yourReference": "text",
    "ourReference": "text",
    "remarks": "text",
    "initialTerm": 0,
    "orderEffectiveChangeDate": "2024-12-22T11:19:51.063Z",
    "effectiveStartDate": "2024-12-22T11:19:51.063Z",
    "effectiveEndDate": "2024-12-22T11:19:51.063Z",
    "termType": {},
    "renewalTerm": 0,
    "autoRenewal": false,
    "noticePeriod": 0,
    "tcv": {
      "amount": 0,
      "currencyCode": "text",
      "currencyConversionDate": "2024-12-22T11:19:51.063Z",
      "baseCurrencyAmount": 0,
      "baseCurrencyCode": "text"
    },
    "cmrr": {
      "amount": 0,
      "currencyCode": "text",
      "currencyConversionDate": "2024-12-22T11:19:51.063Z",
      "baseCurrencyAmount": 0,
      "baseCurrencyCode": "text"
    },
    "acv": {
      "amount": 0,
      "currencyCode": "text",
      "currencyConversionDate": "2024-12-22T11:19:51.063Z",
      "baseCurrencyAmount": 0,
      "baseCurrencyCode": "text"
    },
    "created": "2024-12-22T11:19:51.063Z",
    "modified": "2024-12-22T11:19:51.063Z",
    "products": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "productNumber": "text",
        "chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
        "chargePlanName": "text",
        "chargePlanNumber": "text",
        "productLineNumber": 0,
        "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": {},
            "priceModel": {},
            "startOn": {},
            "endOn": {},
            "effectiveStartDate": "2024-12-22T11:19:51.063Z",
            "effectiveEndDate": "2024-12-22T11:19:51.063Z",
            "quantity": 0,
            "unitCode": "text",
            "pricePeriod": {},
            "usageRating": {},
            "billingPeriod": {},
            "remarks": "text",
            "displayPrice": 0,
            "ppu": 0,
            "created": "2024-12-22T11:19:51.063Z",
            "modified": "2024-12-22T11:19:51.063Z",
            "priceDetails": [
              {
                "tier": 0,
                "price": 0,
                "listPrice": 0,
                "description": "text",
                "fromQuantity": 0,
                "toQuantity": 0,
                "priceBase": {},
                "lineDiscountPercent": 0,
                "lineDiscountAmount": 0
              }
            ],
            "cmrr": {
              "amount": 0,
              "currencyCode": "text",
              "currencyConversionDate": "2024-12-22T11:19:51.063Z",
              "baseCurrencyAmount": 0,
              "baseCurrencyCode": "text"
            },
            "acv": {
              "amount": 0,
              "currencyCode": "text",
              "currencyConversionDate": "2024-12-22T11:19:51.063Z",
              "baseCurrencyAmount": 0,
              "baseCurrencyCode": "text"
            },
            "tcv": {
              "amount": 0,
              "currencyCode": "text",
              "currencyConversionDate": "2024-12-22T11:19:51.063Z",
              "baseCurrencyAmount": 0,
              "baseCurrencyCode": "text"
            }
          }
        ],
        "created": "2024-12-22T11:19:51.063Z",
        "modified": "2024-12-22T11:19:51.063Z",
        "cmrr": {
          "amount": 0,
          "currencyCode": "text",
          "currencyConversionDate": "2024-12-22T11:19:51.063Z",
          "baseCurrencyAmount": 0,
          "baseCurrencyCode": "text"
        },
        "acv": {
          "amount": 0,
          "currencyCode": "text",
          "currencyConversionDate": "2024-12-22T11:19:51.063Z",
          "baseCurrencyAmount": 0,
          "baseCurrencyCode": "text"
        },
        "tcv": {
          "amount": 0,
          "currencyCode": "text",
          "currencyConversionDate": "2024-12-22T11:19:51.063Z",
          "baseCurrencyAmount": 0,
          "baseCurrencyCode": "text"
        }
      }
    ],
    "quoteESignings": [
      {
        "state": {},
        "fileName": "text",
        "validToDate": "2024-12-22T11:19:51.063Z"
      }
    ]
  },
  "orderId": "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber": "text",
  "orderType": {},
  "orderStatus": {}
}

Get Quotes

GEThttps://api.sandbox.younium.com/Quotes

Authorization

oauth2

Query parameters

Header parameters

Response

200400401403

Success

Body

application/json

pageNumberinteger (int32)

pageSizeinteger (int32)

totalPagesnullable integer (int32)

totalCountinteger (int32)

nextPagenullable string (uri)

previousPagenullable string (uri)

firstPagenullable string (uri)

lastPagenullable string (uri)

datanullable array of QuoteResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Quotes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400

{
  "pageNumber": 0,
  "pageSize": 0,
  "totalPages": 0,
  "totalCount": 0,
  "nextPage": "https://example.com",
  "previousPage": "https://example.com",
  "firstPage": "https://example.com",
  "lastPage": "https://example.com",
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "number": "text",
      "version": 0,
      "status": {},
      "description": "text",
      "quoteType": {},
      "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": {},
      "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": "2024-12-22T11:19:51.063Z",
      "validToDate": "2024-12-22T11:19:51.063Z",
      "yourReference": "text",
      "ourReference": "text",
      "remarks": "text",
      "initialTerm": 0,
      "orderEffectiveChangeDate": "2024-12-22T11:19:51.063Z",
      "effectiveStartDate": "2024-12-22T11:19:51.063Z",
      "effectiveEndDate": "2024-12-22T11:19:51.063Z",
      "termType": {},
      "renewalTerm": 0,
      "autoRenewal": false,
      "noticePeriod": 0,
      "tcv": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:19:51.063Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "cmrr": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:19:51.063Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:19:51.063Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "created": "2024-12-22T11:19:51.063Z",
      "modified": "2024-12-22T11:19:51.063Z",
      "products": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "productNumber": "text",
          "chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
          "chargePlanName": "text",
          "chargePlanNumber": "text",
          "productLineNumber": 0,
          "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": {},
              "priceModel": {},
              "startOn": {},
              "endOn": {},
              "effectiveStartDate": "2024-12-22T11:19:51.063Z",
              "effectiveEndDate": "2024-12-22T11:19:51.063Z",
              "quantity": 0,
              "unitCode": "text",
              "pricePeriod": {},
              "usageRating": {},
              "billingPeriod": {},
              "remarks": "text",
              "displayPrice": 0,
              "ppu": 0,
              "created": "2024-12-22T11:19:51.063Z",
              "modified": "2024-12-22T11:19:51.063Z",
              "priceDetails": [
                {
                  "tier": 0,
                  "price": 0,
                  "listPrice": 0,
                  "description": "text",
                  "fromQuantity": 0,
                  "toQuantity": 0,
                  "priceBase": {},
                  "lineDiscountPercent": 0,
                  "lineDiscountAmount": 0
                }
              ],
              "cmrr": {
                "amount": 0,
                "currencyCode": "text",
                "currencyConversionDate": "2024-12-22T11:19:51.063Z",
                "baseCurrencyAmount": 0,
                "baseCurrencyCode": "text"
              },
              "acv": {
                "amount": 0,
                "currencyCode": "text",
                "currencyConversionDate": "2024-12-22T11:19:51.063Z",
                "baseCurrencyAmount": 0,
                "baseCurrencyCode": "text"
              },
              "tcv": {
                "amount": 0,
                "currencyCode": "text",
                "currencyConversionDate": "2024-12-22T11:19:51.063Z",
                "baseCurrencyAmount": 0,
                "baseCurrencyCode": "text"
              }
            }
          ],
          "created": "2024-12-22T11:19:51.063Z",
          "modified": "2024-12-22T11:19:51.063Z",
          "cmrr": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:19:51.063Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "acv": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:19:51.063Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "tcv": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:19:51.063Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          }
        }
      ],
      "quoteESignings": [
        {
          "state": {},
          "fileName": "text",
          "validToDate": "2024-12-22T11:19:51.063Z"
        }
      ]
    }
  ]
}

Get Quotes by Id

GEThttps://api.sandbox.younium.com/Quotes/{id}

Authorization

oauth2

Path parameters

id*string (uuid)

Header parameters

Response

200400401403404

Success

Body

application/json

idstring (uuid)

numbernullable string

versioninteger (int32)

statusall of

descriptionnullable string

quoteTypeall of

changeOrderIdnullable string (uuid)

convertedToOrdernullable all of

customernullable all of

invoiceCustomernullable all of

orderTypeall of

currencynullable string

deliveryAddressnullable all of

quoteDatestring (date-time)

validToDatestring (date-time)

yourReferencenullable string

ourReferencenullable string

remarksnullable string

Additional information, copied to the order remark

initialTerminteger (int32)

orderEffectiveChangeDatenullable string (date-time)

effectiveStartDatestring (date-time)

effectiveEndDatestring (date-time)

termTypeall of

renewalTerminteger (int32)

autoRenewalboolean

noticePeriodinteger (int32)

tcvnullable all of

cmrrnullable all of

acvnullable all of

customFieldsnullable object

createdstring (date-time)

modifiedstring (date-time)

productsnullable array of QuoteProductResponse (object)

quoteESigningsnullable array of QuoteESigningResponse (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.sandbox.younium.com/Quotes/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "number": "text",
  "version": 0,
  "status": {},
  "description": "text",
  "quoteType": {},
  "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": {},
  "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": "2024-12-22T11:19:51.063Z",
  "validToDate": "2024-12-22T11:19:51.063Z",
  "yourReference": "text",
  "ourReference": "text",
  "remarks": "text",
  "initialTerm": 0,
  "orderEffectiveChangeDate": "2024-12-22T11:19:51.063Z",
  "effectiveStartDate": "2024-12-22T11:19:51.063Z",
  "effectiveEndDate": "2024-12-22T11:19:51.063Z",
  "termType": {},
  "renewalTerm": 0,
  "autoRenewal": false,
  "noticePeriod": 0,
  "tcv": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:19:51.063Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "cmrr": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:19:51.063Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "acv": {
    "amount": 0,
    "currencyCode": "text",
    "currencyConversionDate": "2024-12-22T11:19:51.063Z",
    "baseCurrencyAmount": 0,
    "baseCurrencyCode": "text"
  },
  "created": "2024-12-22T11:19:51.063Z",
  "modified": "2024-12-22T11:19:51.063Z",
  "products": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "productNumber": "text",
      "chargePlanId": "123e4567-e89b-12d3-a456-426614174000",
      "chargePlanName": "text",
      "chargePlanNumber": "text",
      "productLineNumber": 0,
      "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": {},
          "priceModel": {},
          "startOn": {},
          "endOn": {},
          "effectiveStartDate": "2024-12-22T11:19:51.063Z",
          "effectiveEndDate": "2024-12-22T11:19:51.063Z",
          "quantity": 0,
          "unitCode": "text",
          "pricePeriod": {},
          "usageRating": {},
          "billingPeriod": {},
          "remarks": "text",
          "displayPrice": 0,
          "ppu": 0,
          "created": "2024-12-22T11:19:51.063Z",
          "modified": "2024-12-22T11:19:51.063Z",
          "priceDetails": [
            {
              "tier": 0,
              "price": 0,
              "listPrice": 0,
              "description": "text",
              "fromQuantity": 0,
              "toQuantity": 0,
              "priceBase": {},
              "lineDiscountPercent": 0,
              "lineDiscountAmount": 0
            }
          ],
          "cmrr": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:19:51.063Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "acv": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:19:51.063Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          },
          "tcv": {
            "amount": 0,
            "currencyCode": "text",
            "currencyConversionDate": "2024-12-22T11:19:51.063Z",
            "baseCurrencyAmount": 0,
            "baseCurrencyCode": "text"
          }
        }
      ],
      "created": "2024-12-22T11:19:51.063Z",
      "modified": "2024-12-22T11:19:51.063Z",
      "cmrr": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:19:51.063Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:19:51.063Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 0,
        "currencyCode": "text",
        "currencyConversionDate": "2024-12-22T11:19:51.063Z",
        "baseCurrencyAmount": 0,
        "baseCurrencyCode": "text"
      }
    }
  ],
  "quoteESignings": [
    {
      "state": {},
      "fileName": "text",
      "validToDate": "2024-12-22T11:19:51.063Z"
    }
  ]
}

---