Get Quote Lines

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Quote/GetQuoteLines");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"QuoteAlternativeId\": 123\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({QuoteAlternativeId: 123})
};

fetch('http://localhost:56350/api/v1/Agents/Quote/GetQuoteLines', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Quote/GetQuoteLines",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'QuoteAlternativeId' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "http://localhost:56350/api/v1/Agents/Quote/GetQuoteLines"

payload = { "QuoteAlternativeId": 123 }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({QuoteAlternativeId: 123})
};

fetch('http://localhost:56350/api/v1/Agents/Quote/GetQuoteLines', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "QuoteLineId": 123,
    "ERPQuoteLineKey": "<string>",
    "QuoteAlternativeId": 123,
    "ERPProductKey": "<string>",
    "Status": "Ok",
    "Reason": "<string>",
    "Quantity": 123,
    "DeliveredQuantity": 123,
    "Rank": 123,
    "Name": "<string>",
    "Description": "<string>",
    "Code": "<string>",
    "QuantityUnit": "<string>",
    "PriceUnit": "<string>",
    "ItemNumber": "<string>",
    "Url": "<string>",
    "ProductCategoryKey": "<string>",
    "ProductFamilyKey": "<string>",
    "ProductTypeKey": "<string>",
    "Supplier": "<string>",
    "SupplierCode": "<string>",
    "Thumbnail": "<string>",
    "VATInfo": "<string>",
    "VAT": 123,
    "UnitCost": 123,
    "UnitMinimumPrice": 123,
    "UnitListPrice": 123,
    "ExtraInfo": [
      {
        "Name": "<string>",
        "Value": "<string>",
        "Type": "String",
        "TableRight": {
          "Mask": "<string>",
          "Reason": "<string>"
        },
        "FieldProperties": {}
      }
    ],
    "RawExtraInfo": "<string>",
    "IsSubscription": true,
    "SubscriptionUnit": "<string>",
    "SubscriptionQuantity": 123,
    "SubscriptionStart": "2023-11-07T05:31:56Z",
    "ERPDiscountPercent": 123,
    "ERPDiscountAmount": 123,
    "DiscountPercent": 123,
    "DiscountAmount": 123,
    "UserValueOverride": "None",
    "EarningPercent": 123,
    "EarningAmount": 123,
    "SubTotal": 123,
    "TotalPrice": 123,
    "Rights": "<string>",
    "Rule": "<string>",
    "ExtraField1": "<string>",
    "ExtraField2": "<string>",
    "ExtraField3": "<string>",
    "ExtraField4": "<string>",
    "ExtraField5": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  }
]

Get Quote Lines

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Agents/Quote/GetQuoteLines");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddJsonBody("{\n  \"QuoteAlternativeId\": 123\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({QuoteAlternativeId: 123})
};

fetch('http://localhost:56350/api/v1/Agents/Quote/GetQuoteLines', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/Agents/Quote/GetQuoteLines",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'QuoteAlternativeId' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

import requests

url = "http://localhost:56350/api/v1/Agents/Quote/GetQuoteLines"

payload = { "QuoteAlternativeId": 123 }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({QuoteAlternativeId: 123})
};

fetch('http://localhost:56350/api/v1/Agents/Quote/GetQuoteLines', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "QuoteLineId": 123,
    "ERPQuoteLineKey": "<string>",
    "QuoteAlternativeId": 123,
    "ERPProductKey": "<string>",
    "Status": "Ok",
    "Reason": "<string>",
    "Quantity": 123,
    "DeliveredQuantity": 123,
    "Rank": 123,
    "Name": "<string>",
    "Description": "<string>",
    "Code": "<string>",
    "QuantityUnit": "<string>",
    "PriceUnit": "<string>",
    "ItemNumber": "<string>",
    "Url": "<string>",
    "ProductCategoryKey": "<string>",
    "ProductFamilyKey": "<string>",
    "ProductTypeKey": "<string>",
    "Supplier": "<string>",
    "SupplierCode": "<string>",
    "Thumbnail": "<string>",
    "VATInfo": "<string>",
    "VAT": 123,
    "UnitCost": 123,
    "UnitMinimumPrice": 123,
    "UnitListPrice": 123,
    "ExtraInfo": [
      {
        "Name": "<string>",
        "Value": "<string>",
        "Type": "String",
        "TableRight": {
          "Mask": "<string>",
          "Reason": "<string>"
        },
        "FieldProperties": {}
      }
    ],
    "RawExtraInfo": "<string>",
    "IsSubscription": true,
    "SubscriptionUnit": "<string>",
    "SubscriptionQuantity": 123,
    "SubscriptionStart": "2023-11-07T05:31:56Z",
    "ERPDiscountPercent": 123,
    "ERPDiscountAmount": 123,
    "DiscountPercent": 123,
    "DiscountAmount": 123,
    "UserValueOverride": "None",
    "EarningPercent": 123,
    "EarningAmount": 123,
    "SubTotal": 123,
    "TotalPrice": 123,
    "Rights": "<string>",
    "Rule": "<string>",
    "ExtraField1": "<string>",
    "ExtraField2": "<string>",
    "ExtraField3": "<string>",
    "ExtraField4": "<string>",
    "ExtraField5": "<string>",
    "TableRight": {
      "Mask": "<string>",
      "Reason": "<string>"
    },
    "FieldProperties": {}
  }
]

Headers

Accept-Language

string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language

string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture

string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone

string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken

string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Query Parameters

$select

string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields.

Body

QuoteAlternativeId

GetQuoteLines: Get all QuoteLines from an alternative

QuoteAlternativeId

integer<int32>

Response

QuoteLineId

integer<int32>

Primary key

ERPQuoteLineKey

string

The foreign key to the quoteline in ERP system (if it has such a representation).

QuoteAlternativeId

integer<int32>

The alternative this line is part of, the conceptual Parent in CRM database.

ERPProductKey

string

Foreign key of product+pricelist this line is based on. Can be blank since the QuoteLine doesn’t have to be connected to a product.

Status

enum<string>

If there was a problem with for instance calculation, this field is set to warning or error. Typically shown as an icon. QuoteStatus is an enum with statuses: OK, OKWithInfo, Warning, Error.

Available options:

Ok,

OkWithInfo,

Warning,

Error

Reason

string

If QuoteStatus is not OK, then this field contains a localized explanation that the user can be shown.

Quantity

number<double>

How many units; this is a decimal field since you might want to offer fractional units (2.5kg, or 0.5PC).

DeliveredQuantity

number<double>

How many units have been delivered - updated by ERP system.

Rank

integer<int32>

QuoteLines can be re-ordered, so we must track the ordering.

Name

string

The name of the product. Is stored here if the user changes the value from the product in the pricelist, or just enters a QuoteLine without a product link.

Description

string

A longer description for the product. Is stored here if the user changes the value from the product in the pricelist, or just enters a QuoteLine without a product link.

Code

string

A value the salesmen use to quickly find the correct product. Is stored here if the user changes the value from the product in the pricelist, or just enters a QuoteLine without a product link.

QuantityUnit

string

What is the unit (meter, ton, bushel, microsecond, gradus, τρυβλίον, 五合枡, دونم or whatever); Connector handles conversion relative to PriceUnit if they are different.

PriceUnit

string

What is the unit (meter, ton, bushel, microsecond, gradus, τρυβλίον, 五合枡, دونم or whatever); read-only for lines that originate in defined products.

ItemNumber

string

Norwegian: «Postnummer». Specific numbers from some hierarchy, for instance '1.4.3.2'. Is stored here if the user changes the value from the product in the pricelist, or just enters a QuoteLine without a product link.

Url

string

A url to the product info. Can be empty. Is stored here if the user changes the value from the product in the pricelist, or just enters a QuoteLine without a product link.

ProductCategoryKey

string

Either a List id to an id from a connector provided list, or, if the connection doesn't support lists, a text. Is stored here if the user changes the value from the product in the pricelist, or just enters a QuoteLine without a product link.

ProductFamilyKey

string

ProductTypeKey

string

Supplier

string

The name of the supplier. Is stored here if the user changes the value from the product in the pricelist, or just enters a QuoteLine without a product link.

SupplierCode

string

The suppliers' code or part number for this product. Is stored here if the user changes the value from the product in the pricelist, or just enters a QuoteLine without a product link.

Thumbnail

string

A small image of the product, typically used to show in a list. Base64 encoded png.

VATInfo

string

Tax/VAT information, Extra info about VAT that the connector might insert, and the users might want to specify on the quote. The core CRM product has no business logic for this field, it is wholly up to connectors to use it.

VAT

number<double>

Tax/VAT - THIS IS A PERCENTAGE. The connector is responsible for populating this field; the percentage will be used to calculate VAT amounts available as merge fields in the document templates (but amounts are never stored in the database).

UnitCost

number<double>

The cost price per unit for this product. May be filled in by connector if it has the Provide-Cost capability.

UnitMinimumPrice

number<double>

The minimum price this line can be sold for (to limit discounting). Will come from the connector. List price per unit must exceed the minimum price per unit.

UnitListPrice

number<double>

The standard list price; as given by ERP Connector, OR overridden by user

ExtraInfo

object[]

Extra information, supplied by QuoteConnector, used by a future dynamic GUI extension

Show child attributes

RawExtraInfo

string

Read-only extra information in plain text, supplied by QuoteConnector, used by a future dynamic GUI extension

IsSubscription

boolean

Is this a subscription product, sold in repeating intervals/amounts?

SubscriptionUnit

string

Either a List id to an id from a connector provided list, or, if the connection doesn’t support lists, a text with the actual subscription unit.

SubscriptionQuantity

number<double>

The default number of SubscriptionUnits to suggest when creating quote lines from this product

SubscriptionStart

string<date-time>

Start date for subscription, as offered

ERPDiscountPercent

number<double>

The discount the system calculates based on customer / quantity / whatever. Can be overrided by the salesman in the field 'DiscountPercent' or 'DiscountAmount'. Both fields ERPDiscountPercent and ERPDiscountAmount will be filled out. If UserValueOverride is set to ‘None’ then the value is copied to DiscountPercent. The Percentage is given in integer form, i.e. ‘12%’ is represented as ‘12’.

ERPDiscountAmount

number<double>

The discount the system calculates based on customer / quantity / whatever. Can be overrided by the salesman in the field 'DiscountPercent' or 'DiscountAmount'. If UserValueOverride is set to ‘None’ then the value is copied to DiscountAmount. Both fields ERPDiscountPercent and ERPDiscountAmount will be filled out.

DiscountPercent

number<double>

The discount for the line, in percent. Both ‘DiscountPercent’ and ‘DiscountAmount’ shall be filled out, but the UserValueOverride field must be set to the field the user actually changed last. If this field is filled out by the user, it overrides any discount suggested by the connector. If the user has not filled this in, the system will copy the ERP discount amount to this field. The Percentage is given in integer form, i.e. ‘12%’ is represented as ‘12’.

DiscountAmount

number<double>

The discount for the line, in whatever currency the sale is in. Both ‘DiscountPercent’ and ‘DiscountAmount’ shall be filled out, but the UserValueOverride field must be set to the field the user actually changed last. If this field is filled out by the user, it overrides any discount suggested by the connector. If the user has not filled this in, the system will copy the ERP discount amount to this field.

UserValueOverride

enum<string>

Has the pre-calculated (from ERP) price information been overridden, and how. If the user has filled out the discountpercentage field, then the UserValueOverride field is set to OverridePercent. (The DiscountAmount, EarningPercent, EarningAmount and TotalPrice fields are calculated based on the DiscountPercent.)

Available options:

None,

Total,

DiscountPercent,

DiscountAmount,

EarningPercent,

EarningAmount

EarningPercent

number<double>

The earning, in percent. Both ‘EarningAmount and ‘EarningPercent shall be filled out, but the UserValueOverride field must be set to the field the user actually changed last. The Percentage is given in integer form, i.e. ‘12%’ is represented as ‘12’.

EarningAmount

number<double>

The earning, in whatever currency the sale is in. Both ‘EarningAmount and ‘EarningPercent shall be filled out, but the UserValueOverride field must be set to the field the user actually changed last.

SubTotal

number<double>

Value to help the user interface, is equal to 'Quantity * ListPrice'

TotalPrice

number<double>

TotalPrice = SubTotal - DiscountAmount or TotalPrice = (UnitCost * Quantity) + EarningAmount, according to what the user changed last.

Rights

string

Field1=right&Field2=right, etc. of any fields that have non-standard field access rights. Rights can be one of: N (=None or Hidden), R (=Read-only), W (=Writeable), M (=Mandatory). The fields will mostly be from the Quoteline table, but some added fields that are conceptually part of the quoteline, like Image will also be possibly to set rights on. Will be used by SuperOffice to control the user interface when showing the record.

Rule

string

The names of one or more calculation rules that are in effect for this line, comma-separated case-insensitive

ExtraField1

string