Quotes

Last updated 3 months ago

Was this helpful?

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.

post

/Quotes/convertToOrder

Authorizations

Header parameters

api-versionstring

Body

activateOrderboolean

quoteall ofrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.younium.com/Quotes/convertToOrder' \
  --header 'Content-Type: application/json' \
  --data '{"quote":{}}'

200

400

401

403

{
  "quoteId": "123e4567-e89b-12d3-a456-426614174000",
  "quoteNumber": "text",
  "orderId": "123e4567-e89b-12d3-a456-426614174000",
  "orderNumber": "text",
  "quote": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "number": "text",
    "version": 1,
    "description": "text",
    "changeOrderId": "123e4567-e89b-12d3-a456-426614174000",
    "currency": "text",
    "quoteDate": "2025-02-22T08:47:15.352Z",
    "validToDate": "2025-02-22T08:47:15.352Z",
    "yourReference": "text",
    "ourReference": "text",
    "remarks": "text",
    "initialTerm": 1,
    "orderEffectiveChangeDate": "2025-02-22T08:47:15.352Z",
    "effectiveStartDate": "2025-02-22T08:47:15.352Z",
    "effectiveEndDate": "2025-02-22T08:47:15.352Z",
    "renewalTerm": 1,
    "autoRenewal": true,
    "noticePeriod": 1,
    "created": "2025-02-22T08:47:15.352Z",
    "modified": "2025-02-22T08:47:15.352Z",
    "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",
        "created": "2025-02-22T08:47:15.352Z",
        "modified": "2025-02-22T08:47:15.352Z",
        "customFields": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "charges": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "quoteProductChargeId": "123e4567-e89b-12d3-a456-426614174000",
            "chargeNumber": "text",
            "name": "text",
            "originalOrderProductChargeId": "123e4567-e89b-12d3-a456-426614174000",
            "effectiveStartDate": "2025-02-22T08:47:15.352Z",
            "effectiveEndDate": "2025-02-22T08:47:15.352Z",
            "quantity": 1,
            "unitCode": "text",
            "remarks": "text",
            "displayPrice": 1,
            "ppu": 1,
            "created": "2025-02-22T08:47:15.352Z",
            "modified": "2025-02-22T08:47:15.352Z",
            "customFields": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "priceDetails": [
              {
                "tier": 1,
                "price": 1,
                "listPrice": 1,
                "description": "text",
                "fromQuantity": 1,
                "toQuantity": 1,
                "lineDiscountPercent": 1,
                "lineDiscountAmount": 1,
                "priceBase": "Flat"
              }
            ],
            "charge": {
              "chargeNumber": "text",
              "name": "text",
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "externalERPId": "text",
              "externalCRMId": "text"
            },
            "chargeType": "OneOff",
            "priceModel": "Flat",
            "startOn": "AlignToSubscription",
            "endOn": "AlignToSubscription",
            "pricePeriod": "Monthly",
            "usageRating": "Sum",
            "billingPeriod": "Monthly",
            "cmrr": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2025-02-22T08:47:15.352Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            },
            "acv": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2025-02-22T08:47:15.352Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            },
            "tcv": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2025-02-22T08:47:15.352Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            }
          }
        ],
        "cmrr": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2025-02-22T08:47:15.352Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        },
        "acv": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2025-02-22T08:47:15.352Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        },
        "tcv": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2025-02-22T08:47:15.352Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        }
      }
    ],
    "quoteESignings": [
      {
        "fileName": "text",
        "validToDate": "2025-02-22T08:47:15.352Z",
        "state": "Started"
      }
    ],
    "status": "Open",
    "quoteType": "New",
    "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",
    "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"
    },
    "termType": "Termed",
    "tcv": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2025-02-22T08:47:15.352Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    },
    "cmrr": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2025-02-22T08:47:15.352Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    },
    "acv": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2025-02-22T08:47:15.352Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    }
  },
  "orderType": "Subscription",
  "orderStatus": "Draft"
}

Success

get

/Quotes

Authorizations

Query parameters

Skipinteger · int32

Skip number of records

Example: 10

Takeinteger · int32

Take number of records

Example: 5

Filterstring

Filter the resulsts. See ODATA documentation for more information

Example: name eq 'Adam' and age gt 20

Sortstring

Sorting the results. See ODATA specificaion for more information

Example: name

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.younium.com/Quotes'

200

400

401

403

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "number": "text",
    "version": 1,
    "description": "text",
    "changeOrderId": "123e4567-e89b-12d3-a456-426614174000",
    "currency": "text",
    "quoteDate": "2025-02-22T08:47:15.352Z",
    "validToDate": "2025-02-22T08:47:15.352Z",
    "yourReference": "text",
    "ourReference": "text",
    "remarks": "text",
    "initialTerm": 1,
    "orderEffectiveChangeDate": "2025-02-22T08:47:15.352Z",
    "effectiveStartDate": "2025-02-22T08:47:15.352Z",
    "effectiveEndDate": "2025-02-22T08:47:15.352Z",
    "renewalTerm": 1,
    "autoRenewal": true,
    "noticePeriod": 1,
    "created": "2025-02-22T08:47:15.352Z",
    "modified": "2025-02-22T08:47:15.352Z",
    "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",
        "created": "2025-02-22T08:47:15.352Z",
        "modified": "2025-02-22T08:47:15.352Z",
        "customFields": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        },
        "charges": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "quoteProductChargeId": "123e4567-e89b-12d3-a456-426614174000",
            "chargeNumber": "text",
            "name": "text",
            "originalOrderProductChargeId": "123e4567-e89b-12d3-a456-426614174000",
            "effectiveStartDate": "2025-02-22T08:47:15.352Z",
            "effectiveEndDate": "2025-02-22T08:47:15.352Z",
            "quantity": 1,
            "unitCode": "text",
            "remarks": "text",
            "displayPrice": 1,
            "ppu": 1,
            "created": "2025-02-22T08:47:15.352Z",
            "modified": "2025-02-22T08:47:15.352Z",
            "customFields": {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            },
            "priceDetails": [
              {
                "tier": 1,
                "price": 1,
                "listPrice": 1,
                "description": "text",
                "fromQuantity": 1,
                "toQuantity": 1,
                "lineDiscountPercent": 1,
                "lineDiscountAmount": 1,
                "priceBase": "Flat"
              }
            ],
            "charge": {
              "chargeNumber": "text",
              "name": "text",
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "externalERPId": "text",
              "externalCRMId": "text"
            },
            "chargeType": "OneOff",
            "priceModel": "Flat",
            "startOn": "AlignToSubscription",
            "endOn": "AlignToSubscription",
            "pricePeriod": "Monthly",
            "usageRating": "Sum",
            "billingPeriod": "Monthly",
            "cmrr": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2025-02-22T08:47:15.352Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            },
            "acv": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2025-02-22T08:47:15.352Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            },
            "tcv": {
              "amount": 1,
              "currencyCode": "text",
              "currencyConversionDate": "2025-02-22T08:47:15.352Z",
              "baseCurrencyAmount": 1,
              "baseCurrencyCode": "text"
            }
          }
        ],
        "cmrr": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2025-02-22T08:47:15.352Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        },
        "acv": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2025-02-22T08:47:15.352Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        },
        "tcv": {
          "amount": 1,
          "currencyCode": "text",
          "currencyConversionDate": "2025-02-22T08:47:15.352Z",
          "baseCurrencyAmount": 1,
          "baseCurrencyCode": "text"
        }
      }
    ],
    "quoteESignings": [
      {
        "fileName": "text",
        "validToDate": "2025-02-22T08:47:15.352Z",
        "state": "Started"
      }
    ],
    "status": "Open",
    "quoteType": "New",
    "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",
    "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"
    },
    "termType": "Termed",
    "tcv": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2025-02-22T08:47:15.352Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    },
    "cmrr": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2025-02-22T08:47:15.352Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    },
    "acv": {
      "amount": 1,
      "currencyCode": "text",
      "currencyConversionDate": "2025-02-22T08:47:15.352Z",
      "baseCurrencyAmount": 1,
      "baseCurrencyCode": "text"
    }
  }
]

Success

Get Quotes by Id

get

/Quotes/{id}

Authorizations

Path parameters

idstring · uuidrequired

Header parameters

api-versionstring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.younium.com/Quotes/{id}'

200

400

401

403

404

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "number": "text",
  "version": 1,
  "description": "text",
  "changeOrderId": "123e4567-e89b-12d3-a456-426614174000",
  "currency": "text",
  "quoteDate": "2025-02-22T08:47:15.352Z",
  "validToDate": "2025-02-22T08:47:15.352Z",
  "yourReference": "text",
  "ourReference": "text",
  "remarks": "text",
  "initialTerm": 1,
  "orderEffectiveChangeDate": "2025-02-22T08:47:15.352Z",
  "effectiveStartDate": "2025-02-22T08:47:15.352Z",
  "effectiveEndDate": "2025-02-22T08:47:15.352Z",
  "renewalTerm": 1,
  "autoRenewal": true,
  "noticePeriod": 1,
  "created": "2025-02-22T08:47:15.352Z",
  "modified": "2025-02-22T08:47:15.352Z",
  "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",
      "created": "2025-02-22T08:47:15.352Z",
      "modified": "2025-02-22T08:47:15.352Z",
      "customFields": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "charges": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "quoteProductChargeId": "123e4567-e89b-12d3-a456-426614174000",
          "chargeNumber": "text",
          "name": "text",
          "originalOrderProductChargeId": "123e4567-e89b-12d3-a456-426614174000",
          "effectiveStartDate": "2025-02-22T08:47:15.352Z",
          "effectiveEndDate": "2025-02-22T08:47:15.352Z",
          "quantity": 1,
          "unitCode": "text",
          "remarks": "text",
          "displayPrice": 1,
          "ppu": 1,
          "created": "2025-02-22T08:47:15.352Z",
          "modified": "2025-02-22T08:47:15.352Z",
          "customFields": {
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "priceDetails": [
            {
              "tier": 1,
              "price": 1,
              "listPrice": 1,
              "description": "text",
              "fromQuantity": 1,
              "toQuantity": 1,
              "lineDiscountPercent": 1,
              "lineDiscountAmount": 1,
              "priceBase": "Flat"
            }
          ],
          "charge": {
            "chargeNumber": "text",
            "name": "text",
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "externalERPId": "text",
            "externalCRMId": "text"
          },
          "chargeType": "OneOff",
          "priceModel": "Flat",
          "startOn": "AlignToSubscription",
          "endOn": "AlignToSubscription",
          "pricePeriod": "Monthly",
          "usageRating": "Sum",
          "billingPeriod": "Monthly",
          "cmrr": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-02-22T08:47:15.352Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "acv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-02-22T08:47:15.352Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          },
          "tcv": {
            "amount": 1,
            "currencyCode": "text",
            "currencyConversionDate": "2025-02-22T08:47:15.352Z",
            "baseCurrencyAmount": 1,
            "baseCurrencyCode": "text"
          }
        }
      ],
      "cmrr": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T08:47:15.352Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "acv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T08:47:15.352Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      },
      "tcv": {
        "amount": 1,
        "currencyCode": "text",
        "currencyConversionDate": "2025-02-22T08:47:15.352Z",
        "baseCurrencyAmount": 1,
        "baseCurrencyCode": "text"
      }
    }
  ],
  "quoteESignings": [
    {
      "fileName": "text",
      "validToDate": "2025-02-22T08:47:15.352Z",
      "state": "Started"
    }
  ],
  "status": "Open",
  "quoteType": "New",
  "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",
  "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"
  },
  "termType": "Termed",
  "tcv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-02-22T08:47:15.352Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "cmrr": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-02-22T08:47:15.352Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  },
  "acv": {
    "amount": 1,
    "currencyCode": "text",
    "currencyConversionDate": "2025-02-22T08:47:15.352Z",
    "baseCurrencyAmount": 1,
    "baseCurrencyCode": "text"
  }
}

Success