--- title: Sales Agreement API description: The Sales Agreement API provides methods for creating a new sales agreement and retrieving an existing sales agreement of a given sys\_id.Retrieve a sales agreement associated with a given sys\_id.Creates a new sales agreement according to details provided in the request body. locale: en-US canonical_url: https://www.servicenow.com/docs/r/australia/api-reference/rest-apis/sales\_agreement-api.html release: australia product: REST APIs classification: rest-apis topic_type: concept last_updated: "2026-03-12" reading_time_minutes: 110 breadcrumb: [REST API reference, API reference, API implementation and reference] --- # Sales Agreement API The Sales Agreement API provides methods for creating a new sales agreement and retrieving an existing sales agreement of a given sys\_id. This API works with data in the [Sales Agreement Management](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/order-management/sales-agreement-mgmt.md) application, which managers, agents, and administrators use to generate sales agreements from quotes. The Sales Agreement API runs in the sn\_sales\_agmt\_core namespace and requires three plugins to access it: - Sales Agreement Data Model \(com.sn\_sales\_agmt\_core\) , - Product Catalog Management Core \(com.sn\_prd\_pm\), - Pricing \(com.sn\_csm\_pricing\) The API also requires the sn\_sales\_agmt\_core.sales\_agreement\_integrator role to access it. Most data is retrieved from or updated in the following tables upon calling this API and must be populated for its endpoints to work successfully: - Account \[customer\_account\], - Product Offering \[sn\_prd\_pm\_product\_offering\], - Product Model \[cmdb\_model\], - Quote \[quote\], - Quote Line \[quote\_line\], - Price List \[price\_list\] - Account \[customer\_account\] - Price List \[sn\_csm\_pricing\_price\_list\] - Product Model \[cmdb\_model\] - Product Offering \[sn\_prd\_pm\_product\_offering\] - Quote \[sn\_quote\_mgmt\_core\_quote\] - Quote Line \[sn\_quote\_mgmt\_core\_quote\_line\_item\] - Sales Agreement \[sn\_sales\_agmt\_core\_sales\_agreement\] - Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] - Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] - Sales Agreement Line Characteristics \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_characteristic\] **Parent Topic:**[REST API reference](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/api-rest.md) ## Sales Agreement - GET /api/sn\_sales\_agmt\_core/salesagreement/\{id\} Retrieve a sales agreement associated with a given sys\_id. ### URL format Versioned URL: `GET /api/sn_sales_agmt_core/v1/salesagreement/{id}` Default URL: `GET /api/sn_sales_agmt_core/salesagreement/{id}` ### Supported request parameters
| Name | Description |
|---|---|
| api\_version | Optional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String |
| id | Required. Sys\_id of the sales agreement to retrieve.Table: Sales Agreement \[sn\_sales\_agmt\_core\_sales\_agreement\] Data type: String |
| Name | Description |
|---|---|
| display\_value | Optional. Returns the sales agreement properties in a chosen format.Valid values: - all: Response contains the **name**, **label**, **value**, **display\_value**, and **type** properties for all fields in the sales agreement. For example: ``` "state": { "display_name": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` - false: Response contains just the **value** property for all fields in the sales agreement. For example: ``` "state": { "value": "draft" } ``` - true: Response contains just the **display\_value** property for all fields in the sales agreement. For example: ``` "state": { "display_value": "Draft" } ``` Default: false |
| Name | Description |
|---|---|
| result | Results of the sales agreement with all its associated information.Data type: Object ``` "result": { "account": {Object}, "billing_location": {Object}, "consumer": {Object}, "contact": {Object}, "currency": {Object}, "default_price_list": {Object}, "ends": {Object}, "number": {Object}, "quote": {Object}, "sales_agreement_lines": [Array] "shipping_location": {Object}, "short_description": {Object}, "starts": {Object}, "state": {Object}, "sys_id": {Object}, "sys_created_by": {Object}, "sys_created_on": {Object}, "sys_updated_by": {Object}, "sys_updated_on": {Object} } ``` |
| account | Account information associated with the sales agreement.Table: Account \[customer\_account\] Data type: Object ``` "account": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| account.display\_value | Display value of the account. Matches **account.value**.Data type: String |
| account.label | Label of the account.Data type: String |
| account.name | Name of the account.Data type: String |
| account.type | Type of account. Value is always `reference`.Data type: String |
| account.value | Sys\_id of the account.Table: Account \[customer\_account\] Data type: String |
| billing\_location | Billing address of the sales agreement.Updated table: Location \[cmn\_location\] Data type: Object ``` "billing_location": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| billing\_location.display\_value | Display value of the billing location. Matches **billing\_location.value**.Data type: String |
| billing\_location.label | Label of the billing location.Data type: String |
| billing\_location.name | Name of the billing location.Data type: String |
| billing\_location.type | Type of billing location. Value is always `reference`.Data type: String |
| billing\_location.value | Value of the billing location.Data type: String |
| consumer | Consumer details of the sales agreement.Table: Consumer \[csm\_consumer\] Data type: Object ``` "consumer": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| consumer.display\_value | Display value of the consumer. Matches **consumer.value**.Data type: String |
| consumer.label | Label of the consumer.Data type: String |
| consumer.name | Name of the consumer.Data type: String |
| consumer.type | Type of consumer. Value is always `reference`.Data type: String |
| consumer.value | Value of the consumer.Data type: String |
| contact | Contact information associated with the sales agreement.Table: Contact \[customer\_contact\] Data type: Object ``` "contact": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| contact.display\_value | Display value of the contact. Matches **contact.value**.Data type: String |
| contact.label | Label of the contact.Data type: String |
| contact.name | Name of the contact. Data type: String |
| contact.type | Type of contact. Value is always `reference`.Data type: String |
| contact.value | Value of the contact.Data type: String |
| currency | Currency code associated with the sales agreement.Table: Currency \[fx\_currency\] Data type: Object ``` "currency": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| currency.display\_value | Display value of the currency. Matches **currency.value**. For example, `USD`.Data type: String |
| currency.label | Label of the currency.Data type: String |
| currency.name | Name of the currency.Data type: String |
| currency.type | Type of currency. Value is always `reference`.Data type: String |
| currency.value | Country currency code of the currency. For example, `USD`.Data type: String |
| default\_price\_list | Details about the default price list of the sales agreement.Table: Price List \[sn\_csm\_pricing\_price\_list\] Data type: Object ``` "default_price_list": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| default\_price\_list.display\_value | Display value of the default price list.Data type: String |
| default\_price\_list.label | Label of the default price list.Data type: String |
| default\_price\_list.name | Name of the default price list.Data type: String |
| default\_price\_list.type | Type of default price list. Value is always `reference`.Data type: String |
| default\_price\_list.value | Sys\_id of the default price list.Data type: String |
| ends | End date of the sales agreement.Data type: Object ``` "ends": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| ends.display\_value | Display value of the end date. Matches **end.value**.Data type: String |
| ends.label | Label of the end date.Data type: String |
| ends.label | Name of the end date.Data type: String |
| ends.type | Type of end date. Value is always `glide_date`.Data type: String |
| ends.value | Value of the end date.Format: YYYY-MM-DD Data type: String |
| number | Automatically generated sales agreement number or the number posted .Table: Sales Agreement \[sn\_sales\_agmt\_core\_sales\_agreement\] Data type: Object ``` "number": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| number.display\_value | Display value of the sales agreement number. Matches **number.value**.Data type: String |
| number.label | Label of the sales agreement number.Data type: String |
| number.name | Name of the sales agreement number.Data type: String |
| number.type | Type of sales agreement number. Value is always `String`.Data type: String |
| number.value | Value of the sales agreement number. For example, `SA0010106`.Data type: String |
| quote | Information about the sales agreement quote.Table: Quote \[sn\_quote\_mgmt\_core\_quote\] Data type: Object ``` "quote": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| quote.display\_value | Display value of the quote.Data type: String |
| quote.label | Label of the quote.Data type: String |
| quote.name | Name of the quote.Data type: String |
| quote.type | Type of quote. Value is always `reference`.Data type: String |
| quote.value | Sys\_id of the quote.Data type: String |
| sales\_agreement\_lines | List of sales agreement lines under the sales agreement. Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Array of objects ``` sales_agreement_lines": [ { "child_sales_agreement_lines": [Array] "end_date": {Object}, "number": {Object}, "parent_line": {Object}, "price_list": {Object}, "product_model": {Object}, "product_offering": {Object}, "product_specification": {Object}, "quantity": {Object}, "quote_line": {Object}, "sales_agreement": {Object}, "sales_agreement_line_characteristics": [Array], "sales_agreement_line_adjustments": [Array], "shipping_location": {Object}, "short_description": {Object}, "start_date": {Object}, "state": {Object}, "sys_id": {Object}, "sys_created_by": {Object}, "sys_created_on": {Object}, "sys_updated_by": {Object}, "sys_updated_on": {Object}, "top_sales_agreement_line": {Object}, "total_one_time_price": {Object}, "total_recurring_price": {Object}, "unit_net_price": {Object}, "unit_of_measure": {Object}, } ] ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments | List of sales agreement line adjustments.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Array of objects ``` "sales_agreement_line_adjustments": [ { "adjustment_source": {Object}, "adjustment_type": {Object}, "adjustment_value": {Object}, "amount": {Object}, "applicable_to": {Object}, "number": {Object}, "quantity": {Object}, "sales_agreement": {Object}, "sales_agreement_line": {Object}, "short_description": {Object}, "sys_id": {Object}, "sys_created_by": {Object}, "sys_updated_by": {Object}, "sys_created_on": {Object}, "sys_updated_on": {Object}, "total_amount": {Object} } ] ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_source | Source information of the sales agreement line adjustment.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Object ``` "adjustment_source": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_source.display\_value | Source display value of the sales agreement line adjustment. Matches **sales agreement line adjustment.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_source.label | Source label of the sales agreement line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_source.name | Source name of the sales agreement line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_source.type | Source type of sales agreement line adjustment. Value is always `string`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_source.value | Source value of the sales agreement line adjustment.Possible values: - auto - manual Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_type | Information about the sales agreement line adjustment type.Data type: Object ``` "adjustment_type": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_type.display\_value | Display value of the adjustment type.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_type.label | Label of the adjustment type.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_type.name | Name of the adjustment type.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_type.type | Type of adjustment type. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_type.value | Sys\_id of the adjustment type.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_value | Information about the adjustment value.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Object ``` "adjustment_type": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.agreement\_line\_adjustments.adjustment\_value.display\_value | Display value of the adjustment value. Matches **adjustment\_value.value**.Data type: Number \(decimal\) |
| sales\_agreement\_lines.agreement\_line\_adjustments.adjustment\_value.label | Label of the adjustment value.Data type: String |
| sales\_agreement\_lines.agreement\_line\_adjustments.adjustment\_value.name | Name of the adjustment value.Data type: String |
| sales\_agreement\_lines.agreement\_line\_adjustments.adjustment\_value.type | Type of adjustment. Value is always `decimal`.Data type: String |
| sales\_agreement\_lines.agreement\_line\_adjustments.adjustment\_value.value | Number value of the adjustment.Data type: Number \(decimal\) |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.amount | Information about the amount of the sales agreement line adjustment.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Object ``` "amount": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.amount.display\_value | Display value of the adjustment amount. Matches **amount.value**. Automatically includes the dollar sign of the associated currency \(for example, `$0.00` when **currency** is set to `USD`\).Data type: Number \(decimal\) |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.amount.label | Label of the adjustment amount.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.amount.name | Name of the adjustment amount.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.amount.type | Type of the adjustment amount. Value is always `currency`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.amount.value | Dollar value of the adjustment amount.Data type: Number |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.applicable\_to | Reference of the entity that the adjustment is applicable to.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Object ``` "applicable_to": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.applicable\_to.display\_value | Display value of the entity that the adjustment is applicable to. Matches **applicable\_to.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.applicable\_to.label | Label of the entity that the adjustment is applicable to.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.applicable\_to.name | Name of the entity that the adjustment is applicable to.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.applicable\_to.type | Type of the entity that the adjustment is applicable to. Value is always `String`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.applicable\_to.value | Quantity type that the line adjustment is applicable to.Possible values: - LUMPSUM\_QTY: lipsum quantity - UNIT\_QTY: unit quantity Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.number | Automatically generated sales agreement line adjustments number or the number posted.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Object ``` "number": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.number.display\_value | Display value of the adjustments number. Matches **number.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.number.label | Label of the adjustment number.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.number.name | Name of the adjustment number.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.number.type | Type of the adjustment number. Value is always `string`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.number.value | Value of the adjustment number. For example, `SALA0010004`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.quantity | Quantity of product adjusted on the sales agreement line.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Object ``` "quantity": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.quantity.display\_value | Display value of the adjustment quantity. Matches **quantity.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.quantity.label | Label of the adjustment quantity.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.quantity.name | Name of the adjustment quantity.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.quantity.type | Type of the adjustment quantity. Value is always `decimal`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.quantity.value | Value of the adjustment quantity.Data type: Number |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sales\_agreement | Reference to the sales agreement associated with the sales agreement line adjustment.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Object ``` "quantity": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sales\_agreement.display\_value | Display value of the sales agreement associated with the sales agreement line adjustment. For example, `SA0010106`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sales\_agreement.label | Label of the sales agreement associated with the sales agreement line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sales\_agreement.name | Name of the sales agreement associated with the sales agreement line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sales\_agreement.type | Type of the sales agreement associated with the sales agreement line adjustment. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sales\_agreement.value | Sys\_id of the sales agreement associated with the sales agreement line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sales\_agreement\_line | Reference to sales agreement line associated with the sales agreement line adjustment.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Object ``` "sales_agreement_line": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sales\_agreement\_line.display\_value | Number of the sales agreement associated with the sales agreement line adjustment. For example, `SAL0010126`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sales\_agreement\_line.label | Label of the sales agreement associated with the sales agreement line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sales\_agreement\_line.name | Name of the sales agreement associated with the sales agreement line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sales\_agreement\_line.type | Type of the sales agreement associated with the sales agreement line adjustment. Value is always `String`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sales\_agreement\_line.value | Sys\_id of the sales agreement associated with the sales agreement line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.short\_description | Brief description detailing the sales agreement line adjustment.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Object ``` "short_description": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.short\_description.display\_value | Display value of the short description detailing the particular line adjustment. Matches **short\_description.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.short\_description.label | Label of the short description detailing the particular line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.short\_description.name | Name of the short description detailing the particular line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.short\_description.type | Type of the short description detailing the particular line adjustment. Value is always `string`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.short\_description.value | Value of the short description detailing the particular line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_created\_by | Name of the user who created the sales agreement line adjustment.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Object ``` "created_by": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_created\_by.display\_value | Display value of the user who created the sales agreement line adjustment. Matches **created\_by.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_created\_by.label | Label of the user who created the sales agreement line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_created\_by.name | Name of the user who created the sales agreement line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_created\_by.type | Type of the user who created the sales agreement line adjustment. Value is always `string`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_created\_by.value | Value of the user who created the sales agreement line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_created\_on | Date and time of when the sales agreement line adjustment was created.Data type: Object ``` "created_on": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_created\_on.display\_value | Display value of the date and time that the line adjustment was created. Matches **created\_on.value**.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_created\_on.label | Label of the date and time that the line adjustment was created.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_created\_on.name | Name of the date and time that the line adjustment was created.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_created\_on.type | Type of the date and time that the line adjustment was created. Value is always `glide_date_time`.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_created\_on.value | Value of the date and time that the line adjustment was created.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_id | Sys\_id of the sales agreement line adjustment.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Object ``` "sys_id": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_id.display\_value | Display value of the line adjustment sys\_id. Matches **sys\_id.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_id.label | Label of the line adjustment sys\_id.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_id.name | Name of the line adjustment sys\_id.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_id.type | Type of the line adjustment sys\_id. Value is always `string`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_id.value | Value of the line adjustment sys\_id.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_updated\_by | Name of the user who last updated the sales agreement line adjustment.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Object ``` "updated_by": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_updated\_by.display\_value | Display value of the user who last updated the sales agreement line adjustment. Matches **updated\_by.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_updated\_by.label | Label of the user who last updated the sales agreement line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_updated\_by.name | Name of the user who last updated the sales agreement line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_updated\_by.type | Type of user who last updated the sales agreement line adjustment. Value is always `String`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_updated\_by.value | Value of the user who last updated the sales agreement line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_updated\_on | Date and time when the sales agreement line adjustment was updated.Data type: Object ``` "updated_on": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_updated\_on.display\_value | Display value of the date and time that the line adjustment was last updated. Matches **updated\_on.value**.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_updated\_on.label | Label of the date and time that the line adjustment was last updated.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_updated\_on.name | Name of the date and time that the line adjustment was last updated.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_updated\_on.type | Type of date and time that the line adjustment was last updated. Value is always `glide_date_time`.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_updated\_on.value | Value of the date and time that the line adjustment was last updated.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.total\_amount | Total amount of the sales agreement line adjustment.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Object ``` "total_amount": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.total\_amount.display\_value | Display value of the total adjustment amount. Matches **total\_amount.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.total\_amount.label | Label of the total adjustment amount.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.total\_amount.name | Name of the total adjustment amount.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.total\_amount.type | Type of the total adjustment amount. Value is always `currency`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.total\_amount.value | Value of the total adjustment amount.Data type: String represented by a number \(float\) |
| sales\_agreement\_lines.child\_sales\_agreement\_lines | List of sales agreement lines. Follows the same object structure as the **sales\_agreement\_lines** object parameter.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Array of objects ``` "child_sales_agreement_lines": [ { "end_date": {Object}, "number": {Object}, "parent_line": {Object}, "price_list": {Object}, "product_model": {Object}, "product_offering": {Object}, "product_specification": {Object}, "quantity": {Object}, "quote_line": {Object}, "sales_agreement": {Object}, "sales_agreement_line_adjustments": [Array], "sales_agreement_line_characteristics": [Array], "shipping_location": {Object}, "short_description": {Object}, "start_date": {Object}, "state": {Object}, "sys_id": {Object}, "sys_created_by": {Object}, "sys_created_on": {Object}, "sys_updated_by": {Object}, "sys_updated_on": {Object}, "top_sales_agreement_line": {Object}, "total_one_time_price": {Object}, "total_recurring_price": {Object}, "unit_net_price": {Object}, "unit_of_measure": {Object} } ] ``` |
| sales\_agreement\_lines.end\_date | End date of the sales agreement line.Data type: Object ``` "end_date": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.end\_date.display\_value | Display value of the end date for the sales agreement line. Matches **end.value**.Data type: String |
| sales\_agreement\_lines.end\_date.label | Label of the end date for the sales agreement line.Data type: String |
| sales\_agreement\_lines.end\_date.name | Name of the end date for the sales agreement line.Data type: String |
| sales\_agreement\_lines.end\_date.type | Type of end date for the sales agreement line. Value is always `glide_date_time`.Data type: String |
| sales\_agreement\_lines.end\_date.value | End date and time value of the sales agreement line.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| sales\_agreement\_lines.number | Automatically generated sales agreement line number or the number posted .Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Object ``` "number": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.number.display\_value | Display value of the sales agreement line number. For example, `SAL0010128`. Matches **number.value**.Data type: String |
| sales\_agreement\_lines.number.label | Label of the number.Data type: String |
| sales\_agreement\_lines.number.name | Name of the number.Data type: String |
| sales\_agreement\_lines.number.type | Type of number. Value is always `string`.Data type: String |
| sales\_agreement\_lines.number.value | Value of the sales agreement line number. For example, `SAL0010128`.Data type: String |
| sales\_agreement\_lines.parent\_line | Information about the parent sales agreement line.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Object ``` "parent_line": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.parent\_line.display\_value | Display number of the parent sales agreement line. For example, `SAL0010126`.Data type: String |
| sales\_agreement\_lines.parent\_line.label | Label of the parent sales agreement line.Data type: String |
| sales\_agreement\_lines.parent\_line.name | Name of the parent sales agreement line.Data type: String |
| sales\_agreement\_lines.parent\_line.type | Type of parent sales agreement line. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.parent\_line.value | Sys\_id of the parent sales agreement line.Data type: String |
| sales\_agreement\_lines.price\_list | Price list details of the sales agreement line.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Object ``` "price_list": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.price\_list.display\_value | Display value of the sales agreement line's price list.Data type: String |
| sales\_agreement\_lines.price\_list.label | Label of the sales agreement line's price list.Data type: String |
| sales\_agreement\_lines.price\_list.name | Name of the sales agreement line's price list.Data type: String |
| sales\_agreement\_lines.price\_list.type | Type of sales agreement line's price list. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.price\_list.value | Sys\_id of the price list associated with the sales agreement line.Data type: String |
| sales\_agreement\_lines.product\_model | Details about the product model on the sales agreement line.Table: Product Model \[cmdb\_model\] Data type: Object ``` "product_model": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.product\_model.display\_value | Display value of the product model on the sales agreement line. Matches **product\_model.value**.Data type: String |
| sales\_agreement\_lines.product\_model.label | Label of the product model on the sales agreement line.Data type: String |
| sales\_agreement\_lines.product\_model.name | Name of the product model on the sales agreement line.Data type: String |
| sales\_agreement\_lines.product\_model.type | Type of product model on the sales agreement line. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.product\_model.value | Value of the product model on the sales agreement line.Data type: String |
| sales\_agreement\_lines.product\_offering | Details about the product offering on the sales agreement line.Table: Product Offering \[sn\_prd\_pm\_product\_offering\] Data type: Object ``` "product_offering": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.product\_offering.display\_value | Display value of the product offering on the sales agreement line.Data type: String |
| sales\_agreement\_lines.product\_offering.label | Label of the product offering on the sales agreement line.Data type: String |
| sales\_agreement\_lines.product\_offering.name | Name of the product offering on the sales agreement line.Data type: String |
| sales\_agreement\_lines.product\_offering.type | Type of product offering on the sales agreement line. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.product\_offering.value | Value of the product offering on the sales agreement line.Data type: String |
| sales\_agreement\_lines.product\_specification | Reference to product specification of the sales agreement line.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Object ``` "product_offering": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.product\_specification.display\_value | Display value of the product offering on the sales agreement line. Matches **product\_specification.value**.Data type: String |
| sales\_agreement\_lines.product\_specification.label | Label of the product specification on the sales agreement line.Data type: String |
| sales\_agreement\_lines.product\_specification.name | Name of the product specification on the sales agreement line.Data type: String |
| sales\_agreement\_lines.product\_specification.type | Type of product specification on the sales agreement line. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.product\_specification.value | Value of the product specification on the sales agreement line.Data type: String |
| sales\_agreement\_lines.quantity | Number of products to add to the sales agreement line.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Object ``` "quantity": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.quantity.display\_value | Display value of the product quantity on the sales agreement line. Matches **quantity.value**.Data type: String |
| sales\_agreement\_lines.quantity.label | Label of the product quantity on the sales agreement line.Data type: String |
| sales\_agreement\_lines.quantity.name | Name of the product quantity on the sales agreement line.Data type: String |
| sales\_agreement\_lines.quantity.type | Type of product quantity on the sales agreement line. Value is always `decimal`.Data type: String |
| sales\_agreement\_lines.quantity.value | Number of products on the sales agreement line. Data type: Number |
| sales\_agreement\_lines.quote\_line | Reference of the quote line item on the sales agreement line.Table: Quote Line \[sn\_quote\_mgmt\_core\_quote\_line\_item\] Data type: Object ``` "quote_line": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.quote\_line.display\_value | Display value of the quote line item on the sales agreement line.Data type: String |
| sales\_agreement\_lines.quote\_line.label | Label of the quote line item on the sales agreement line.Data type: String |
| sales\_agreement\_lines.quote\_line.name | Name of the quote line item on the sales agreement line.Data type: String |
| sales\_agreement\_lines.quote\_line.type | Type of quote line item on the sales agreement line. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.quote\_line.value | Value of the quote line item on the sales agreement line.Data type: String |
| sales\_agreement\_lines.sales\_agreement | Reference to the sales agreement of the sales agreement line.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Object ``` "sales_agreement": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement.display\_value | Display value of the sales agreement of the sales agreement line. For example, `SA0010106`.Data type: String |
| sales\_agreement\_lines.sales\_agreement.label | Label of the sales agreement of the sales agreement line.Data type: String |
| sales\_agreement\_lines.sales\_agreement.name | Name of the sales agreement of the sales agreement line.Data type: String |
| sales\_agreement\_lines.sales\_agreement.type | Type of sales agreement of the sales agreement line. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.sales\_agreement.value | Sys\_id of the sales agreement of the sales agreement line.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics | List of sales agreement line characteristics.Table: Sales Agreement Line Characteristics \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_characteristic\] Data type: Array of objects ``` "sales_agreement_line_characteristics": [ { "characteristic": {Object}, "characteristic_option": {Object}, "sales_agreement": {Object}, "sales_agreement_line": {Object}, "sys_id": {Object}, "sys_created_by": {Object}, "sys_updated_by": {Object}, "sys_created_on": {Object}, "sys_updated_on": {Object}, "type": {Object}, "value": {Object} } ] ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.characteristic | Characteristic associated with the sales agreement line.Table: sn\_prd\_pm\_characteristic Data type: Object ``` "characteristic": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.characteristic.display\_value | Display value of the characteristic on the sales agreement line.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.characteristic.label | Label of the characteristic on the sales agreement line.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.characteristic.name | Name of the characteristic on the sales agreement line.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.characteristic.type | Type of characteristic on the sales agreement line. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.characteristic.value | Value of the characteristic on the sales agreement line.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.characteristic\_option | Information about the characteristic option on the sales agreement line.Table: Sales Agreement Line Characteristics \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_characteristic\] Data type: Object ``` "characteristic_option": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.characteristic\_option.display\_value | Display value of the characteristic on the sales agreement line. Matches **characteristic\_option.value**. Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.characteristic\_option.label | Label of the characteristic option on the sales agreement line.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.characteristic\_option.name | Name of the characteristic option on the sales agreement line.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.characteristic\_option.type | Type of characteristic option on the sales agreement line. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.characteristic\_option.value | Value of the characteristic option on the sales agreement line.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sales\_agreement | Details of the sales agreement characteristic on the sales agreement line.Table: Sales Agreement Line Characteristics \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_characteristic\] Data type: Object ``` "sales_agreement": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sales\_agreement.display\_value | Display value of the sales agreement characteristic. Matches **sales\_agreement.value**. Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sales\_agreement.label | Label of the sales agreement characteristic.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sales\_agreement.name | Name of the sales agreement characteristic.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sales\_agreement.type | Type of sales agreement characteristic. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sales\_agreement.value | Value of the sales agreement characteristic.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sales\_agreement\_line | Details about the characteristic of the sales agreement line.Table: Sales Agreement Line Characteristics \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_characteristic\] Data type: Object ``` "sales_agreement_line": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sales\_agreement\_line.display\_value | Display value of the characteristic of the sales agreement line. Matches **sales\_agreement\_line.value**. Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sales\_agreement\_line.label | Characteristic label of the sales agreement line.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sales\_agreement\_line.name | Characteristic name of the sales agreement line.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sales\_agreement\_line.type | Characteristic type of the sales agreement line. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sales\_agreement\_line.value | Characteristic value of the sales agreement line.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_created\_by | Name of the user who created the sales agreement line characteristic.Table: User \[user\] Data type: Object ``` "sys_created_by": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_created\_by.display\_value | Display value of the Created by field. Matches **sys\_created\_by.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_created\_by.label | Label of the Created by field.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_created\_by.name | Name of the Created by field.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_created\_by.type | Type of the Created by field. Value is always `string`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_created\_by.value | Value of the Created by field.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_created\_on | Date and time the sales agreement line characteristic was created.Data type: Object ``` "sys_created_on": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_created\_on.display\_value | Display value of the Created on field. Matches **sys\_created\_on.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_created\_on.label | Label of the Created on field.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_created\_on.name | Name of the Created on field.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_created\_on.type | Type of the Created on field. Value is always `glide_date_time`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_created\_on.value | Value of the Created on field.Format: YYYY-DD-MM HH:mm:ss Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_id | Sys\_id of the sales agreement line characteristic.Table: Sales Agreement Line Characteristics \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_characteristic\] Data type: Object ``` "sys_id": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_id.display\_value | Display value of the characteristic sys\_id. Matches **sys\_id.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_id.label | Label of the characteristic sys\_id.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_id.name | Name of the characteristic sys\_id.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_id.type | Type of the characteristic sys\_id. Value is always `string`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_id.id | Value of the characteristic sys\_id.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_updated\_by | Name of the user who last updated the sales agreement line characteristic.Table: User \[user\] Data type: Object ``` "sys_updated_by": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_updated\_by.display\_value | Display value of the user who updated the characteristic of the sales agreement line item. Matches **sys\_created\_by.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_updated\_by.label | Label of the user who updated the characteristic.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_updated\_by.name | Name of the user who updated the characteristic.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_updated\_by.type | Type of the user who updated the characteristic. Value is always `string`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_updated\_by.value | Value of user who updated the characteristic.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_updated\_on | Date and time the sales agreement line characteristic was last updated.Data type: Object ``` "sys_updated_on": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_updated\_on.display\_value | Display value of the updated date. Matches **updated\_on.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_updated\_on.label | Label of the updated date.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_updated\_on.name | Name of the updated date.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_updated\_on.type | Type of the updated date. Value is always `glide_date_time`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_updated\_on.value | Value of the updated date.Format: YYYY-DD-MM HH:mm:ss Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.type | Type of characteristic in the sales agreement line characteristic.Table: Sales Agreement Line Characteristics \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_characteristic\] Data type: Object ``` "type": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.type.display\_value | Display value of the characteristic type. Matches **type.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.type.label | Label of the characteristic type.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.type.name | Name of the characteristic type.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.type.type | Type of the characteristic type. Value is always `string`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.type.value | Value of the characteristic type.Possible values: - coverage - coverage and usage Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.value | Value of the characteristic on the sales agreement line.Table: Sales Agreement Line Characteristics \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_characteristic\] Data type: Object ``` "type": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.value.display\_value | Display value of the characteristic. Matches **type.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.value.label | Label of the characteristic value.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.value.name | Name of the characteristic value.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.value.type | Type of the characteristic value. Value is always `string`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.value.value | Value of the characteristic.Data type: String |
| sales\_agreement\_lines.short\_description | Brief details describing the sales agreement line.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Object ``` "short_description": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.short\_description.display\_value | Display value of the short description. Matches **short\_description.value**.Data type: String |
| sales\_agreement\_lines.short\_description.label | Label of the short description.Data type: String |
| sales\_agreement\_lines.short\_description.name | Name of the short description.Data type: String |
| sales\_agreement\_lines.short\_description.type | Type of short description. Always of type `string`.Data type: String |
| sales\_agreement\_lines.short\_description.value | Value of the short description.Data type: String |
| sales\_agreement\_lines.start\_date | Start date of the sales agreement line.Data type: Object ``` "start_date": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.start\_date.display\_value | Display value of the sales agreement line's start date. Matches **start\_date.value**.Data type: String |
| sales\_agreement\_lines.start\_date.label | Label of the sales agreement line's start date.Data type: String |
| sales\_agreement\_lines.start\_date.name | Name of the sales agreement line's start date.Data type: String |
| sales\_agreement\_lines.start\_date.type | Type of sales agreement line's start date. Value is always `glide_date_time`.Data type: String |
| sales\_agreement\_lines.start\_date.value | Value of the sales agreement line's start date.Format: YYYY-MM-DD Data type: String |
| sales\_agreement\_lines.state | Valid state of the sales agreement line.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Object ``` "state": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.state.display\_value | Display value of the state. Matches **state.value**.Data type: String |
| sales\_agreement\_lines.state.label | Label of the state.Data type: String |
| sales\_agreement\_lines.state.name | Name of the state.Data type: String |
| sales\_agreement\_lines.state.type | Type of state. Value is always `string`.Data type: String |
| sales\_agreement\_lines.state.value | Value of the state.Possible values: - pending\_activation - suspended - active - expired - cancelled Data type: String |
| sales\_agreement\_lines.sys\_created\_by | Name of the user who created the sales agreement line.Table: User \[user\] Data type: Object ``` "sys_created_by": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sys\_created\_by.display\_value | Display value of the user who created the sales agreement line. Matches **sys\_created\_by.value**.Data type: String |
| sales\_agreement\_lines.sys\_created\_by.label | Label of the user who created the sales agreement line.Data type: String |
| sales\_agreement\_lines.sys\_created\_by.name | Name of the user who created the sales agreement line.Data type: String |
| sales\_agreement\_lines.sys\_created\_by.type | Type of the Created by field. Value is always `string`.Data type: String |
| sales\_agreement\_lines.sys\_created\_by.value | Value of the user who created the sales agreement line.Data type: String |
| sales\_agreement\_lines.sys\_created\_on | Date and time the sales agreement line record was created.Data type: Object ``` "sys_created_on": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sys\_created\_on.display\_value | Display value of the creation date of the sales agreement line record. Matches **sys\_created\_on.value**.Data type: String |
| sales\_agreement\_lines.sys\_created\_on.label | Label of the creation date of the sales agreement line record.Data type: String |
| sales\_agreement\_lines.sys\_created\_on.name | Name of the creation date of the sales agreement line record.Data type: String |
| sales\_agreement\_lines.sys\_created\_on.type | Type of the creation date of the sales agreement line record. Value is always `glide_date_time`.Data type: String |
| sales\_agreement\_lines.sys\_created\_on.value | Value of the creation date of the sales agreement line record.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| sales\_agreement\_lines.sys\_id | Sys\_id of the sales agreement line record .Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Object ``` "sys_id": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sys\_id.displayValue | Display value of the sys\_id of the sales agreement line record . Matches **sys\_id.value**.Data type: String |
| sales\_agreement\_lines.sys\_id.label | Automatically-generated name or label of the sales agreement line record sys\_id.Data type: String |
| sales\_agreement\_lines.sys\_id.type | Type of sys\_id of the sales agreement line record . Value is always `string`.Data type: String |
| sales\_agreement\_lines.sys\_id.value | Sys\_id number assigned to the sales agreement line record .Data type: String |
| sales\_agreement\_lines.sys\_updated\_by | Name of the user who last updated the sales agreement line.Table: User \[user\] Data type: Object ``` "sys_updated_by": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sys\_updated\_by.display\_value | Display value of the user who updated the sales agreement line. Matches **sys\_updated\_by.value**.Data type: String |
| sales\_agreement\_lines.sys\_updated\_by.label | Label of the user who updated the sales agreement line.Data type: String |
| sales\_agreement\_lines.sys\_updated\_by.name | Name of the user who updated the sales agreement line.Data type: String |
| sales\_agreement\_lines.sys\_updated\_by.type | Type of the user who updated the sales agreement line. Value is always `string`.Data type: String |
| sales\_agreement\_lines.sys\_updated\_by.value | Value of the user who updated the sales agreement line.Data type: String |
| sales\_agreement\_lines.sys\_updated\_on | Date and time the sales agreement line record was last updated.Data type: Object ``` "sys_updated_on": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sys\_updated\_on.display\_value | The display value of the updated date and time on the sales agreement line. Matches **sys\_updated\_on.value**.Data type: String |
| sales\_agreement\_lines.sys\_updated\_on.label | Label of the updated date and time on the sales agreement lineData type: String |
| sales\_agreement\_lines.sys\_updated\_on.name | Name of the updated date and time on the sales agreement lineData type: String |
| sales\_agreement\_lines.sys\_updated\_on.type | Type of the updated date and time on the sales agreement line. Value is always `glide_date_time`.Data type: String |
| sales\_agreement\_lines.sys\_updated\_on.value | Value of the updated date and time on the sales agreement lineFormat: YYYY-MM-DD HH:mm:ss Data type: String |
| sales\_agreement\_lines.top\_sales\_agreement\_line | Information about the top sales agreement line.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Object ``` "top_sales_agreement_line": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.top\_sales\_agreement\_line.display\_value | Display value of the top sales agreement line. Matches **top\_sales\_agreement\_line.value**.Data type: String |
| sales\_agreement\_lines.top\_sales\_agreement\_line.label | Label of the top sales agreement line.Data type: String |
| sales\_agreement\_lines.top\_sales\_agreement\_line.name | Name the top sales agreement line.Data type: String |
| sales\_agreement\_lines.top\_sales\_agreement\_line.type | Type of the top sales agreement line. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.top\_sales\_agreement\_line.value | Value of the top sales agreement line.Data type: String |
| sales\_agreement\_lines.total\_one\_time\_price | Total one-time charges to be paid for the product or service.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Object ``` "total_one_time_price": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.total\_one\_time\_price.display\_value | Display value of the total one time price. Matches **total\_one\_time\_price.value**.Data type: String |
| sales\_agreement\_lines.total\_one\_time\_price.label | Label of the total one time price.Data type: String |
| sales\_agreement\_lines.total\_one\_time\_price.name | Name of the total one time price.Data type: String |
| sales\_agreement\_lines.total\_one\_time\_price.type | Type of the total one time price. Value is always `decimal`.Data type: String |
| sales\_agreement\_lines.total\_one\_time\_price.value | Value of the total one time price.Data type: String represented as a number \(currency\) |
| sales\_agreement\_lines.total\_recurring\_price | Total recurring price for the product associated with the sales agreement line.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Object ``` "total_recurring_price": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.total\_recurring\_price.display\_value | Display value of the total one time price. Matches **total\_recurring\_price.value**.Data type: String |
| sales\_agreement\_lines.total\_recurring\_price.label | Label of the total recurring price.Data type: String |
| sales\_agreement\_lines.total\_recurring\_price.name | Name of the total recurring price.Data type: String |
| sales\_agreement\_lines.total\_recurring\_price.type | Type of the total recurring price. Value is always `decimal`.Data type: String |
| sales\_agreement\_lines.total\_recurring\_price.value | Value of the total recurring price.Data type: String represented as a number \(currency\) |
| sales\_agreement\_lines.unit\_net\_price | The price for each unit within the sales agreement line.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Object ``` "unit_net_price": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.unit\_net\_price | Display value of the unit net price. Matches **unit\_net\_price.value**.Data type: String |
| sales\_agreement\_lines.unit\_net\_price | Label of the unit net price.Data type: String |
| sales\_agreement\_lines.unit\_net\_price | Name of the unit net price.Data type: String |
| sales\_agreement\_lines.unit\_net\_price | Type of the unit net price. Value is always `decimal`.Data type: String |
| sales\_agreement\_lines.unit\_net\_price | Value of the unit net price.Data type: String represented as a number \(currency\) |
| sales\_agreement\_lines.unit\_of\_measurement | Unit of measurement of the sales agreement line.Table: Unit of measures \[sn\_prd\_pm\_uom\_list\] Data type: Object ``` "unit_of_measurement": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.unit\_of\_measurement.display\_value | Display value of the unit of measurement. Matches **unit\_of\_measurement.value**.Data type: String |
| sales\_agreement\_lines.unit\_of\_measurement.label | Label of the unit of measurement.Data type: String |
| sales\_agreement\_lines.unit\_of\_measurement.name | Name of the unit of measurement.Data type: String |
| sales\_agreement\_lines.unit\_of\_measurement.type | Type of the unit of measurement. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.unit\_of\_measurement.value | Value of the unit of measurement. For example, `bundle` or `each`.Data type: String |
| shipping\_location | Shipping address details on the sales agreement.Table: Location \[location\] Data type: Object ``` "unit_of_measure": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| shipping\_location.display\_value | Display value of the shipping location.Data type: String |
| shipping\_location.label | Label of the shipping location.Data type: String |
| shipping\_location.name | Name of the shipping location.Data type: String |
| shipping\_location.type | Type of shipping location. Value is always `reference`.Data type: String |
| shipping\_location.value | Value of the shipping location. For example, an address.Data type: String |
| short\_description | Brief details describing the sales agreement.Table: Sales Agreement \[sn\_sales\_agmt\_core\_sales\_agreement\] Data type: Object ``` "short_description": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| short\_description.display\_value | Display value of the short description. Matches **short\_description.value**.Data type: String |
| short\_description.label | Label of the short description.Data type: String |
| short\_description.name | Name of the short description.Data type: String |
| short\_description.type | Type of short description. Always of type `string`.Data type: String |
| short\_description.value | Value of the short description.Data type: String |
| starts | Start date of the sales agreement.Data type: Object ``` "starts": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| starts.display\_value | Display value of the start date. Matches **start.value**.Data type: String |
| starts.label | Label of the start date.Data type: String |
| starts.name | Name of the start date.Data type: String |
| starts.type | Type of start date. Value is always `glide_date_time`Data type: String |
| starts.value | Value of the start date.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| state | State of the sales agreement.Table: Sales Agreement \[sn\_sales\_agmt\_core\_sales\_agreement\] Data type: Object ``` "state": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| state.display\_value | Display value of the state. Matches **state.value**.Data type: String |
| state.lable | Label of the state.Data type: String |
| state.name | Name of the state.Data type: String |
| state.type | Type of state. Value is always `string`.Data type: String |
| state.value | Value of the state.Possible values: - active - cancelled - draft - expired Data type: String |
| sys\_created\_by | Name of the user who created the sales agreement.Table: User \[user\] Data type: Object ``` "sys_created_by": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sys\_created\_by.display\_value | Display value of the user who created the sales agreement. Matches **sys\_created\_by.value**.Data type: String |
| sys\_created\_by.label | Label of the user who created the sales agreement.Data type: String |
| sys\_created\_by.name | Name of the user who created the sales agreement.Data type: String |
| sys\_created\_by.type | Type of the user who created the sales agreement. Value is always `string`.Data type: String |
| sys\_created\_by.value | Value of the user who created the sales agreement.Data type: String |
| sys\_created\_on | Details about the date and time that the sales agreement was created.Data type: Object ``` "sys_created_on": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sys\_created\_on.display\_value | Display value of the creation date and time. Matches **sys\_created\_on.value**.Data type: String |
| sys\_created\_on.label | Label of the creation date and time.Data type: String |
| sys\_created\_on.name | Name of the creation date and time.Data type: String |
| sys\_created\_on.type | Type of the creation date and time. Value is always `string`.Data type: String |
| sys\_created\_on.value | Value of the creation date and time.Data type: String |
| sys\_id | Sys\_id of the newly created sales agreement.Table: Sales Agreement \[sn\_sales\_agmt\_core\_sales\_agreement\] Data type: Object ``` "sys_id": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sys\_id.displayValue | Display value of the unique sys\_id value. Matches **sys\_id.value**.Data type: String |
| sys\_id.label | Automatically generated name or label of the sys\_id.Data type: String |
| sys\_id.type | Type of sys\_id given to the sales agreement. Value is always `GUID`.Data type: String |
| sys\_id.value | Sys\_id number assigned to the new sales agreement.Data type: String |
| sys\_updated\_by | Name of the user who last updated the sales agreement.Table: User \[user\] Data type: Object ``` "sys_updated_by": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sys\_updated\_by.display\_value | Display value of the user who updated the sales agreement. Matches **sys\_updated\_by.value**.Data type: String |
| sys\_updated\_by.label | Label of the user who updated the sales agreement.Data type: String |
| sys\_updated\_by.name | Name of the user who updated the sales agreement.Data type: String |
| sys\_updated\_by.type | Type of the user who updated the sales agreement. Value is always `string`.Data type: String |
| sys\_updated\_by.value | Value of the user who updated the sales agreement.Data type: String |
| sys\_updated\_on | Details about the date and time that the sales agreement was updated.Data type: Object ``` "sys_updated_on": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sys\_updated\_on.display\_value | Date and time value of the updated sales agreement. Matches **sys\_updated\_on.value**.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| sys\_updated\_on.label | Label of the updated sales agreement.Data type: String |
| sys\_updated\_on.name | Name of the updated sales agreement.Data type: String |
| sys\_updated\_on.type | Type of the updated sales agreement. Value is always `glide_date_time`.Data type: String |
| sys\_updated\_on.value | Date and time value of the updated sales agreement.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| Name | Description |
|---|---|
| api\_version | Optional. Version of the endpoint to access. For example, `v1` or `v2`. Only specify this value to use an endpoint version other than the latest. Data type: String |
| Name | Description |
|---|---|
| account | Required. Sys\_id of the account.Table: Account \[customer\_account\] Data type: String |
| billing\_location | Billing address of the new sales agreement.Table: Location \[location\] Data type: String Default: empty string |
| contact | Sys\_id the contact.Table: Contact \[customer\_contact\] Data type: String Default: null |
| currency | Country currency code to use in the new sales agreement. For example, `USD` or `EUR`.Table: Currency \[fx\_currency\] Data type: Number \(decimal\) Default: 0 |
| default\_price\_list | Required. Sys\_id of the price list.Table: Price List \[sn\_csm\_pricing\_price\_list\] Data type: String |
| ends | Required. End date of the sales agreement.Format: YYYY-MM-DD Data type: String |
| quote | Sys\_id of the quote.Table: Quote \[sn\_quote\_mgmt\_core\_quote\] Data type: String |
| sales\_agreement\_lines | List of sales agreement lines under the sales agreement.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Array of objects ``` "sales_agreement_lines": [ { "child_sales_agreement_lines": [Array], "end_date": "String", "price_list": "String", "product_model": "String", "product_offering": "String", "product_specification": "String", "quantity": Number, "quote_line": "String", "sales_agreement_line_adjustments": [Array], "sales_agreement_line_characteristics": [Array] "shipping_location": "String", "short_description": "String", "start_date": "String", "state": "String", "total_one_time_price": "String", "unit_net_price": "String" "unit_of_measurement": "String", } ] ``` |
| sales\_agreement\_lines.child\_sales\_agreement\_lines | List of child sales agreement lines to associate with the parent sales agreement. Follows the same object structure as the **sales\_agreement\_lines** object parameter.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Array of objects ``` "child_sales_agreement_lines": [ { "end_date": "String", "price_list": "String", "product_model": "String", "product_offering": "String", "product_specification": "String", "quantity": Number, "quote_line": "String", "sales_agreement_line_adjustments": [Array], "sales_agreement_line_characteristics": [Array], "shipping_location": "String", "short_description": "String", "start_date": "String", "state": "String", "total_one_time_price": "String", "total_recurring_price": "String", "unit_net_price": "String", "unit_of_measurement": "String" } ] ``` |
| sales\_agreement\_lines.child\_sales\_agreement\_lines.end\_date | Start date of the sales agreement line.Format: YYYY-MM-DD Data type: String |
| sales\_agreement\_lines.child\_sales\_agreement\_lines.price\_list | Sys\_id of the price list.Table: Price List \[sn\_csm\_pricing\_price\_list\] Data type: String Default: null |
| sales\_agreement\_lines.child\_sales\_agreement\_lines.product\_model | Sys\_id of the product model.Table: Product Model \[cmdb\_model\] Data type: String Default: null |
| sales\_agreement\_lines.child\_sales\_agreement\_lines.product\_offering | Sys\_id of the product offering.Table: Product Offering \[sn\_prd\_pm\_product\_offering\] Data type: String Default: null |
| sales\_agreement\_lines.child\_sales\_agreement\_lines.product\_specification | Sys\_id of the product specification.Table: Product Specification \[sn\_prd\_pm\_product\_specification\] Data type: String Default: null |
| sales\_agreement\_lines.child\_sales\_agreement\_lines.quantity | Number of products to add to the sales agreement line .Table: Product Model \[cmdb\_model\] Data type: Number \(decimal\) Default: 0 |
| sales\_agreement\_lines.child\_sales\_agreement\_lines.quote\_line | Sys\_id of the quote line item.Table: Quote Line \[sn\_quote\_mgmt\_core\_quote\_line\_item\] Data type: String Default: null |
| sales\_agreement\_lines.child\_sales\_agreement\_lines.sales\_agreement\_line\_adjustments | List of price adjustments under the child sales agreement line. Price adjustment data is inserted in the child sales agreement.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Array of objects ``` "sales_agreement_line_adjustments": [ { "adjustment_source": "String", "adjustment_type": "String", "adjustment_value": "String", "amount": "String", "applicable_to": "String", "quantity": Number, "short_description": "String", "total_amount": "String" } ] ``` |
| sales\_agreement\_lines.child\_sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_source | Source type of the adjustment.Accepted values: - manual - auto Data type: String Default: manual |
| sales\_agreement\_lines.child\_sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_type | Required. Sys\_id of the adjustment type.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: String |
| sales\_agreement\_lines.child\_sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_value | Required. Value of the price modification.Data type: Number Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Default: 0 |
| sales\_agreement\_lines.child\_sales\_agreement\_lines.sales\_agreement\_line\_adjustments.amount | Amount of the line adjustment.Data type: Number \(decimal\) Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Default: null |
| sales\_agreement\_lines.child\_sales\_agreement\_lines.sales\_agreement\_line\_adjustments.applicable\_to | Sys\_id of the line adjustment record that this adjustment is applicable to.Data type: String Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Default: null |
| sales\_agreement\_lines.child\_sales\_agreement\_lines.sales\_agreement\_line\_adjustments.quantity | Number of products to add to the child sales agreement line.Data type: Number Default: 0 |
| sales\_agreement\_lines.child\_sales\_agreement\_lines.sales\_agreement\_line\_adjustments.short\_description | Brief description of the sales agreement adjustment. Data type: String Default: Empty string |
| sales\_agreement\_lines.child\_sales\_agreement\_lines.sales\_agreement\_line\_adjustments.total\_amount | Total amount of the line adjustment. The sum of both the **sales\_agreement\_line\_adjustments.amount** and **sales\_agreement\_line\_adjustments.adjustment\_value** values.Data type: Number \(decimal\) Default: 0 |
| sales\_agreement\_lines.child\_sales\_agreement\_lines.sales\_agreement\_line\_characteristics | List of characteristic data to insert in the child sales agreement line.Table: Sales Agreement Line Characteristics \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_characteristic\] Data type: Array of objects ``` "sales_agreement_line_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "type": "String", "value": "String" } ] ``` |
| sales\_agreement\_lines.child\_sales\_agreement\_lines.sales\_agreement\_line\_characteristics .characteristic | Required. Sys\_id of a characteristic record. Table: Sales Agreement Line Characteristics \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_characteristic\] Data type: String |
| sales\_agreement\_lines.child\_sales\_agreement\_lines.sales\_agreement\_line\_characteristics .characteristic\_option | Sys\_id of the characteristic option. Table: Sales Agreement Line Characteristics \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_characteristic\] Data type: String |
| sales\_agreement\_lines.child\_sales\_agreement\_lines.sales\_agreement\_line\_characteristics .type | Type of the sales agreement characteristic.Accepted values: - coverage - coverage and usage Table: Sales Agreement Line Characteristics \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_characteristic\] Data type: String Default: coverage |
| sales\_agreement\_lines.child\_sales\_agreement\_lines.sales\_agreement\_line\_characteristics .value | Value of the characteristic.Default: null Data type: String Table: Sales Agreement Line Characteristics \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_characteristic\] |
| sales\_agreement\_lines.child\_sales\_agreement\_lines.shipping\_location | Reference to the shipping location of the child sales agreement line.Table: Location \[location\] Data type: String Default: |
| sales\_agreement\_lines.child\_sales\_agreement\_lines.short\_description | Brief details describing the child sales agreement line.Data type: String Default: Empty string |
| sales\_agreement\_lines.child\_sales\_agreement\_lines.start\_date | Required. Start date of the child sales agreement line.Format: YYYY-MM-DD Data type: String |
| sales\_agreement\_lines.child\_sales\_agreement\_lines.state | Required. Activity state in which to set the new sales agreement line. Accepted values: - pending\_activation: Sets the sales agreement line to a pending state. - suspended: Sets the sales agreement line to a suspended state. - active: Sets the sales agreement line to an active state. - expired: Sets the sales agreement in a expired state. - cancelled: Sets the sales agreement to a cancelled state. Data type: String Default: pending\_activation |
| sales\_agreement\_lines.child\_sales\_agreement\_lines.total\_one\_time\_price | Total one-time charges to be paid for the product or service.Data type: Number \(decimal\) Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Default: 0 |
| sales\_agreement\_lines.child\_sales\_agreement\_lines.total\_recurring\_price | Annual price for the product associated with the child line item.Data type: Number \(decimal\) Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Default: 0 |
| sales\_agreement\_lines.child\_sales\_agreement\_lines.unit\_net\_price | Price per each unit for the product associated with the sales agreement line.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: String Default value: 0 |
| sales\_agreement\_lines.end\_date | End date of the sales agreement line.Format: YYYY-MM-DD Data type: String |
| sales\_agreement\_lines.price\_list | Sys\_id of the price list associated with the sales agreement line.Table: Price List \[sn\_csm\_pricing\_price\_list\] Data type: String Default value: null |
| sales\_agreement\_lines.product\_model | Sys\_id of the product model associated with the sales agreement line.Table: Product Model \[cmdb\_model\] Data type: String Default value: null |
| sales\_agreement\_lines.product\_offering | Sys\_id of the product offering associated with the sales agreement line.Table: Product Offering \[sn\_prd\_pm\_product\_offering\] Data type: String Default value: null |
| sales\_agreement\_lines.product\_specification | Sys\_id of the product specification associated with the sales agreement line.Table: Product Specification \[sn\_prd\_pm\_product\_specification\] Data type: String Default value: null |
| sales\_agreement\_lines.quantity | Number of products to add to the sales agreement line.Data type: Number \(decimal\) Default: 0 |
| sales\_agreement\_lines.quote\_line | Sys\_id of the quote line item associated with the sales agreement line.Data type: String Table: Quote Line \[sn\_quote\_mgmt\_core\_quote\_line\_item\] Default value: null |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments | List of price adjustments to insert under the sales agreement line. Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Array of objects ``` "sales_agreement_line_adjustments": [ { "adjustment_source": "String", "adjustment_type": "String", "adjustment_value": "String", "amount": "String", "applicable_to": "String", "quantity": Number, "short_description": "String", "total_amount": "String" } ] ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_source | Source type of the adjustment.Accepted values: - manual - auto Data type: String Default: manual |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_type | Required. Sys\_id of the adjustment type.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: String Default: null |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_value | Required. Value of the price adjustment.Data type: Number \(decimal\) |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.amount | Price amount of the line adjustment.Data type: Number \(decimal\) Default: 0 |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.applicable\_to | Quantity type that the sales adjustment is applicable to.Valid values: - LUMPSUM\_QTY: lipsum quantity - UNIT\_QTY: unit quantity Data type: String Default: null |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.quantity | Number of products to add to the sales agreement line adjustment.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Number \(decimal\) Default: 0 |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.short\_description | Brief description of the sales agreement adjustment. Data type: String Default: Empty string |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.total\_amount | Total amount of the line adjustment. The sum of both the **sales\_agreement\_line\_adjustments.amount** and **sales\_agreement\_line\_adjustments.adjustment\_value** values.Data type: String Default: manual |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics | List of characteristics under the sales agreement line. The data in this parameter will be inserted in Sales Agreement Characteristics record. Table: Sales Agreement Line Characteristics \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_characteristic\] Data type: Array of objects ``` "sales_agreement_line_characteristics": [ { "characteristic": "String", "characteristic_option": "String", "type": "String", "value": "String" } ] ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics .characteristic | Required. Sys\_id of the sales agreement line characteristic. Table: Sales Agreement Line Characteristics \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_characteristic\] Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics .characteristic\_option | The characteristic option associated with the sales agreement line. Table: Product Characteristic Option \[sn\_prd\_pm\_characteristic\_option\] Data type: String Default: null |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics .type | Type of the sales agreement characteristic.Accepted values: - coverage - coverage and usage Table: Sales Agreement Line Characteristics \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_characteristic\] Data type: String Default: coverage |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics .value | Value of the characteristic.Table: Sales Agreement Line Characteristics \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_characteristic\] Data type: String Default: null |
| sales\_agreement\_lines.shipping\_location | Reference to the shipping location of the sales agreement line.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: String Default: null |
| sales\_agreement\_lines.short\_description | Brief details describing the sales agreement line.Data type: String Default: Empty string |
| sales\_agreement\_lines.start\_date | Start date of the sales agreement line.Format: YYYY-MM-DD Data type: String |
| sales\_agreement\_lines.state | Required. Activity state in which to set the new sales agreement line. Accepted values: - pending\_activation: Sets the sales agreement line to a pending state. - suspended: Sets the sales agreement line to a suspended state. - active: Sets the sales agreement line to an active state. - expired: Sets the sales agreement in a expired state. - cancelled: Sets the sales agreement to a cancelled state. Data type: String Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Default: pending\_activation |
| sales\_agreement\_lines.total\_one\_time\_price | Total one-time price to be paid for the product or service associated with the sales agreement line.Data type: Number \(decimal\) Default: 0 |
| sales\_agreement\_lines.unit\_net\_price | The price for each unit within the sales agreement line.Data type: Number \(decimal\) Default value: 0 |
| sales\_agreement\_lines.unit\_of\_measurement | The unit of measurement. For example, `bundle` or `each`.Table: Unit of measures \[sn\_prd\_pm\_uom\_list\] Data type: String Default value: null |
| shipping\_location | Shipping location of the sales agreement.Table: Location \[location\] Data type: String Default: null |
| short\_description | Brief details describing the sales agreement.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: String Default: Empty string |
| starts | Required. Start date of the sales agreement.Format: YYYY-MM-DD Data type: String |
| state | Activity state in which to set the new sales agreement. Accepted values: - draft: Sets the sales agreement in a draft state. - active: Sets the sales agreement to an active state. - expired: Sets the sales agreement in a expired state. - cancelled: Sets the sales agreement to a cancelled state. Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: String Default: draft |
| Name | Description |
|---|---|
| result | Results of the sales agreement with all its associated information.Data type: Object ``` "result": { "account": {Object}, "billing_location": {Object}, "consumer": {Object}, "contact": {Object}, "currency": {Object}, "default_price_list": {Object}, "ends": {Object}, "number": {Object}, "quote": {Object}, "sales_agreement_lines": [Array] "shipping_location": {Object}, "short_description": {Object}, "starts": {Object}, "state": {Object}, "sys_id": {Object}, "sys_created_by": {Object}, "sys_created_on": {Object}, "sys_updated_by": {Object}, "sys_updated_on": {Object} } ``` |
| account | Account information associated with the sales agreement.Table: Account \[customer\_account\] Data type: Object ``` "account": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| account.display\_value | Display value of the account. Matches **account.value**.Data type: String |
| account.label | Label of the account.Data type: String |
| account.name | Name of the account.Data type: String |
| account.type | Type of account. Value is always `reference`.Data type: String |
| account.value | Sys\_id of the account.Table: Account \[customer\_account\] Data type: String |
| billing\_location | Billing address of the sales agreement.Updated table: Location \[cmn\_location\] Data type: Object ``` "billing_location": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| billing\_location.display\_value | Display value of the billing location. Matches **billing\_location.value**.Data type: String |
| billing\_location.label | Label of the billing location.Data type: String |
| billing\_location.name | Name of the billing location.Data type: String |
| billing\_location.type | Type of billing location. Value is always `reference`.Data type: String |
| billing\_location.value | Value of the billing location.Data type: String |
| consumer | Consumer details of the sales agreement.Table: Consumer \[csm\_consumer\] Data type: Object ``` "consumer": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| consumer.display\_value | Display value of the consumer. Matches **consumer.value**.Data type: String |
| consumer.label | Label of the consumer.Data type: String |
| consumer.name | Name of the consumer.Data type: String |
| consumer.type | Type of consumer. Value is always `reference`.Data type: String |
| consumer.value | Value of the consumer.Data type: String |
| contact | Contact information associated with the sales agreement.Table: Contact \[customer\_contact\] Data type: Object ``` "contact": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| contact.display\_value | Display value of the contact. Matches **contact.value**.Data type: String |
| contact.label | Label of the contact.Data type: String |
| contact.name | Name of the contact. Data type: String |
| contact.type | Type of contact. Value is always `reference`.Data type: String |
| contact.value | Value of the contact.Data type: String |
| currency | Currency code associated with the sales agreement.Table: Currency \[fx\_currency\] Data type: Object ``` "currency": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| currency.display\_value | Display value of the currency. Matches **currency.value**. For example, `USD`.Data type: String |
| currency.label | Label of the currency.Data type: String |
| currency.name | Name of the currency.Data type: String |
| currency.type | Type of currency. Value is always `reference`.Data type: String |
| currency.value | Country currency code of the currency. For example, `USD`.Data type: String |
| default\_price\_list | Details about the default price list of the sales agreement.Table: Price List \[sn\_csm\_pricing\_price\_list\] Data type: Object ``` "default_price_list": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| default\_price\_list.display\_value | Display value of the default price list.Data type: String |
| default\_price\_list.label | Label of the default price list.Data type: String |
| default\_price\_list.name | Name of the default price list.Data type: String |
| default\_price\_list.type | Type of default price list. Value is always `reference`.Data type: String |
| default\_price\_list.value | Sys\_id of the default price list.Data type: String |
| ends | End date of the sales agreement.Data type: Object ``` "ends": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| ends.display\_value | Display value of the end date. Matches **end.value**.Data type: String |
| ends.label | Label of the end date.Data type: String |
| ends.label | Name of the end date.Data type: String |
| ends.type | Type of end date. Value is always `glide_date`.Data type: String |
| ends.value | Value of the end date.Format: YYYY-MM-DD Data type: String |
| number | Automatically generated sales agreement number or the number posted .Table: Sales Agreement \[sn\_sales\_agmt\_core\_sales\_agreement\] Data type: Object ``` "number": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| number.display\_value | Display value of the sales agreement number. Matches **number.value**.Data type: String |
| number.label | Label of the sales agreement number.Data type: String |
| number.name | Name of the sales agreement number.Data type: String |
| number.type | Type of sales agreement number. Value is always `String`.Data type: String |
| number.value | Value of the sales agreement number. For example, `SA0010106`.Data type: String |
| quote | Information about the sales agreement quote.Table: Quote \[sn\_quote\_mgmt\_core\_quote\] Data type: Object ``` "quote": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| quote.display\_value | Display value of the quote.Data type: String |
| quote.label | Label of the quote.Data type: String |
| quote.name | Name of the quote.Data type: String |
| quote.type | Type of quote. Value is always `reference`.Data type: String |
| quote.value | Sys\_id of the quote.Data type: String |
| sales\_agreement\_lines | List of sales agreement lines under the sales agreement. Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Array of objects ``` sales_agreement_lines": [ { "child_sales_agreement_lines": [Array] "end_date": {Object}, "number": {Object}, "parent_line": {Object}, "price_list": {Object}, "product_model": {Object}, "product_offering": {Object}, "product_specification": {Object}, "quantity": {Object}, "quote_line": {Object}, "sales_agreement": {Object}, "sales_agreement_line_characteristics": [Array], "sales_agreement_line_adjustments": [Array], "shipping_location": {Object}, "short_description": {Object}, "start_date": {Object}, "state": {Object}, "sys_id": {Object}, "sys_created_by": {Object}, "sys_created_on": {Object}, "sys_updated_by": {Object}, "sys_updated_on": {Object}, "top_sales_agreement_line": {Object}, "total_one_time_price": {Object}, "total_recurring_price": {Object}, "unit_net_price": {Object}, "unit_of_measure": {Object}, } ] ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments | List of sales agreement line adjustments.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Array of objects ``` "sales_agreement_line_adjustments": [ { "adjustment_source": {Object}, "adjustment_type": {Object}, "adjustment_value": {Object}, "amount": {Object}, "applicable_to": {Object}, "number": {Object}, "quantity": {Object}, "sales_agreement": {Object}, "sales_agreement_line": {Object}, "short_description": {Object}, "sys_id": {Object}, "sys_created_by": {Object}, "sys_updated_by": {Object}, "sys_created_on": {Object}, "sys_updated_on": {Object}, "total_amount": {Object} } ] ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_source | Source information of the sales agreement line adjustment.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Object ``` "adjustment_source": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_source.display\_value | Source display value of the sales agreement line adjustment. Matches **sales agreement line adjustment.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_source.label | Source label of the sales agreement line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_source.name | Source name of the sales agreement line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_source.type | Source type of sales agreement line adjustment. Value is always `string`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_source.value | Source value of the sales agreement line adjustment.Possible values: - auto - manual Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_type | Information about the sales agreement line adjustment type.Data type: Object ``` "adjustment_type": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_type.display\_value | Display value of the adjustment type.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_type.label | Label of the adjustment type.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_type.name | Name of the adjustment type.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_type.type | Type of adjustment type. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_type.value | Sys\_id of the adjustment type.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.adjustment\_value | Information about the adjustment value.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Object ``` "adjustment_type": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.agreement\_line\_adjustments.adjustment\_value.display\_value | Display value of the adjustment value. Matches **adjustment\_value.value**.Data type: Number \(decimal\) |
| sales\_agreement\_lines.agreement\_line\_adjustments.adjustment\_value.label | Label of the adjustment value.Data type: String |
| sales\_agreement\_lines.agreement\_line\_adjustments.adjustment\_value.name | Name of the adjustment value.Data type: String |
| sales\_agreement\_lines.agreement\_line\_adjustments.adjustment\_value.type | Type of adjustment. Value is always `decimal`.Data type: String |
| sales\_agreement\_lines.agreement\_line\_adjustments.adjustment\_value.value | Number value of the adjustment.Data type: Number \(decimal\) |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.amount | Information about the amount of the sales agreement line adjustment.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Object ``` "amount": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.amount.display\_value | Display value of the adjustment amount. Matches **amount.value**. Automatically includes the dollar sign of the associated currency \(for example, `$0.00` when **currency** is set to `USD`\).Data type: Number \(decimal\) |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.amount.label | Label of the adjustment amount.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.amount.name | Name of the adjustment amount.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.amount.type | Type of the adjustment amount. Value is always `currency`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.amount.value | Dollar value of the adjustment amount.Data type: Number |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.applicable\_to | Reference of the entity that the adjustment is applicable to.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Object ``` "applicable_to": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.applicable\_to.display\_value | Display value of the entity that the adjustment is applicable to. Matches **applicable\_to.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.applicable\_to.label | Label of the entity that the adjustment is applicable to.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.applicable\_to.name | Name of the entity that the adjustment is applicable to.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.applicable\_to.type | Type of the entity that the adjustment is applicable to. Value is always `String`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.applicable\_to.value | Quantity type that the line adjustment is applicable to.Possible values: - LUMPSUM\_QTY: lipsum quantity - UNIT\_QTY: unit quantity Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.number | Automatically generated sales agreement line adjustments number or the number posted.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Object ``` "number": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.number.display\_value | Display value of the adjustments number. Matches **number.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.number.label | Label of the adjustment number.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.number.name | Name of the adjustment number.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.number.type | Type of the adjustment number. Value is always `string`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.number.value | Value of the adjustment number. For example, `SALA0010004`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.quantity | Quantity of product adjusted on the sales agreement line.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Object ``` "quantity": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.quantity.display\_value | Display value of the adjustment quantity. Matches **quantity.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.quantity.label | Label of the adjustment quantity.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.quantity.name | Name of the adjustment quantity.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.quantity.type | Type of the adjustment quantity. Value is always `decimal`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.quantity.value | Value of the adjustment quantity.Data type: Number |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sales\_agreement | Reference to the sales agreement associated with the sales agreement line adjustment.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Object ``` "quantity": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sales\_agreement.display\_value | Display value of the sales agreement associated with the sales agreement line adjustment. For example, `SA0010106`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sales\_agreement.label | Label of the sales agreement associated with the sales agreement line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sales\_agreement.name | Name of the sales agreement associated with the sales agreement line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sales\_agreement.type | Type of the sales agreement associated with the sales agreement line adjustment. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sales\_agreement.value | Sys\_id of the sales agreement associated with the sales agreement line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sales\_agreement\_line | Reference to sales agreement line associated with the sales agreement line adjustment.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Object ``` "sales_agreement_line": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sales\_agreement\_line.display\_value | Number of the sales agreement associated with the sales agreement line adjustment. For example, `SAL0010126`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sales\_agreement\_line.label | Label of the sales agreement associated with the sales agreement line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sales\_agreement\_line.name | Name of the sales agreement associated with the sales agreement line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sales\_agreement\_line.type | Type of the sales agreement associated with the sales agreement line adjustment. Value is always `String`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sales\_agreement\_line.value | Sys\_id of the sales agreement associated with the sales agreement line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.short\_description | Brief description detailing the sales agreement line adjustment.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Object ``` "short_description": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.short\_description.display\_value | Display value of the short description detailing the particular line adjustment. Matches **short\_description.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.short\_description.label | Label of the short description detailing the particular line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.short\_description.name | Name of the short description detailing the particular line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.short\_description.type | Type of the short description detailing the particular line adjustment. Value is always `string`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.short\_description.value | Value of the short description detailing the particular line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_created\_by | Name of the user who created the sales agreement line adjustment.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Object ``` "created_by": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_created\_by.display\_value | Display value of the user who created the sales agreement line adjustment. Matches **created\_by.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_created\_by.label | Label of the user who created the sales agreement line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_created\_by.name | Name of the user who created the sales agreement line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_created\_by.type | Type of the user who created the sales agreement line adjustment. Value is always `string`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_created\_by.value | Value of the user who created the sales agreement line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_created\_on | Date and time of when the sales agreement line adjustment was created.Data type: Object ``` "created_on": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_created\_on.display\_value | Display value of the date and time that the line adjustment was created. Matches **created\_on.value**.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_created\_on.label | Label of the date and time that the line adjustment was created.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_created\_on.name | Name of the date and time that the line adjustment was created.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_created\_on.type | Type of the date and time that the line adjustment was created. Value is always `glide_date_time`.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_created\_on.value | Value of the date and time that the line adjustment was created.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_id | Sys\_id of the sales agreement line adjustment.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Object ``` "sys_id": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_id.display\_value | Display value of the line adjustment sys\_id. Matches **sys\_id.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_id.label | Label of the line adjustment sys\_id.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_id.name | Name of the line adjustment sys\_id.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_id.type | Type of the line adjustment sys\_id. Value is always `string`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_id.value | Value of the line adjustment sys\_id.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_updated\_by | Name of the user who last updated the sales agreement line adjustment.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Object ``` "updated_by": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_updated\_by.display\_value | Display value of the user who last updated the sales agreement line adjustment. Matches **updated\_by.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_updated\_by.label | Label of the user who last updated the sales agreement line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_updated\_by.name | Name of the user who last updated the sales agreement line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_updated\_by.type | Type of user who last updated the sales agreement line adjustment. Value is always `String`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_updated\_by.value | Value of the user who last updated the sales agreement line adjustment.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_updated\_on | Date and time when the sales agreement line adjustment was updated.Data type: Object ``` "updated_on": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_updated\_on.display\_value | Display value of the date and time that the line adjustment was last updated. Matches **updated\_on.value**.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_updated\_on.label | Label of the date and time that the line adjustment was last updated.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_updated\_on.name | Name of the date and time that the line adjustment was last updated.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_updated\_on.type | Type of date and time that the line adjustment was last updated. Value is always `glide_date_time`.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.sys\_updated\_on.value | Value of the date and time that the line adjustment was last updated.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.total\_amount | Total amount of the sales agreement line adjustment.Table: Sales Agreement Line Adjustments \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_adjustment\] Data type: Object ``` "total_amount": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.total\_amount.display\_value | Display value of the total adjustment amount. Matches **total\_amount.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.total\_amount.label | Label of the total adjustment amount.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.total\_amount.name | Name of the total adjustment amount.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.total\_amount.type | Type of the total adjustment amount. Value is always `currency`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_adjustments.total\_amount.value | Value of the total adjustment amount.Data type: String represented by a number \(float\) |
| sales\_agreement\_lines.child\_sales\_agreement\_lines | List of sales agreement lines. Follows the same object structure as the **sales\_agreement\_lines** object parameter.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Array of objects ``` "child_sales_agreement_lines": [ { "end_date": {Object}, "number": {Object}, "parent_line": {Object}, "price_list": {Object}, "product_model": {Object}, "product_offering": {Object}, "product_specification": {Object}, "quantity": {Object}, "quote_line": {Object}, "sales_agreement": {Object}, "sales_agreement_line_adjustments": [Array], "sales_agreement_line_characteristics": [Array], "shipping_location": {Object}, "short_description": {Object}, "start_date": {Object}, "state": {Object}, "sys_id": {Object}, "sys_created_by": {Object}, "sys_created_on": {Object}, "sys_updated_by": {Object}, "sys_updated_on": {Object}, "top_sales_agreement_line": {Object}, "total_one_time_price": {Object}, "total_recurring_price": {Object}, "unit_net_price": {Object}, "unit_of_measure": {Object} } ] ``` |
| sales\_agreement\_lines.end\_date | End date of the sales agreement line.Data type: Object ``` "end_date": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.end\_date.display\_value | Display value of the end date for the sales agreement line. Matches **end.value**.Data type: String |
| sales\_agreement\_lines.end\_date.label | Label of the end date for the sales agreement line.Data type: String |
| sales\_agreement\_lines.end\_date.name | Name of the end date for the sales agreement line.Data type: String |
| sales\_agreement\_lines.end\_date.type | Type of end date for the sales agreement line. Value is always `glide_date_time`.Data type: String |
| sales\_agreement\_lines.end\_date.value | End date and time value of the sales agreement line.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| sales\_agreement\_lines.number | Automatically generated sales agreement line number or the number posted .Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Object ``` "number": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.number.display\_value | Display value of the sales agreement line number. For example, `SAL0010128`. Matches **number.value**.Data type: String |
| sales\_agreement\_lines.number.label | Label of the number.Data type: String |
| sales\_agreement\_lines.number.name | Name of the number.Data type: String |
| sales\_agreement\_lines.number.type | Type of number. Value is always `string`.Data type: String |
| sales\_agreement\_lines.number.value | Value of the sales agreement line number. For example, `SAL0010128`.Data type: String |
| sales\_agreement\_lines.parent\_line | Information about the parent sales agreement line.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Object ``` "parent_line": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.parent\_line.display\_value | Display number of the parent sales agreement line. For example, `SAL0010126`.Data type: String |
| sales\_agreement\_lines.parent\_line.label | Label of the parent sales agreement line.Data type: String |
| sales\_agreement\_lines.parent\_line.name | Name of the parent sales agreement line.Data type: String |
| sales\_agreement\_lines.parent\_line.type | Type of parent sales agreement line. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.parent\_line.value | Sys\_id of the parent sales agreement line.Data type: String |
| sales\_agreement\_lines.price\_list | Price list details of the sales agreement line.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Object ``` "price_list": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.price\_list.display\_value | Display value of the sales agreement line's price list.Data type: String |
| sales\_agreement\_lines.price\_list.label | Label of the sales agreement line's price list.Data type: String |
| sales\_agreement\_lines.price\_list.name | Name of the sales agreement line's price list.Data type: String |
| sales\_agreement\_lines.price\_list.type | Type of sales agreement line's price list. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.price\_list.value | Sys\_id of the price list associated with the sales agreement line.Data type: String |
| sales\_agreement\_lines.product\_model | Details about the product model on the sales agreement line.Table: Product Model \[cmdb\_model\] Data type: Object ``` "product_model": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.product\_model.display\_value | Display value of the product model on the sales agreement line. Matches **product\_model.value**.Data type: String |
| sales\_agreement\_lines.product\_model.label | Label of the product model on the sales agreement line.Data type: String |
| sales\_agreement\_lines.product\_model.name | Name of the product model on the sales agreement line.Data type: String |
| sales\_agreement\_lines.product\_model.type | Type of product model on the sales agreement line. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.product\_model.value | Value of the product model on the sales agreement line.Data type: String |
| sales\_agreement\_lines.product\_offering | Details about the product offering on the sales agreement line.Table: Product Offering \[sn\_prd\_pm\_product\_offering\] Data type: Object ``` "product_offering": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.product\_offering.display\_value | Display value of the product offering on the sales agreement line.Data type: String |
| sales\_agreement\_lines.product\_offering.label | Label of the product offering on the sales agreement line.Data type: String |
| sales\_agreement\_lines.product\_offering.name | Name of the product offering on the sales agreement line.Data type: String |
| sales\_agreement\_lines.product\_offering.type | Type of product offering on the sales agreement line. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.product\_offering.value | Value of the product offering on the sales agreement line.Data type: String |
| sales\_agreement\_lines.product\_specification | Reference to product specification of the sales agreement line.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Object ``` "product_offering": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.product\_specification.display\_value | Display value of the product offering on the sales agreement line. Matches **product\_specification.value**.Data type: String |
| sales\_agreement\_lines.product\_specification.label | Label of the product specification on the sales agreement line.Data type: String |
| sales\_agreement\_lines.product\_specification.name | Name of the product specification on the sales agreement line.Data type: String |
| sales\_agreement\_lines.product\_specification.type | Type of product specification on the sales agreement line. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.product\_specification.value | Value of the product specification on the sales agreement line.Data type: String |
| sales\_agreement\_lines.quantity | Number of products to add to the sales agreement line.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Object ``` "quantity": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.quantity.display\_value | Display value of the product quantity on the sales agreement line. Matches **quantity.value**.Data type: String |
| sales\_agreement\_lines.quantity.label | Label of the product quantity on the sales agreement line.Data type: String |
| sales\_agreement\_lines.quantity.name | Name of the product quantity on the sales agreement line.Data type: String |
| sales\_agreement\_lines.quantity.type | Type of product quantity on the sales agreement line. Value is always `decimal`.Data type: String |
| sales\_agreement\_lines.quantity.value | Number of products on the sales agreement line. Data type: Number |
| sales\_agreement\_lines.quote\_line | Reference of the quote line item on the sales agreement line.Table: Quote Line \[sn\_quote\_mgmt\_core\_quote\_line\_item\] Data type: Object ``` "quote_line": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.quote\_line.display\_value | Display value of the quote line item on the sales agreement line.Data type: String |
| sales\_agreement\_lines.quote\_line.label | Label of the quote line item on the sales agreement line.Data type: String |
| sales\_agreement\_lines.quote\_line.name | Name of the quote line item on the sales agreement line.Data type: String |
| sales\_agreement\_lines.quote\_line.type | Type of quote line item on the sales agreement line. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.quote\_line.value | Value of the quote line item on the sales agreement line.Data type: String |
| sales\_agreement\_lines.sales\_agreement | Reference to the sales agreement of the sales agreement line.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Object ``` "sales_agreement": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement.display\_value | Display value of the sales agreement of the sales agreement line. For example, `SA0010106`.Data type: String |
| sales\_agreement\_lines.sales\_agreement.label | Label of the sales agreement of the sales agreement line.Data type: String |
| sales\_agreement\_lines.sales\_agreement.name | Name of the sales agreement of the sales agreement line.Data type: String |
| sales\_agreement\_lines.sales\_agreement.type | Type of sales agreement of the sales agreement line. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.sales\_agreement.value | Sys\_id of the sales agreement of the sales agreement line.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics | List of sales agreement line characteristics.Table: Sales Agreement Line Characteristics \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_characteristic\] Data type: Array of objects ``` "sales_agreement_line_characteristics": [ { "characteristic": {Object}, "characteristic_option": {Object}, "sales_agreement": {Object}, "sales_agreement_line": {Object}, "sys_id": {Object}, "sys_created_by": {Object}, "sys_updated_by": {Object}, "sys_created_on": {Object}, "sys_updated_on": {Object}, "type": {Object}, "value": {Object} } ] ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.characteristic | Characteristic associated with the sales agreement line.Table: sn\_prd\_pm\_characteristic Data type: Object ``` "characteristic": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.characteristic.display\_value | Display value of the characteristic on the sales agreement line.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.characteristic.label | Label of the characteristic on the sales agreement line.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.characteristic.name | Name of the characteristic on the sales agreement line.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.characteristic.type | Type of characteristic on the sales agreement line. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.characteristic.value | Value of the characteristic on the sales agreement line.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.characteristic\_option | Information about the characteristic option on the sales agreement line.Table: Sales Agreement Line Characteristics \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_characteristic\] Data type: Object ``` "characteristic_option": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.characteristic\_option.display\_value | Display value of the characteristic on the sales agreement line. Matches **characteristic\_option.value**. Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.characteristic\_option.label | Label of the characteristic option on the sales agreement line.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.characteristic\_option.name | Name of the characteristic option on the sales agreement line.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.characteristic\_option.type | Type of characteristic option on the sales agreement line. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.characteristic\_option.value | Value of the characteristic option on the sales agreement line.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sales\_agreement | Details of the sales agreement characteristic on the sales agreement line.Table: Sales Agreement Line Characteristics \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_characteristic\] Data type: Object ``` "sales_agreement": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sales\_agreement.display\_value | Display value of the sales agreement characteristic. Matches **sales\_agreement.value**. Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sales\_agreement.label | Label of the sales agreement characteristic.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sales\_agreement.name | Name of the sales agreement characteristic.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sales\_agreement.type | Type of sales agreement characteristic. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sales\_agreement.value | Value of the sales agreement characteristic.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sales\_agreement\_line | Details about the characteristic of the sales agreement line.Table: Sales Agreement Line Characteristics \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_characteristic\] Data type: Object ``` "sales_agreement_line": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sales\_agreement\_line.display\_value | Display value of the characteristic of the sales agreement line. Matches **sales\_agreement\_line.value**. Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sales\_agreement\_line.label | Characteristic label of the sales agreement line.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sales\_agreement\_line.name | Characteristic name of the sales agreement line.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sales\_agreement\_line.type | Characteristic type of the sales agreement line. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sales\_agreement\_line.value | Characteristic value of the sales agreement line.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_created\_by | Name of the user who created the sales agreement line characteristic.Table: User \[user\] Data type: Object ``` "sys_created_by": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_created\_by.display\_value | Display value of the Created by field. Matches **sys\_created\_by.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_created\_by.label | Label of the Created by field.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_created\_by.name | Name of the Created by field.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_created\_by.type | Type of the Created by field. Value is always `string`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_created\_by.value | Value of the Created by field.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_created\_on | Date and time the sales agreement line characteristic was created.Data type: Object ``` "sys_created_on": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_created\_on.display\_value | Display value of the Created on field. Matches **sys\_created\_on.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_created\_on.label | Label of the Created on field.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_created\_on.name | Name of the Created on field.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_created\_on.type | Type of the Created on field. Value is always `glide_date_time`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_created\_on.value | Value of the Created on field.Format: YYYY-DD-MM HH:mm:ss Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_id | Sys\_id of the sales agreement line characteristic.Table: Sales Agreement Line Characteristics \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_characteristic\] Data type: Object ``` "sys_id": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_id.display\_value | Display value of the characteristic sys\_id. Matches **sys\_id.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_id.label | Label of the characteristic sys\_id.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_id.name | Name of the characteristic sys\_id.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_id.type | Type of the characteristic sys\_id. Value is always `string`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_id.id | Value of the characteristic sys\_id.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_updated\_by | Name of the user who last updated the sales agreement line characteristic.Table: User \[user\] Data type: Object ``` "sys_updated_by": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_updated\_by.display\_value | Display value of the user who updated the characteristic of the sales agreement line item. Matches **sys\_created\_by.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_updated\_by.label | Label of the user who updated the characteristic.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_updated\_by.name | Name of the user who updated the characteristic.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_updated\_by.type | Type of the user who updated the characteristic. Value is always `string`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_updated\_by.value | Value of user who updated the characteristic.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_updated\_on | Date and time the sales agreement line characteristic was last updated.Data type: Object ``` "sys_updated_on": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_updated\_on.display\_value | Display value of the updated date. Matches **updated\_on.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_updated\_on.label | Label of the updated date.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_updated\_on.name | Name of the updated date.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_updated\_on.type | Type of the updated date. Value is always `glide_date_time`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.sys\_updated\_on.value | Value of the updated date.Format: YYYY-DD-MM HH:mm:ss Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.type | Type of characteristic in the sales agreement line characteristic.Table: Sales Agreement Line Characteristics \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_characteristic\] Data type: Object ``` "type": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.type.display\_value | Display value of the characteristic type. Matches **type.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.type.label | Label of the characteristic type.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.type.name | Name of the characteristic type.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.type.type | Type of the characteristic type. Value is always `string`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.type.value | Value of the characteristic type.Possible values: - coverage - coverage and usage Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.value | Value of the characteristic on the sales agreement line.Table: Sales Agreement Line Characteristics \[sn\_sales\_agmt\_core\_sales\_agreement\_line\_characteristic\] Data type: Object ``` "type": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.value.display\_value | Display value of the characteristic. Matches **type.value**.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.value.label | Label of the characteristic value.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.value.name | Name of the characteristic value.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.value.type | Type of the characteristic value. Value is always `string`.Data type: String |
| sales\_agreement\_lines.sales\_agreement\_line\_characteristics.value.value | Value of the characteristic.Data type: String |
| sales\_agreement\_lines.short\_description | Brief details describing the sales agreement line.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Object ``` "short_description": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.short\_description.display\_value | Display value of the short description. Matches **short\_description.value**.Data type: String |
| sales\_agreement\_lines.short\_description.label | Label of the short description.Data type: String |
| sales\_agreement\_lines.short\_description.name | Name of the short description.Data type: String |
| sales\_agreement\_lines.short\_description.type | Type of short description. Always of type `string`.Data type: String |
| sales\_agreement\_lines.short\_description.value | Value of the short description.Data type: String |
| sales\_agreement\_lines.start\_date | Start date of the sales agreement line.Data type: Object ``` "start_date": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.start\_date.display\_value | Display value of the sales agreement line's start date. Matches **start\_date.value**.Data type: String |
| sales\_agreement\_lines.start\_date.label | Label of the sales agreement line's start date.Data type: String |
| sales\_agreement\_lines.start\_date.name | Name of the sales agreement line's start date.Data type: String |
| sales\_agreement\_lines.start\_date.type | Type of sales agreement line's start date. Value is always `glide_date_time`.Data type: String |
| sales\_agreement\_lines.start\_date.value | Value of the sales agreement line's start date.Format: YYYY-MM-DD Data type: String |
| sales\_agreement\_lines.state | Valid state of the sales agreement line.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Object ``` "state": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.state.display\_value | Display value of the state. Matches **state.value**.Data type: String |
| sales\_agreement\_lines.state.label | Label of the state.Data type: String |
| sales\_agreement\_lines.state.name | Name of the state.Data type: String |
| sales\_agreement\_lines.state.type | Type of state. Value is always `string`.Data type: String |
| sales\_agreement\_lines.state.value | Value of the state.Possible values: - pending\_activation - suspended - active - expired - cancelled Data type: String |
| sales\_agreement\_lines.sys\_created\_by | Name of the user who created the sales agreement line.Table: User \[user\] Data type: Object ``` "sys_created_by": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sys\_created\_by.display\_value | Display value of the user who created the sales agreement line. Matches **sys\_created\_by.value**.Data type: String |
| sales\_agreement\_lines.sys\_created\_by.label | Label of the user who created the sales agreement line.Data type: String |
| sales\_agreement\_lines.sys\_created\_by.name | Name of the user who created the sales agreement line.Data type: String |
| sales\_agreement\_lines.sys\_created\_by.type | Type of the Created by field. Value is always `string`.Data type: String |
| sales\_agreement\_lines.sys\_created\_by.value | Value of the user who created the sales agreement line.Data type: String |
| sales\_agreement\_lines.sys\_created\_on | Date and time the sales agreement line record was created.Data type: Object ``` "sys_created_on": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sys\_created\_on.display\_value | Display value of the creation date of the sales agreement line record. Matches **sys\_created\_on.value**.Data type: String |
| sales\_agreement\_lines.sys\_created\_on.label | Label of the creation date of the sales agreement line record.Data type: String |
| sales\_agreement\_lines.sys\_created\_on.name | Name of the creation date of the sales agreement line record.Data type: String |
| sales\_agreement\_lines.sys\_created\_on.type | Type of the creation date of the sales agreement line record. Value is always `glide_date_time`.Data type: String |
| sales\_agreement\_lines.sys\_created\_on.value | Value of the creation date of the sales agreement line record.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| sales\_agreement\_lines.sys\_id | Sys\_id of the sales agreement line record .Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Object ``` "sys_id": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sys\_id.displayValue | Display value of the sys\_id of the sales agreement line record . Matches **sys\_id.value**.Data type: String |
| sales\_agreement\_lines.sys\_id.label | Automatically-generated name or label of the sales agreement line record sys\_id.Data type: String |
| sales\_agreement\_lines.sys\_id.type | Type of sys\_id of the sales agreement line record . Value is always `string`.Data type: String |
| sales\_agreement\_lines.sys\_id.value | Sys\_id number assigned to the sales agreement line record .Data type: String |
| sales\_agreement\_lines.sys\_updated\_by | Name of the user who last updated the sales agreement line.Table: User \[user\] Data type: Object ``` "sys_updated_by": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sys\_updated\_by.display\_value | Display value of the user who updated the sales agreement line. Matches **sys\_updated\_by.value**.Data type: String |
| sales\_agreement\_lines.sys\_updated\_by.label | Label of the user who updated the sales agreement line.Data type: String |
| sales\_agreement\_lines.sys\_updated\_by.name | Name of the user who updated the sales agreement line.Data type: String |
| sales\_agreement\_lines.sys\_updated\_by.type | Type of the user who updated the sales agreement line. Value is always `string`.Data type: String |
| sales\_agreement\_lines.sys\_updated\_by.value | Value of the user who updated the sales agreement line.Data type: String |
| sales\_agreement\_lines.sys\_updated\_on | Date and time the sales agreement line record was last updated.Data type: Object ``` "sys_updated_on": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.sys\_updated\_on.display\_value | The display value of the updated date and time on the sales agreement line. Matches **sys\_updated\_on.value**.Data type: String |
| sales\_agreement\_lines.sys\_updated\_on.label | Label of the updated date and time on the sales agreement lineData type: String |
| sales\_agreement\_lines.sys\_updated\_on.name | Name of the updated date and time on the sales agreement lineData type: String |
| sales\_agreement\_lines.sys\_updated\_on.type | Type of the updated date and time on the sales agreement line. Value is always `glide_date_time`.Data type: String |
| sales\_agreement\_lines.sys\_updated\_on.value | Value of the updated date and time on the sales agreement lineFormat: YYYY-MM-DD HH:mm:ss Data type: String |
| sales\_agreement\_lines.top\_sales\_agreement\_line | Information about the top sales agreement line.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Object ``` "top_sales_agreement_line": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.top\_sales\_agreement\_line.display\_value | Display value of the top sales agreement line. Matches **top\_sales\_agreement\_line.value**.Data type: String |
| sales\_agreement\_lines.top\_sales\_agreement\_line.label | Label of the top sales agreement line.Data type: String |
| sales\_agreement\_lines.top\_sales\_agreement\_line.name | Name the top sales agreement line.Data type: String |
| sales\_agreement\_lines.top\_sales\_agreement\_line.type | Type of the top sales agreement line. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.top\_sales\_agreement\_line.value | Value of the top sales agreement line.Data type: String |
| sales\_agreement\_lines.total\_one\_time\_price | Total one-time charges to be paid for the product or service.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Object ``` "total_one_time_price": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.total\_one\_time\_price.display\_value | Display value of the total one time price. Matches **total\_one\_time\_price.value**.Data type: String |
| sales\_agreement\_lines.total\_one\_time\_price.label | Label of the total one time price.Data type: String |
| sales\_agreement\_lines.total\_one\_time\_price.name | Name of the total one time price.Data type: String |
| sales\_agreement\_lines.total\_one\_time\_price.type | Type of the total one time price. Value is always `decimal`.Data type: String |
| sales\_agreement\_lines.total\_one\_time\_price.value | Value of the total one time price.Data type: String represented as a number \(currency\) |
| sales\_agreement\_lines.total\_recurring\_price | Total recurring price for the product associated with the sales agreement line.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Object ``` "total_recurring_price": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.total\_recurring\_price.display\_value | Display value of the total one time price. Matches **total\_recurring\_price.value**.Data type: String |
| sales\_agreement\_lines.total\_recurring\_price.label | Label of the total recurring price.Data type: String |
| sales\_agreement\_lines.total\_recurring\_price.name | Name of the total recurring price.Data type: String |
| sales\_agreement\_lines.total\_recurring\_price.type | Type of the total recurring price. Value is always `decimal`.Data type: String |
| sales\_agreement\_lines.total\_recurring\_price.value | Value of the total recurring price.Data type: String represented as a number \(currency\) |
| sales\_agreement\_lines.unit\_net\_price | The price for each unit within the sales agreement line.Table: Sales Agreement Line \[sn\_sales\_agmt\_core\_sales\_agreement\_line\] Data type: Object ``` "unit_net_price": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.unit\_net\_price | Display value of the unit net price. Matches **unit\_net\_price.value**.Data type: String |
| sales\_agreement\_lines.unit\_net\_price | Label of the unit net price.Data type: String |
| sales\_agreement\_lines.unit\_net\_price | Name of the unit net price.Data type: String |
| sales\_agreement\_lines.unit\_net\_price | Type of the unit net price. Value is always `decimal`.Data type: String |
| sales\_agreement\_lines.unit\_net\_price | Value of the unit net price.Data type: String represented as a number \(currency\) |
| sales\_agreement\_lines.unit\_of\_measurement | Unit of measurement of the sales agreement line.Table: Unit of measures \[sn\_prd\_pm\_uom\_list\] Data type: Object ``` "unit_of_measurement": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sales\_agreement\_lines.unit\_of\_measurement.display\_value | Display value of the unit of measurement. Matches **unit\_of\_measurement.value**.Data type: String |
| sales\_agreement\_lines.unit\_of\_measurement.label | Label of the unit of measurement.Data type: String |
| sales\_agreement\_lines.unit\_of\_measurement.name | Name of the unit of measurement.Data type: String |
| sales\_agreement\_lines.unit\_of\_measurement.type | Type of the unit of measurement. Value is always `reference`.Data type: String |
| sales\_agreement\_lines.unit\_of\_measurement.value | Value of the unit of measurement. For example, `bundle` or `each`.Data type: String |
| shipping\_location | Shipping address details on the sales agreement.Table: Location \[location\] Data type: Object ``` "unit_of_measure": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| shipping\_location.display\_value | Display value of the shipping location.Data type: String |
| shipping\_location.label | Label of the shipping location.Data type: String |
| shipping\_location.name | Name of the shipping location.Data type: String |
| shipping\_location.type | Type of shipping location. Value is always `reference`.Data type: String |
| shipping\_location.value | Value of the shipping location. For example, an address.Data type: String |
| short\_description | Brief details describing the sales agreement.Table: Sales Agreement \[sn\_sales\_agmt\_core\_sales\_agreement\] Data type: Object ``` "short_description": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| short\_description.display\_value | Display value of the short description. Matches **short\_description.value**.Data type: String |
| short\_description.label | Label of the short description.Data type: String |
| short\_description.name | Name of the short description.Data type: String |
| short\_description.type | Type of short description. Always of type `string`.Data type: String |
| short\_description.value | Value of the short description.Data type: String |
| starts | Start date of the sales agreement.Data type: Object ``` "starts": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| starts.display\_value | Display value of the start date. Matches **start.value**.Data type: String |
| starts.label | Label of the start date.Data type: String |
| starts.name | Name of the start date.Data type: String |
| starts.type | Type of start date. Value is always `glide_date_time`Data type: String |
| starts.value | Value of the start date.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| state | State of the sales agreement.Table: Sales Agreement \[sn\_sales\_agmt\_core\_sales\_agreement\] Data type: Object ``` "state": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| state.display\_value | Display value of the state. Matches **state.value**.Data type: String |
| state.lable | Label of the state.Data type: String |
| state.name | Name of the state.Data type: String |
| state.type | Type of state. Value is always `string`.Data type: String |
| state.value | Value of the state.Possible values: - active - cancelled - draft - expired Data type: String |
| sys\_created\_by | Name of the user who created the sales agreement.Table: User \[user\] Data type: Object ``` "sys_created_by": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sys\_created\_by.display\_value | Display value of the user who created the sales agreement. Matches **sys\_created\_by.value**.Data type: String |
| sys\_created\_by.label | Label of the user who created the sales agreement.Data type: String |
| sys\_created\_by.name | Name of the user who created the sales agreement.Data type: String |
| sys\_created\_by.type | Type of the user who created the sales agreement. Value is always `string`.Data type: String |
| sys\_created\_by.value | Value of the user who created the sales agreement.Data type: String |
| sys\_created\_on | Details about the date and time that the sales agreement was created.Data type: Object ``` "sys_created_on": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sys\_created\_on.display\_value | Display value of the creation date and time. Matches **sys\_created\_on.value**.Data type: String |
| sys\_created\_on.label | Label of the creation date and time.Data type: String |
| sys\_created\_on.name | Name of the creation date and time.Data type: String |
| sys\_created\_on.type | Type of the creation date and time. Value is always `string`.Data type: String |
| sys\_created\_on.value | Value of the creation date and time.Data type: String |
| sys\_id | Sys\_id of the newly created sales agreement.Table: Sales Agreement \[sn\_sales\_agmt\_core\_sales\_agreement\] Data type: Object ``` "sys_id": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sys\_id.displayValue | Display value of the unique sys\_id value. Matches **sys\_id.value**.Data type: String |
| sys\_id.label | Automatically generated name or label of the sys\_id.Data type: String |
| sys\_id.type | Type of sys\_id given to the sales agreement. Value is always `GUID`.Data type: String |
| sys\_id.value | Sys\_id number assigned to the new sales agreement.Data type: String |
| sys\_updated\_by | Name of the user who last updated the sales agreement.Table: User \[user\] Data type: Object ``` "sys_updated_by": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sys\_updated\_by.display\_value | Display value of the user who updated the sales agreement. Matches **sys\_updated\_by.value**.Data type: String |
| sys\_updated\_by.label | Label of the user who updated the sales agreement.Data type: String |
| sys\_updated\_by.name | Name of the user who updated the sales agreement.Data type: String |
| sys\_updated\_by.type | Type of the user who updated the sales agreement. Value is always `string`.Data type: String |
| sys\_updated\_by.value | Value of the user who updated the sales agreement.Data type: String |
| sys\_updated\_on | Details about the date and time that the sales agreement was updated.Data type: Object ``` "sys_updated_on": { "display_value": "String", "label": "String", "name": "String", "type": "String", "value": "String" } ``` |
| sys\_updated\_on.display\_value | Date and time value of the updated sales agreement. Matches **sys\_updated\_on.value**.Format: YYYY-MM-DD HH:mm:ss Data type: String |
| sys\_updated\_on.label | Label of the updated sales agreement.Data type: String |
| sys\_updated\_on.name | Name of the updated sales agreement.Data type: String |
| sys\_updated\_on.type | Type of the updated sales agreement. Value is always `glide_date_time`.Data type: String |
| sys\_updated\_on.value | Date and time value of the updated sales agreement.Format: YYYY-MM-DD HH:mm:ss Data type: String |