POST List/SaleType/Items
Some tooltip text!
• 8 minutes to read
• 8 minutes to read
POST /api/v1/List/SaleType/Items
Create a new SaleTypeEntity list item
Calls the List agent service SaveSaleTypeEntity.
Request Headers
| Parameter Name | Description |
|---|---|
| Authorization | Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type. |
| X-XSRF-TOKEN | If not using Authorization header, you must provide XSRF value from cookie or hidden input field |
| Content-Type | Content-type of the request body: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded, application/json-patch+json, application/merge-patch+json |
| Accept | Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json |
| Accept-Language | Convert string references and multi-language values into a specified language (iso2) code. |
| SO-Language | Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. |
| SO-Culture | Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. |
| SO-TimeZone | Specify the timezone code that you would like date/time responses converted to. |
| SO-AppToken | The application token that identifies the partner app. Used when calling Online WebAPI from a server. |
Request Body: newEntity
The SaleTypeEntity to be created.
| Property Name | Type | Description |
|---|---|---|
| SaleTypeId | Integer | Primary key |
| Name | String | The list item |
| Tooltip | String | Tooltip or other description |
| Rank | Integer | Rank order |
| DurationUnit | String | Units for the duration (day, week, whatever) |
| SaleDuration | Integer | Expected number of dales from initiation to close of sale |
| SaleTypeCatId | Integer | Category of sale type, copied to sale |
| Deleted | Boolean | 0 -> record is active 1 -> record is 'deleted' and should not be shown in lists |
| HasGuide | Boolean | Does this sale type have a guide attached |
| HasStakeholders | Boolean | Does this sale type have stakeholders |
| IsAutoAdvance | Boolean | Does the sale stage advance automatically, when the last guided activity in a stage is completed? |
| AllowQuoteAlternatives | Boolean | Can quotes linked to sales of this type, have multiple Alternatives |
| DefaultQuoteValidity | Integer | Default valid days for quotes linked to sales of this type (valid from quote transmission) |
| QuoteLinesTemplate | Integer | The template that this sale type should use when producing the product lines offer document; the template must have DocTmplQuoteType=QuoteLines |
| ConfirmationLinesTemplate | Integer | The template that this sale type should use when producing the order confirmation lines document; the template must have DocTmplQuoteType=ConfirmationLines |
| MaxDiscountPercentSet | Boolean | Is there a limit, in percent, to the total discount on quotes linked to sales of this type |
| MinEarningPercentSet | Boolean | Is there a limit, in earning as percent of total, on quotes linked to sales of this type |
| MaxDiscountPercent | Integer | The maximum discount in percent of total, if set, on quotes linked to sales of this type |
| MinEarningPercent | Integer | The minimum earning in percent of total, if set, on quotes linked to sales of this type |
| GroupQuoteLinesBy | Integer | Group quote lines by this field |
| SortGroupLinesBy | Integer | Sort group lines by this field |
| Stages | Array | Stages, those associated with this SaleType are selected. |
Response:
OK
| Response | Description |
|---|---|
| 200 | OK |
Response body: SaleTypeEntity
| Property Name | Type | Description |
|---|---|---|
| SaleTypeId | int32 | Primary key |
| Name | string | The list item |
| Tooltip | string | Tooltip or other description |
| Rank | int32 | Rank order |
| DurationUnit | string | Units for the duration (day, week, whatever) |
| SaleDuration | int32 | Expected number of dales from initiation to close of sale |
| SaleTypeCatId | int32 | Category of sale type, copied to sale |
| Deleted | bool | 0 -> record is active 1 -> record is 'deleted' and should not be shown in lists |
| HasGuide | bool | Does this sale type have a guide attached |
| HasStakeholders | bool | Does this sale type have stakeholders |
| IsAutoAdvance | bool | Does the sale stage advance automatically, when the last guided activity in a stage is completed? |
| AllowQuoteAlternatives | bool | Can quotes linked to sales of this type, have multiple Alternatives |
| DefaultQuoteValidity | int32 | Default valid days for quotes linked to sales of this type (valid from quote transmission) |
| QuoteLinesTemplate | int32 | The template that this sale type should use when producing the product lines offer document; the template must have DocTmplQuoteType=QuoteLines |
| ConfirmationLinesTemplate | int32 | The template that this sale type should use when producing the order confirmation lines document; the template must have DocTmplQuoteType=ConfirmationLines |
| MaxDiscountPercentSet | bool | Is there a limit, in percent, to the total discount on quotes linked to sales of this type |
| MinEarningPercentSet | bool | Is there a limit, in earning as percent of total, on quotes linked to sales of this type |
| MaxDiscountPercent | int32 | The maximum discount in percent of total, if set, on quotes linked to sales of this type |
| MinEarningPercent | int32 | The minimum earning in percent of total, if set, on quotes linked to sales of this type |
| GroupQuoteLinesBy | int32 | Group quote lines by this field |
| SortGroupLinesBy | int32 | Sort group lines by this field |
| Stages | array | Stages, those associated with this SaleType are selected. Use MDO List name "salestage" to get list items. |
| TableRight | TableRight | The carrier's table right |
| FieldProperties | object | Field property dictionary mapping field names to field access rights. |
Sample request
POST /api/v1/List/SaleType/Items
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: en
Content-Type: application/json; charset=utf-8
{
"SaleTypeId": 22,
"Name": "Bernhard Group",
"Tooltip": "distinctio",
"Rank": 885,
"DurationUnit": "Century",
"SaleDuration": 515,
"SaleTypeCatId": 941,
"Deleted": false,
"HasGuide": true,
"HasStakeholders": false,
"IsAutoAdvance": true,
"AllowQuoteAlternatives": false,
"DefaultQuoteValidity": 32,
"QuoteLinesTemplate": 990,
"ConfirmationLinesTemplate": 734,
"MaxDiscountPercentSet": false,
"MinEarningPercentSet": false,
"MaxDiscountPercent": 416,
"MinEarningPercent": 872,
"GroupQuoteLinesBy": 492,
"SortGroupLinesBy": 888,
"Stages": [
{
"Id": 961,
"Name": "Thiel LLC",
"ToolTip": "Qui velit voluptate.",
"Deleted": true,
"Rank": 252,
"Type": "ipsam",
"ColorBlock": 415,
"IconHint": "temporibus",
"Selected": false,
"LastChanged": "1998-12-04T14:13:50.2283063+01:00",
"ChildItems": [
{},
{}
],
"ExtraInfo": "fuga",
"StyleHint": "et",
"Hidden": true,
"FullName": "Nicholas Cummerata"
}
]
}
Sample response
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"SaleTypeId": 240,
"Name": "Jewess, Braun and Keebler",
"Tooltip": "nisi",
"Rank": 494,
"DurationUnit": "Century",
"SaleDuration": 67,
"SaleTypeCatId": 256,
"Deleted": false,
"HasGuide": true,
"HasStakeholders": false,
"IsAutoAdvance": false,
"AllowQuoteAlternatives": true,
"DefaultQuoteValidity": 363,
"QuoteLinesTemplate": 894,
"ConfirmationLinesTemplate": 919,
"MaxDiscountPercentSet": false,
"MinEarningPercentSet": true,
"MaxDiscountPercent": 918,
"MinEarningPercent": 806,
"GroupQuoteLinesBy": 258,
"SortGroupLinesBy": 445,
"Stages": [
{
"Id": 755,
"Name": "Upton Inc and Sons",
"ToolTip": "Qui quo eligendi ea repellendus quae eos.",
"Deleted": false,
"Rank": 639,
"Type": "eius",
"ColorBlock": 210,
"IconHint": "architecto",
"Selected": false,
"LastChanged": "2013-12-02T14:13:50.2283063+01:00",
"ChildItems": [
{},
{}
],
"ExtraInfo": "facilis",
"StyleHint": "placeat",
"Hidden": false,
"FullName": "Fay Cummerata",
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 81
}
}
}
],
"TableRight": null,
"FieldProperties": {
"fieldName": {
"FieldRight": null,
"FieldType": "System.Int32",
"FieldLength": 39
}
}
}