afv-library/skills/platform-data-and-tooling-api-context-get/assets/enterprise_api/QuoteLineGroup.json

158 lines
4.4 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"fields",
"field_reference"
],
"title": "QuoteLineGroup - Data API",
"description": "Stores the group information for line items in a quote. It also stores the aggregated line field information (subtotal). It contains a parent-child relationship to quote. This object is available in API version 61.0 and later.",
"fields_columns": [
"type",
"properties",
"description",
"relationship_name",
"relationship_type",
"refers_to"
],
"fields": {
"Description": {
"type": "string",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "The description of the group."
},
"EndDate": {
"type": "date",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "Reserved for future use."
},
"Name": {
"type": "string",
"properties": "Create, Filter, Group, idLookup, Sort, Update",
"description": "The name of the group."
},
"QuoteId": {
"type": "reference",
"properties": "Create, Filter, Group, Sort",
"description": "The quote associated with the group. This field is a relationship field.",
"relationship_name": "Quote",
"relationship_type": "Master-detail",
"refers_to": "Quote (the master object)"
},
"SegmentType": {
"type": "picklist",
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
"description": "The time period for the segment. Possible values are: Custom FreeTrial—Free Trial Prorated Yearly The default value is Yearly."
},
"SortOrder": {
"type": "int",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "Number indicating the sort order selected by the user."
},
"StartDate": {
"type": "date",
"properties": "Create, Filter, Group, Nillable, Sort, Update",
"description": "Reserved for future use."
},
"SummarySubtotal": {
"type": "currency",
"properties": "Create, Filter, Nillable, Sort, Update",
"description": "The total amount of all the line items in the group."
},
"Type": {
"type": "picklist",
"properties": "Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
"description": "The type of the group. Possible values are: CPQQuoteGroup—CPQ Line Grouping The default value is CPQQuoteGroup."
},
"UnitPriceUplift": {
"type": "percent",
"properties": "Create, Filter, Nillable, Sort, Update",
"description": "The percentage increase of the quote line group's unit price."
}
},
"field_reference": {
"CreatedById": {
"field_label": "Created By ID",
"type": "reference",
"length": "18"
},
"CreatedDate": {
"field_label": "Created Date",
"type": "datetime"
},
"CurrencyIsoCode": {
"field_label": "Currency ISO Code",
"type": "picklist",
"length": "3"
},
"Description": {
"field_label": "Description",
"type": "string",
"length": "255"
},
"EndDate": {
"field_label": "End Date",
"type": "date"
},
"Id": {
"field_label": "Quote Line Group ID",
"type": "id",
"length": "18"
},
"IsDeleted": {
"field_label": "Deleted",
"type": "boolean"
},
"LastModifiedById": {
"field_label": "Last Modified By ID",
"type": "reference",
"length": "18"
},
"LastModifiedDate": {
"field_label": "Last Modified Date",
"type": "datetime"
},
"Name": {
"field_label": "Quote Line Group Name",
"type": "string",
"length": "255"
},
"QuoteId": {
"field_label": "Quote ID",
"type": "reference",
"length": "18"
},
"SortOrder": {
"field_label": "Sort Order",
"type": "int",
"digits": "9"
},
"StartDate": {
"field_label": "Start Date",
"type": "date"
},
"SummarySubtotal": {
"field_label": "Summary Subtotal",
"type": "currency",
"precision": "18",
"scale": "2"
},
"SystemModstamp": {
"field_label": "System Modstamp",
"type": "datetime"
},
"Type": {
"field_label": "Quote Line Group Type",
"type": "picklist",
"length": "255"
}
},
"field_reference_columns": [
"field_label",
"type",
"length",
"digits",
"precision",
"scale"
]
}