{"revision":"c10276e953456835cdbb1f3a60d58ae1980be353","document":{"id":550,"path":"api-reference/rest-apis/servicecontract-api.md","title":"Service Contract API","bundle":null,"doc_type":null,"release":"australia","body":"\n# Service Contract API\n\nThe Service Contract API provides endpoints to create and retrieve service contract records.\n\n**Note:** This API is for creating data in the tables for the Customer Contracts and Entitlements application. It is not a general purpose API.\n\nTo access this API the following plugins must be activated on the associated instance:\n\n- Customer Contracts and Entitlements \\(com.sn\\_pss\\_core\\)\n- Customer Service Install Base Management \\(com.snc.install\\)\n- Product Catalog Management Core \\(com.sn\\_prd\\)\n\nIn addition, to successfully call this API you must have the sn\\_pss\\_core.pss\\_integrator role. This API runs in the `sn_pss_core` namespace.\n\nBefore using this API, you should have associated data in the following tables. For additional information, see [Create service contracts](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/customer-service-management/create-csm-service-contracts.md).\n\n- Account \\[customer\\_account\\]\n- Consumer \\[csm\\_consumer\\]\n- Household \\[csm\\_household\\]\n- Install Base \\[sn\\_install\\_base\\_item\\]\n- Product Specification \\[sn\\_prd\\_pm\\_product\\_specification\\]\n- Product Offering \\[sn\\_prd\\_pm\\_product\\_offering\\]\n- Product Model \\[cmdb\\_model\\]\n- Sold Product \\[sn\\_install\\_base\\_sold\\_product\\]\n\n**Parent Topic:**[REST API reference](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-apis/api-rest.md)\n\n## Service Contract - GET /sn\\_pss\\_core/servicecontract/\\{id\\}\n\nRetrieves a specified service contract record.\n\nThis endpoint retrieves data from the following tables when processing the request:\n\n- Characteristic \\[sn\\_pss\\_core\\_entitlement\\_characteristic\\]\n- Entitlement \\[service\\_entitlement\\]\n- Entitlement Usage \\[sn\\_pss\\_core\\_entitlement\\_usage\\]\n- Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\] - This table contains information for both sold products covered and install base items covered.\n- Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n- Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n### URL format\n\nVersioned URL: `/api/sn_pss_core/{api_version}/servicecontract/{id}`\n\nDefault URL: `/api/sn_pss_core/servicecontract/{id}`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. 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\n\n
\n\nid\n\n\n\nSys\\_id of the service contract to retrieve.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\ndisplay\\_value\n\n\n\nType of data to return.Valid values:\n\n- false: Return the `value` for all fields. For example, `\"state\":\"draft\"`.\n- true: Return the `display_value` for all fields. For example, `\"state\":\"Draft\"`\n- all: Return all information for all fields.\n\nData type: String\n\nDefault: false\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|400|Bad Request. A bad request type or malformed request was detected.|\n|403|Forbidden. The user doesn't have permission to access the API.|\n|404|Not found. The requested item wasn't found.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\naccount\n\n\n\nSys\\_id of the account record to which the service contract belongs.\n\nData type: String\n\nTable: Account \\[customer\\_account\\]\n\n
\n\nconsumer\n\n\n\nSys\\_id of the consumer record to which the service contract belongs.\n\nData type: String\n\nTable: Consumer \\[csm\\_consumer\\]\n\n
\n\nends\n\n\n\nDate on which the service contract ends.\n\nData type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nhousehold\n\n\n\nSys\\_id of the household associated with the service contract.\n\nData type: String\n\nTable: Household \\[csm\\_household\\]\n\n
\n\ninstall\\_base\\_items\\_covered\n\n\n\nList of install base items covered under the service contract line.Data type: Array of Objects\n\n```\n\"install_base_items_covered\": [ \n {\n \"added\": \"String\",\n \"contract\": \"String\",\n \"entitlement\": \"String\",\n \"install_base\": \"String\",\n \"removed\": \"String\",\n \"service_contract_line\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\"\n }\n]\n```\n\n
\n\ninstall\\_base\\_items\\_covered.​added\n\n\n\nDate that the associated service contract starts to cover the install base item.\n\nData type: String\n\nFormat: yyyy-mm-dd\n\n
\n\ninstall\\_base\\_items\\_covered.​contract\n\n\n\nSys\\_id of the service contract record associated with the install base item.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\ninstall\\_base\\_items\\_covered.​entitlement\n\n\n\nSys\\_id of the entitlement record associated with the install base item.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\ninstall\\_base\\_items\\_covered.​install\\_base\n\n\n\nSys\\_id of the associated install base item record.Data type: String\n\nTable: Install Base Item \\[sn\\_install\\_base\\_item\\]\n\n
\n\ninstall\\_base\\_items\\_covered.​removed\n\n\n\nDate that the associated service contract ends coverage of the install base item.\n\nData type: String\n\nFormat: yyyy-mm-dd\n\n
\n\ninstall\\_base\\_items\\_covered.​service\\_contract\\_line\n\n\n\nSys\\_id of the associated service contract line record.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\ninstall\\_base\\_items\\_covered.​sys\\_created\\_by\n\n\n\nName of the user that created the install base item record.Data type: String\n\n
\n\ninstall\\_base\\_items\\_covered.​sys\\_created\\_on\n\n\n\nDate and time that the install base item record was created.Data type: String\n\n
\n\ninstall\\_base\\_items\\_covered.​sys\\_id\n\n\n\nSys\\_id of the install base item covered.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\ninstall\\_base\\_items\\_covered.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the install base item record.Data type: String\n\n
\n\ninstall\\_base\\_items\\_covered.​sys\\_updated\\_on\n\n\n\nDate and time that the install base item record was last updated.Data type: String\n\n
\n\nnumber\n\n\n\nAuto-generated service contract number.Data type: String\n\n
\n\nservice\\_contract\\_lines\n\n\n\nList of service contract lines \\(services\\) associated with the service contract. Data type: Array of Objects\n\n```\n\"service_contract_lines\": [\n {\n \"child_contract_lines\": [Array],\n \"contract\": \"String\",\n \"ends\": \"String\",\n \"entitlements\": [Array],\n \"entitlement_characteristics\": [Array],\n \"install_base_items_covered\": [Array],\n \"name\": \"String\",\n \"number\": \"String\",\n \"parent_contract_line\": \"String\",\n \"product_model\": \"String\",\n \"product_offering\": \"String\",\n \"product_specification\": \"String\",\n \"sold_product\": \"String\",\n \"sold_products_covered\": [Array],\n \"starts\": \"String\",\n \"state\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_update_on\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines\n\n\n\nList of child service contract lines associated with the service contract line.Data type: Array of Objects\n\n```\n\"child_contract_lines\": [\n {\n \"child_contract_lines\": [Array],\n \"contract\": \"String\",\n \"ends\": \"String\",\n \"entitlements\": [Array],\n \"entitlement_characteristics\": [Array],\n \"install_base_items_covered\": [Array],\n \"name\": \"String\",\n \"number\": \"String\",\n \"parent_contract_line\": \"String\",\n \"product_model\": \"String\",\n \"product_offering\": \"String\",\n \"product_specification\": \"String\",\n \"sold_product\": \"String\",\n \"sold_products_covered\": [Array],\n \"starts\": \"String\",\n \"state\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_update_on\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​child\\_contract\\_lines\n\n\n\nList of child service contract lines associated with the child service contract line. Same parameters as in **child\\_contract\\_lines**.Data type: Array\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​contract\n\n\n\nSys\\_id of the service contract associated with the child service contract line.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​ends\n\n\n\nDate on which the child service contract line ends.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Never ends until manually removed.\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements\n\n\n\nList of entitlements associated with the child service contract line.Data type: Array of Objects\n\n```\n\"entitlements\": [\n {\n \"account\": \"String\",\n \"consumer\": \"String\",\n \"contract\": \"String\",\n \"end_date\": \"String\",\n \"entitlement_characteristics\": [Array],\n \"entitlement_name\": \"String\",\n \"household\": \"String\",\n \"install_base_items_covered\": [Array],\n \"product\": \"String\",\n \"product_offering\": \"String\",\n \"product_specification\": \"String\",\n \"service_contract_line\": \"String\",\n \"sold_entitlement\": \"String\",\n \"sold_products_covered\": [Array],\n \"start_date\": \"String\",\n \"state\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​account\n\n\n\nSys\\_id of the account record to which the entitlement belongs.\n\nData type: String\n\nTable: Account \\[customer\\_account\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​consumer\n\n\n\nSys\\_id of the consumer record to which the entitlement belongs.\n\nData type: String\n\nTable: Consumer \\[csm\\_consumer\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​contract\n\n\n\nSys\\_id of the contract record to which the entitlement belongs.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​end\\_date\n\n\n\nEnd date of the entitlement.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Never ends until manually removed.\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics\n\n\n\nList of characteristics associated with the entitlement. Data type: Array of Objects\n\n```\n\"entitlement_characteristics\": [\n {\n \"characteristic\": \"String\",\n \"characteristic_option\": \"String\",\n \"entitlement\": \"String\",\n \"service_contract_line\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\",\n \"type\": \"String\",\n \"value\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​characteristic\n\n\n\nSys\\_id of the characteristic record associated with the entitlement.\n\nData type: String\n\nTable: Characteristic \\[sn\\_prd\\_pm\\_characteristic\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​characteristic\\_option\n\n\n\nSys\\_id of the characteristic option record associated with the entitlement.Data type: String\n\nTable: Characteristic Option \\[sn\\_prd\\_pm\\_characteristic\\_option\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\n\n\n\nSys\\_id of the entitlement record.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage\n\n\n\nList of usage values for the associated product.Data type: Array of Objects\n\n```\n\"entitlement_usage\": [\n {\n \"entitlement\": \"String\",\n \"entitlement_characteristic\": \"String\",\n \"period_end\": \"String\",\n \"period_start\": \"String\",\n \"service_contract_line\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_update_on\": \"String\",\n \"total_units\": \"String\",\n \"used_units\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​entitlement\n\n\n\nSys\\_id of the entitlement record associated with the entitlement usage.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​entitlement\\_characteristic\n\n\n\nSys\\_id of the entitlement characteristic record associated with the entitlement usage.Data type: String\n\nTable: Characteristic \\[sn\\_pss\\_core\\_entitlement\\_characteristic\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​period\\_end\n\n\n\nEnd date when the entitlement usage is no longer tracked.Data type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​period\\_start\n\n\n\nStarting date of when the entitlement usage is tracked.Data type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​service\\_contract\\_line\n\n\n\nSys\\_id of the service contract line to which the current entitlement usage belongs.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_created\\_by\n\n\n\nName of the user that created the entitlement usage record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_created\\_on\n\n\n\nDate and time that the entitlement usage record was created.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_id\n\n\n\nSys\\_id of the entitlement usage record.Data type: String\n\nTable: Entitlement Usage \\[sn\\_pss\\_core\\_entitlement\\_usage\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the entitlement usage record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_updated\\_on\n\n\n\nDate and time that the entitlement usage record was last updated.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​total\\_units\n\n\n\nTotal coverage value of the associated entitlement characteristic.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​used\\_units\n\n\n\nNumber of units used by the account or consumer between the **period\\_start** and the **period\\_end**.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​service\\_contract\\_line\n\n\n\nChild contract line to which the current entitlement characteristic belongs to. Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​sys\\_created\\_by\n\n\n\nName of the user who created the entitlement characteristic.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​sys\\_created\\_on\n\n\n\nDate and time when the entitlement characteristic was created.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​sys\\_id\n\n\n\nSys\\_id of the entitlement characteristic record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​sys\\_updated\\_by\n\n\n\nName of the user who last updated the entitlement characteristic.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​sys\\_updated\\_on\n\n\n\nDate and time when the entitlement characteristic was last updated.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​type\n\n\n\nType of entitlement characteristic. Valid values:\n\n- coverage\n- coverage\\_and\\_usage\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​value\n\n\n\nValue of the characteristic.\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_name\n\n\n\nName of the entitlement.\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​household\n\n\n\nSys\\_id of the household record associated with the entitlement.\n\nData type: String\n\nTable: Household \\[csm\\_household\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered\n\n\n\nList of install base items covered under the  child service contract line.Data type: Array of Objects\n\n```\n \"install_base_items_covered\": [ \n {\n \"added\": \"String\",\n \"contract\": \"String\",\n \"entitlement\": \"String\",\n \"install_base\": \"String\",\n \"removed\": \"String\",\n \"service_contract_line\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\"\n }\n]\n```\n\nTable: Sold Product Covered  \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​added\n\n\n\nDate that the associated install base item was added to the service contract line.\n\nData type: String\n\n Format: yyyy-mm-dd\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​contract\n\n\n\nSys\\_id of the service contract record associated with the install base item.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​entitlement\n\n\n\nSys\\_id of the entitlement record associated with the install base item.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​install\\_base\n\n\n\nSys\\_id of the associated install base item record.Data type: String\n\nTable: Install Base Item \\[sn\\_install\\_base\\_item\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​removed\n\n\n\nDate that the associated service contract line ends coverage of the install base item.\n\nData type: String\n\n Format: yyyy-mm-dd\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​service\\_contract\\_line\n\n\n\nSys\\_id of the associated service contract line record.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​sys\\_created\\_by\n\n\n\nName of the user that created the install base item record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​sys\\_created\\_on\n\n\n\nDate and time that the install base item record was created.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​sys\\_id\n\n\n\nSys\\_id of the install base item covered.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the install base item record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​sys\\_updated\\_on\n\n\n\nDate and time that the install base item record was last updated.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​product\n\n\n\nSys\\_id of the product model record associated with the entitlement.Data type: String\n\nTable: Product Model \\[cmdb\\_model\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​product\\_offering\n\n\n\nSys\\_id of the product offering record associated with the entitlement.Data type: String\n\nTable: Product Offering \\[sn\\_prd\\_pm\\_product\\_offering\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​product\\_specification\n\n\n\nSys\\_id of the product specification record associated with the entitlement.Data type: String\n\nTable: Product Specification \\[sn\\_prd\\_pm\\_product\\_specification\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​service\\_contract\\_line\n\n\n\nSys\\_id of the service contract line record associated with the entitlement.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​sold\\_entitlement\n\n\n\nSys\\_id of the sold product record associated with the entitlement.Data type: String\n\nTable: Sold Product \\[sn\\_install\\_base\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​sold\\_products\\_covered\n\n\n\nList of products covered.Data type: Array of Objects\n\n```\n\"sold_products_covered\": [ \n {\n \"added\": \"String\",\n \"contract\": \"String\",\n \"entitlement\": \"String\",\n \"removed\": \"String\",\n \"service_contract_line\": \"String\",\n \"sold_product\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\"\n }\n]\n```\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​added\n\n\n\nDate that the associated service contract starts to cover the product.\n\nData type: String\n\n Format: yyyy-mm-dd\n\n Default: Current date\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​contract\n\n\n\nSys\\_id of the service contract record associated with the sold product covered.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​entitlement\n\n\n\nSys\\_id of the entitlement record associated with the sold product covered.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​removed\n\n\n\nDate that the associated service contract ends coverage of the associated product.\n\nData type: String\n\n Format: yyyy-mm-dd\n\n Default: No end date\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​service\\_contract\\_line\n\n\n\nSys\\_id of the service contract line record associated with the sold product covered.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​sold\\_product\n\n\n\nSys\\_id of the product covered by the service contract.Data type: String\n\nTable: Sold Product \\[sn\\_install\\_base\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​sys\\_created\\_by\n\n\n\nName of the user that created the sold product covered record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​sold\\_products\\_covered.​sys\\_created\\_on\n\n\n\nDate and time that the sold product covered record was created.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​sys\\_id\n\n\n\nSys\\_id of the product covered by this service contract.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the sold product covered record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​sys\\_updated\\_on\n\n\n\nName of the user that last updated the sold product covered record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​start\\_date\n\n\n\nStart date of the entitlement.\n\nData type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​state\n\n\n\nCurrent state of the entitlement.\n\nValid values: \\(case-sensitive\\)\n\n- active\n- cancelled\n- draft\n- expired\n- suspended\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​sys\\_created\\_by\n\n\n\nName of the user that created the entitlement record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​sys\\_created\\_on\n\n\n\nDate and time that the entitlement record was created.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​sys\\_id\n\n\n\nSys\\_id of the associated entitlement record.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the entitlement record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​sys\\_updated\\_on\n\n\n\nDate and time that the entitlement record was created.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlement\\_characteristics\n\n\n\nList of characteristics associated with the entitlement.Data type: Array of Objects\n\n```\n\"entitlement_characteristics\": [\n {\n \"characteristic\": \"String\",\n \"characteristic_option\": \"String\",\n \"entitlement\": \"String\",\n \"entitlement_usage\": [Array],\n \"service_contract_line\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\"\n \"type\": \"String\",\n \"value\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlement\\_characteristics.​characteristic\n\n\n\nSys\\_id of the characteristic record associated with the entitlement.\n\nData type: String\n\nTable: Characteristic \\[sn\\_prd\\_pm\\_characteristic\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlement\\_characteristics.​characteristic\\_option\n\n\n\nSys\\_id of the characteristic option record associated with the entitlement.Data type: String\n\nTable: Characteristic Option \\[sn\\_prd\\_pm\\_characteristic\\_option\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\n\n\n\nSys\\_id of the entitlement record.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlement\\_characteristics.​service\\_contract\\_line\n\n\n\nSys\\_id of the service contract line record associated with the entitlement characteristic.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlement\\_characteristics.​sys\\_created\\_by\n\n\n\nName of the user that created the entitlement characteristics record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlement\\_characteristics.​sys\\_created\\_on\n\n\n\nDate and time that the entitlement characteristics record was created.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlement\\_characteristics.​sys\\_id\n\n\n\nSys\\_id of the entitlement characteristics record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlement\\_characteristics.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the entitlement characteristics record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlement\\_characteristics.​sys\\_updated\\_on\n\n\n\nDate and time that the entitlement characteristics record was last updated.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlement\\_characteristics.​type\n\n\n\nType of entitlement characteristic. Valid values:\n\n- coverage\n- coverage\\_and\\_usage\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlement\\_characteristics.​value\n\n\n\nValue of the characteristic.\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​install\\_base\\_items\\_covered\n\n\n\nList of install base items covered under the  child service contract line.Data type: Array of Objects\n\n```\n \"install_base_items_covered\": [ \n {\n \"added\": \"String\",\n \"contract\": \"String\",\n \"entitlement\": \"String\",\n \"install_base\": \"String\",\n \"removed\": \"String\",\n \"service_contract_line\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\"\n }\n]\n```\n\nTable: Sold Product Covered  \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​install\\_base\\_items\\_covered.​added\n\n\n\nDate that the associated install base item was added to the service contract line.\n\nData type: String\n\n Format: yyyy-mm-dd\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​install\\_base\\_items\\_covered.​contract\n\n\n\nSys\\_id of the service contract record associated with the install base item.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​install\\_base\\_items\\_covered.​entitlement\n\n\n\nSys\\_id of the entitlement record associated with the install base item.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​install\\_base\\_items\\_covered.​install\\_base\n\n\n\nSys\\_id of the associated install base item record.Data type: String\n\nTable: Install Base Item \\[sn\\_install\\_base\\_item\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​install\\_base\\_items\\_covered.​removed\n\n\n\nDate that the associated service contract line ends coverage of the install base item.\n\nData type: String\n\n Format: yyyy-mm-dd\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​install\\_base\\_items\\_covered.​service\\_contract\\_line\n\n\n\nSys\\_id of the associated service contract line record.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​install\\_base\\_items\\_covered.​sys\\_created\\_by\n\n\n\nName of the user that created the install base item record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​install\\_base\\_items\\_covered.​sys\\_created\\_on\n\n\n\nDate and time that the install base item record was created.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​install\\_base\\_items\\_covered.​sys\\_id\n\n\n\nSys\\_id of the install base item covered.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​install\\_base\\_items\\_covered.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the install base item record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​install\\_base\\_items\\_covered.​sys\\_updated\\_on\n\n\n\nDate and time that the install base item record was last updated.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​name\n\n\n\nName of the child service contract line.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​parent\\_contract\\_line\n\n\n\nSys\\_id of the parent contract line record associated with the child service contract line.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​product\\_model\n\n\n\nSys\\_id of the product associated with the child service contract line.Data type: String\n\nTable: Product Model \\[cmdb\\_model\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​product\\_offering\n\n\n\nSys\\_id of the product offering record associated with the child service contract line.Data type: String\n\nTable: Product Offering \\[sn\\_prd\\_pm\\_product\\_offering\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​sold\\_product\n\n\n\nSys\\_id of the sold product record associated with the child service contract line.Data type: String\n\nTable: Sold Product \\[sn\\_install\\_base\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​sold\\_products\\_covered\n\n\n\nList of products covered.Data type: Array of Objects\n\n```\n\"sold_products_covered\": [ \n {\n \"added\": \"String\",\n \"contract\": \"String\",\n \"entitlement\": \"String\",\n \"removed\": \"String\",\n \"service_contract_line\": \"String\",\n \"sold_product\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\"\n }\n]\n```\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​sold\\_products\\_covered.​added\n\n\n\nDate that the associated service contract starts to cover the product.\n\nData type: String\n\n Format: yyyy-mm-dd\n\n Default: Current date\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​sold\\_products\\_covered.​contract\n\n\n\nSys\\_id of the service contract record associated with the sold product covered.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​sold\\_products\\_covered.​entitlement\n\n\n\nSys\\_id of the entitlement record associated with the sold product covered.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​sold\\_products\\_covered.​removed\n\n\n\nDate that the associated service contract ends coverage of the associated product.\n\nData type: String\n\n Format: yyyy-mm-dd\n\n Default: No end date\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​sold\\_products\\_covered.​service\\_contract\\_line\n\n\n\nSys\\_id of the service contract line record associated with the sold product covered.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​sold\\_products\\_covered.​sold\\_product\n\n\n\nSys\\_id of the product covered by the service contract.Data type: String\n\nTable: Sold Product \\[sn\\_install\\_base\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​sold\\_products\\_covered.​sys\\_created\\_by\n\n\n\nName of the user that created the sold product covered record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​sold\\_products\\_covered.​sys\\_created\\_on\n\n\n\nDate and time that the sold product covered record was created.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​sold\\_products\\_covered.​sys\\_id\n\n\n\nSys\\_id of the product covered by this service contract.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​sold\\_products\\_covered.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the sold product covered record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​sold\\_products\\_covered.​sys\\_updated\\_on\n\n\n\nName of the user that last updated the sold product covered record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​starts\n\n\n\nStart date of the child service contract line.Data type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​sys\\_created\\_by\n\n\n\nName of the user that created the child service contract line record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​sys\\_created\\_on\n\n\n\nDate and time that the child service contract line record was created.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​sys\\_id\n\n\n\nSys\\_id of a child service contract line record.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the child service contract line record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​sys\\_updated\\_on\n\n\n\nDate and time that the child service contract line record was last updated.Data type: String\n\n
\n\nservice\\_contract\\_lines.​contract\n\n\n\nSys\\_id of the service contract associated with the service contract line.\n\nData type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nservice\\_contract\\_lines.​ends\n\n\n\nDate on which the service contract line ends.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Never ends until manually removed.\n\n
\n\nservice\\_contract\\_lines.​entitlements\n\n\n\nList of entitlements associated with the service contract.Data type: Array of Objects\n\n```\n\"entitlements\": [\n {\n \"account\": \"String\",\n \"consumer\": \"String\",\n \"contract\": \"String\",\n \"end_date\": \"String\",\n \"entitlement_characteristics\": [Array],\n \"entitlement_name\": \"String\",\n \"household\": \"String\",\n \"install_base_items_covered\": [Array],\n \"product\": \"String\",\n \"product_offering\": \"String\",\n \"product_specification\": \"String\",\n \"service_contract_line\": \"String\",\n \"sold_entitlement\": \"String\",\n \"sold_products_covered\": [Array],\n \"start_date\": \"String\",\n \"state\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\"\n }\n]\n```\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​account\n\n\n\nSys\\_id of the account record to which the entitlement belongs.\n\nData type: String\n\nTable: Account \\[customer\\_account\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​consumer\n\n\n\nSys\\_id of the consumer record to which the entitlement belongs.\n\nData type: String\n\nTable: Consumer \\[csm\\_consumer\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​contract\n\n\n\nSys\\_id of the contract record to which the entitlement belongs.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​end\\_date\n\n\n\nEnd date of the entitlement.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Never ends until manually removed.\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics\n\n\n\nList of characteristics associated with the entitlement.Data type: Array of Objects\n\n```\n\"entitlement_characteristics\": [\n {\n \"characteristic\": \"String\",\n \"characteristic_option\": \"String\",\n \"entitlement\": \"String\",\n \"entitlement_usage\": [Array]\n \"service_contract_line\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\",\n \"type\": \"String\",\n \"value\": \"String\"\n }\n]\n```\n\nTable: Characteristic \\[sn\\_pss\\_core\\_entitlement\\_characteristic\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.characteristic\n\n\n\nSys\\_id of the characteristic record associated with the entitlement.\n\nData type: String\n\nTable: Characteristic \\[sn\\_prd\\_pm\\_characteristic\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.characteristic\\_option\n\n\n\nSys\\_id of the characteristic option record associated with the entitlement.Data type: String\n\nTable: Characteristic Option \\[sn\\_prd\\_pm\\_characteristic\\_option\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\n\n\n\nSys\\_id of the associated entitlement record.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage\n\n\n\nList of usage values for the associated product.Data type: Array of Objects\n\n```\n\"entitlement_usage\": [\n {\n \"entitlement\": \"String\",\n \"entitlement_characteristic\": \"String\",\n \"period_end\": \"String\",\n \"period_start\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_update_on\": \"String\",\n \"total_units\": \"String\",\n \"used_units\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​entitlement\n\n\n\nSys\\_id of the entitlement record associated with the entitlement usage.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​entitlement\\_characteristic\n\n\n\nSys\\_id of the entitlement characteristic record associated with the entitlement usage.Data type: String\n\nTable: Characteristic \\[sn\\_pss\\_core\\_entitlement\\_characteristic\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​period\\_end\n\n\n\nEnd date when the entitlement usage is no longer tracked.Data type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​period\\_start\n\n\n\nStarting date of when the entitlement usage is tracked.Data type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_created\\_by\n\n\n\nName of the user that created the entitlement usage record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_created\\_on\n\n\n\nDate and time that the entitlement usage record was created.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_id\n\n\n\nSys\\_id of the entitlement usage record.Data type: String\n\nTable: Entitlement Usage \\[sn\\_pss\\_core\\_entitlement\\_usage\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the entitlement usage record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_updated\\_on\n\n\n\nDate and time that the entitlement usage record was last updated.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​total\\_units\n\n\n\nTotal coverage value of the associated entitlement characteristic.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​used\\_units\n\n\n\nNumber of units used by the account or consumer between the **period\\_start** and the **period\\_end**.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​service\\_contract\\_line\n\n\n\nSys\\_id of the service contract line record associated with the entitlement characteristic.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​sys\\_created\\_by\n\n\n\nName of the user that created the entitlement characteristics record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​sys\\_created\\_on\n\n\n\nDate and time that the entitlement characteristics record was created.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​sys\\_id\n\n\n\nSys\\_id of the entitlement characteristics record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the entitlement characteristics record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​sys\\_updated\\_on\n\n\n\nDate and time that the entitlement characteristics record was last updated.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.type\n\n\n\nType of entitlement characteristic. Valid values:\n\n- coverage\n- coverage\\_and\\_usage\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​value\n\n\n\nValue of the characteristic.\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_name\n\n\n\nName of the entitlement.\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​household\n\n\n\nSys\\_id of the household record associated with the entitlement.\n\nData type: String\n\nTable: Household \\[csm\\_household\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered\n\n\n\nList of install base items covered under the service contract line.Data type: Array of Objects\n\n```\n\"install_base_items_covered\": [ \n {\n \"added\": \"String\",\n \"contract\": \"String\",\n \"entitlement\": \"String\",\n \"install_base\": \"String\",\n \"removed\": \"String\",\n \"service_contract_line\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​added\n\n\n\nDate that the associated install base item was added to the entitlement.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​contract\n\n\n\nSys\\_id of the service contract record associated with the install base item.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​entitlement\n\n\n\nSys\\_id of the entitlement record associated with the install base item.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​install\\_base\n\n\n\nSys\\_id of the associated install base item record.Data type: String\n\nTable: Install Base Item \\[sn\\_install\\_base\\_item\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​removed\n\n\n\nDate that the associated install base item was removed from the entitlement.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​service\\_contract\\_line\n\n\n\nSys\\_id of the associated service contract line record.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​sys\\_created\\_by\n\n\n\nName of the user that created the install base item record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​sys\\_created\\_on\n\n\n\nDate and time that the install base item record was created.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​sys\\_id\n\n\n\nSys\\_id of the install base item covered.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the install base item record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​sys\\_updated\\_on\n\n\n\nDate and time that the install base item record was last updated.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​product\n\n\n\nSys\\_id of the product model record associated with the entitlement.Data type: String\n\nTable: Product Model \\[cmdb\\_model\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​product\\_offering\n\n\n\nSys\\_id of the product offering record associated with the entitlement.Data type: String\n\nTable: Product Offering \\[sn\\_prd\\_pm\\_product\\_offering\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​product\\_specification\n\n\n\nSys\\_id of the product specification record associated with the entitlement.Data type: String\n\nTable: Product Specification \\[sn\\_prd\\_pm\\_product\\_specification\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​service\\_contract\\_line\n\n\n\nSys\\_id of the service contract line record associated with the entitlement.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​sold\\_entitlement\n\n\n\nSys\\_id of the sold product record associated with the entitlement.Data type: String\n\nTable: Sold Product \\[sn\\_install\\_base\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​sold\\_products\\_covered\n\n\n\nList of products covered.Data type: Array of Objects\n\n```\n\"sold_products_covered\": [ \n {\n \"added\": \"String\",\n \"contract\": \"String\",\n \"entitlement\": \"String\",\n \"removed\": \"String\",\n \"service_contract_line\": \"String\",\n \"sold_product\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\"\n }\n]\n```\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​added\n\n\n\nDate that the associated sold product was added to the entitlement.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Current date\n\n
\n\nservice\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​contract\n\n\n\nSys\\_id of the service contract record associated with the sold product covered.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​entitlement\n\n\n\nSys\\_id of the entitlement record associated with the sold product covered.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.removed\n\n\n\nDate that the associated sold product was removed from the entitlement.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: No end date\n\n
\n\nservice\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​service\\_contract\\_line\n\n\n\nSys\\_id of the service contract line record associated with the sold product covered.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​sold\\_product\n\n\n\nSys\\_id of the product covered by the entitlement.Data type: String\n\nTable: Sold Product \\[sn\\_install\\_base\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​sys\\_created\\_by\n\n\n\nName of the user that created the sold product covered record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​sys\\_created\\_on\n\n\n\nDate and time that the sold product covered record was created.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​sys\\_id\n\n\n\nSys\\_id of the product covered by this service contract.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the sold product covered record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​sys\\_updated\\_on\n\n\n\nDate and time that the sold product covered record was last updated.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​start\\_date\n\n\n\nStart date of the entitlement.\n\nData type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nservice\\_contract\\_lines.​entitlements.​state\n\n\n\nCurrent state of the entitlement.\n\nValid values: \\(case-sensitive\\)\n\n- active\n- cancelled\n- draft\n- expired\n- suspended\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​sys\\_created\\_by\n\n\n\nName of the user that created the entitlement record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​sys\\_created\\_on\n\n\n\nDate and time that the entitlement record was created.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​sys\\_id\n\n\n\nSys\\_id of the associated entitlement record.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the entitlement record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​sys\\_updated\\_on\n\n\n\nDate and time that the entitlement record was created.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics\n\n\n\nList of characteristics associated with the service contract line.Data type: Array of Objects\n\n```\n\"entitlement_characteristics\": [\n {\n \"characteristic\": \"String\",\n \"characteristic_option\": \"String\",\n \"entitlement\": \"String\",\n \"entitlement_usage\": [Array],\n \"service_contract_line\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\",\n \"type\": \"String\",\n \"value\": \"String\"\n }\n]\n```\n\nTable: Characteristic \\[sn\\_pss\\_core\\_entitlement\\_characteristic\\]\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.characteristic\n\n\n\nSys\\_id of the characteristic record associated with the entitlement.\n\nData type: String\n\nTable: Characteristic \\[sn\\_prd\\_pm\\_characteristic\\]\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.characteristic\\_option\n\n\n\nSys\\_id of the characteristic option record associated with the entitlement.Data type: String\n\nTable: Characteristic Option \\[sn\\_prd\\_pm\\_characteristic\\_option\\]\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\n\n\n\nSys\\_id of the associated entitlement record.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage\n\n\n\nList of usage values for the associated product.Data type: Array of Objects\n\n```\n\"entitlement_usage\": [\n {\n \"entitlement\": \"String\",\n \"entitlement_characteristic\": \"String\",\n \"period_end\": \"String\",\n \"period_start\": \"String\",\n \"service_contract_line\": \"String\", \n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_update_on\": \"String\",\n \"total_units\": \"String\",\n \"used_units\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage.​entitlement\n\n\n\nSys\\_id of the entitlement record associated with the entitlement usage.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage.​entitlement\\_characteristic\n\n\n\nSys\\_id of the entitlement characteristic record associated with the entitlement usage.Data type: String\n\nTable: Characteristic \\[sn\\_pss\\_core\\_entitlement\\_characteristic\\]\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage.​period\\_end\n\n\n\nEnd date when the entitlement usage is no longer tracked.Data type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage.​period\\_start\n\n\n\nStarting date of when the entitlement usage is tracked.Data type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_created\\_by\n\n\n\nName of the user that created the entitlement usage record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_created\\_on\n\n\n\nDate and time that the entitlement usage record was created.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_id\n\n\n\nSys\\_id of the entitlement usage record.Data type: String\n\nTable: Entitlement Usage \\[sn\\_pss\\_core\\_entitlement\\_usage\\]\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the entitlement usage record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_updated\\_on\n\n\n\nDate and time that the entitlement usage record was last updated.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage.​total\\_units\n\n\n\nTotal number of units purchased.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage.​used\\_units\n\n\n\nNumber of units that have been used.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.​service\\_contract\\_line\n\n\n\nSys\\_id of the service contract line record associated with the entitlement characteristic.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.​sys\\_created\\_by\n\n\n\nName of the user that created the entitlement characteristics record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.​sys\\_created\\_on\n\n\n\nDate and time that the entitlement characteristics record was created.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.​sys\\_id\n\n\n\nSys\\_id of the entitlement characteristics record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the entitlement characteristics record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.​sys\\_updated\\_on\n\n\n\nDate and time that the entitlement characteristics record was last updated.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.type\n\n\n\nType of entitlement characteristic. Valid values:\n\n- coverage\n- coverage\\_and\\_usage\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.value\n\n\n\nValue of the characteristic.\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​install\\_base\\_items\\_covered\n\n\n\nList of install base items covered under the  service contract line.Data type: Array of Objects\n\n```\n \"install_base_items_covered\": [ \n {\n \"added\": \"String\",\n \"contract\": \"String\",\n \"entitlement\": \"String\",\n \"install_base\": \"String\",\n \"removed\": \"String\",\n \"service_contract_line\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\"\n }\n]\n```\n\nTable: Sold Product Covered  \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​install\\_base\\_items\\_covered.​added\n\n\n\nDate that the associated install base item was added to the service contract line.\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​install\\_base\\_items\\_covered.​contract\n\n\n\nSys\\_id of the service contract record associated with the install base item.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nservice\\_contract\\_lines.​install\\_base\\_items\\_covered.​entitlement\n\n\n\nSys\\_id of the entitlement record associated with the install base item.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nservice\\_contract\\_lines.​install\\_base\\_items\\_covered.​install\\_base\n\n\n\nSys\\_id of the install base item covered by the service contract line.Data type: String\n\nTable: Install Base Item \\[sn\\_install\\_base\\_item\\]\n\n
\n\nservice\\_contract\\_lines.​install\\_base\\_items\\_covered.​removed\n\n\n\nDate that the associated service contract line ends coverage of the install base item.\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​install\\_base\\_items\\_covered.​service\\_contract\\_line\n\n\n\nSys\\_id of the associated service contract line record.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nservice\\_contract\\_lines.​install\\_base\\_items\\_covered.​sys\\_created\\_by\n\n\n\nName of the user that created the install base item record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​install\\_base\\_items\\_covered.​sys\\_created\\_on\n\n\n\nDate and time that the install base item record was created.Data type: String\n\n
\n\nservice\\_contract\\_lines.​install\\_base\\_items\\_covered.​sys\\_id\n\n\n\nSys\\_id of the install base item covered.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​install\\_base\\_items\\_covered.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the install base item record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​install\\_base\\_items\\_covered.​sys\\_updated\\_on\n\n\n\nDate and time that the install base item record was last updated.Data type: String\n\n
\n\nservice\\_contract\\_lines.​name\n\n\n\nName of the service contract line.\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​number\n\n\n\nUnique number of the service contract line. Automatically generated by the endpoint. For example: CTRL9812347.Data type: String\n\n
\n\nservice\\_contract\\_lines.​parent\\_contract\\_line\n\n\n\nSys\\_id of the service contract line to which the current service contract line is a child of.Null for the contract lines created under a contract.\n\nData type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nservice\\_contract\\_lines.​product\\_model\n\n\n\nSys\\_id of the product associated with the service contract line.Data type: String\n\nTable: Product Model \\[cmdb\\_model\\]\n\n
\n\nservice\\_contract\\_lines.​product\\_offering\n\n\n\nSys\\_id of the product offering record associated with the service contract line.Data type: String\n\nTable: Product Offering \\[sn\\_prd\\_pm\\_product\\_offering\\]\n\n
\n\nservice\\_contract\\_lines.​product\\_specification\n\n\n\nSys\\_id of the product specification record associated with the service contract line.Data type: String\n\nTable: Product Specification \\[sn\\_prd\\_pm\\_product\\_specification\\]\n\n
\n\nservice\\_contract\\_lines.​sold\\_product\n\n\n\nSys\\_id of the sold product record associated with the service contract line.Data type: String\n\nTable: Sold Product \\[sn\\_install\\_base\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​sold\\_products\\_covered\n\n\n\nList of products covered.Data type: Array of Objects\n\n```\n\"sold_products_covered\": [ \n {\n \"added\": \"String\",\n \"contract\": \"String\",\n \"entitlement\": \"String\",\n \"removed\": \"String\",\n \"service_contract_line\": \"String\",\n \"sold_product\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\"\n }\n]\n```\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​sold\\_products\\_covered.​added\n\n\n\nDate that the associated sold product was added to the service contract line.Data type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nservice\\_contract\\_lines.​sold\\_products\\_covered.​contract\n\n\n\nSys\\_id of the service contract record associated with the sold product covered.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nservice\\_contract\\_lines.​sold\\_products\\_covered.​entitlement\n\n\n\nSys\\_id of the entitlement record associated with the sold product covered.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nservice\\_contract\\_lines.​sold\\_products\\_covered.removed\n\n\n\nDate that the associated sold product was removed from the service contract line.Data type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nservice\\_contract\\_lines.​sold\\_products\\_covered.​service\\_contract\\_line\n\n\n\nSys\\_id of the service contract line record associated with the sold product covered.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nservice\\_contract\\_lines.​sold\\_products\\_covered.​sold\\_product\n\n\n\nSys\\_id of the product covered by the entitlement.Data type: String\n\nTable: Sold Product \\[sn\\_install\\_base\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​sold\\_products\\_covered.​sys\\_created\\_by\n\n\n\nName of the user that created the sold product covered record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​sold\\_products\\_covered.​sys\\_created\\_on\n\n\n\nDate and time that the sold product covered record was created.Data type: String\n\n
\n\nservice\\_contract\\_lines.​sold\\_products\\_covered.​sys\\_id\n\n\n\nSys\\_id of the product covered by this service contract.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​sold\\_products\\_covered.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the sold product covered record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​sold\\_products\\_covered.​sys\\_updated\\_on\n\n\n\nDate and time that the sold product covered record was last updated.Data type: String\n\n
\n\nservice\\_contract\\_lines.​starts\n\n\n\nStart date of the service contract line.\n\nData type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nservice\\_contract\\_lines.​state\n\n\n\nCurrent state of the contract line.\n\nValid values: \\(case-sensitive\\)\n\n- active\n- cancelled\n- draft\n- expired\n- suspended\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​sys\\_created\\_by\n\n\n\nName of the user that created the service contract line record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​sys\\_created\\_on\n\n\n\nDate and time that the service contract line record was created.Data type: String\n\n
\n\nservice\\_contract\\_lines.​sys\\_id\n\n\n\nSys\\_id of a service contract line record.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nservice\\_contract\\_lines.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the service contract line record.Data type: String\n\n
\n\nservice\\_contract\\_lines.​sys\\_updated\\_on\n\n\n\nDate and time that the service contract line record was last updated.Data type: String\n\n
\n\nshort\\_description\n\n\n\nBrief description or name of the service contract.\n\nData type: String\n\n
\n\nsold\\_products\\_covered\n\n\n\nList of products covered.Data type: Array of Objects\n\n```\n\"sold_products_covered\": [ \n {\n \"added\": \"String\",\n \"contract\": \"String\",\n \"entitlement\": \"String\",\n \"removed\": \"String\",\n \"service_contract_line\": \"String\",\n \"sold_product\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\"\n }\n]\n```\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nsold\\_products\\_covered.​added\n\n\n\nDate that the associated sold product was added to the contract.Data type: String\n\n
\n\nsold\\_products\\_covered.​contract\n\n\n\nSys\\_id of the service contract record associated with the sold product covered.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nsold\\_products\\_covered.​entitlement\n\n\n\nSys\\_id of the entitlement record associated with the sold product covered.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nsold\\_products\\_covered.​removed\n\n\n\nDate that the associated sold product was removed from the contract.Data type: String\n\n
\n\nsold\\_products\\_covered.​service\\_line\\_contract\n\n\n\nSys\\_id of the service contract line record associated with the sold product covered.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nsold\\_products\\_covered.​sold\\_product\n\n\n\nSys\\_id of the product covered by the service contract.Data type: String\n\nTable: Sold Product \\[sn\\_install\\_base\\_sold\\_product\\]\n\n
\n\nsold\\_products\\_covered.​sys\\_created\\_by\n\n\n\nName of the user that created the sold product covered record.Data type: String\n\n
\n\nsold\\_products\\_covered.​sys\\_created\\_on\n\n\n\nDate and time that the sold product covered record was created.Data type: String\n\n
\n\nsold\\_products\\_covered.​sys\\_id\n\n\n\nSys\\_id of the product covered by this service contract.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nsold\\_products\\_covered.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the sold product covered record.Data type: String\n\n
\n\nsold\\_products\\_covered.​sys\\_updated\\_on\n\n\n\nDate and time that the sold product covered record was last updated.Data type: String\n\n
\n\nstarts\n\n\n\nDate on which the service contract begins.\n\nData type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Starts as soon as approved.\n\n
\n\nstate\n\n\n\nCurrent state of the service contract.\n\nValid values: \\(case-sensitive\\)\n\n- active\n- cancelled\n- draft\n- expired\n\nData type: String\n\n
\n\nsys\\_created\\_by\n\n\n\nName of the user that created the service contract record.Data type: String\n\n
\n\nsys\\_created\\_on\n\n\n\nDate and time that the service contract was created record.Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the service contract record.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nsys\\_updated\\_by\n\n\n\nName of the user that last updated the service contract record.Data type: String\n\n
\n\nsys\\_updated\\_on\n\n\n\nDate and time that the service contract record was last updated.Data type: String\n\n
\n\nvendor\\_contract\n\n\n\nUnique identifier for an associated external contract.\n\nData type: String\n\n
### cURL request\n\nThe following code example shows how to call this endpoint.\n\n```\ncurl \"https://instance.servicenow.com/api/sn_pss_core/servicecontract/fc73d2de89226110f877430a4e008add\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n```\n\nResponse:\n\n```\n{\n \"result\": {\n \"sys_id\": \"d8641151d1f53110f8776589fa411fde\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:27:29\",\n \"sys_updated_on\": \"2023-10-09 11:27:29\",\n \"account\": \"4c325111d1f53110f8776589fa411f3d\",\n \"consumer\": null,\n \"household\": null,\n \"number\": \"CNTR0010004\",\n \"state\": \"active\",\n \"starts\": \"2022-12-03\",\n \"ends\": \"\",\n \"short_description\": null,\n \"vendor_contract\": \"External Reference\",\n \"service_contract_lines\": [\n {\n \"sys_id\": \"d4641d91d1f53110f8776589fa411fbb\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:27:29\",\n \"sys_updated_on\": \"2023-10-09 11:27:29\",\n \"name\": \"CLI\",\n \"number\": \"CNTRL0000001\",\n \"contract\": \"d8641151d1f53110f8776589fa411fde\",\n \"parent_contract_line\": null,\n \"sold_product\": null,\n \"starts\": \"2022-12-03\",\n \"ends\": \"\",\n \"product_offering\": null,\n \"product_specification\": null,\n \"product_model\": null,\n \"child_contract_lines\": [\n {\n \"sys_id\": \"3a39ecdc01154f4ab782da0169c9c922\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:27:29\",\n \"sys_updated_on\": \"2023-10-09 11:27:29\",\n \"name\": \"Child CLI\",\n \"number\": \"CNTRL0000002\",\n \"contract\": \"d8641151d1f53110f8776589fa411fde\",\n \"parent_contract_line\": \"d4641d91d1f53110f8776589fa411fbb\",\n \"sold_product\": null,\n \"starts\": \"2022-12-03\",\n \"ends\": \"\",\n \"product_offering\": null,\n \"product_specification\": null,\n \"product_model\": null,\n \"child_contract_lines\": [],\n \"entitlements\": [\n {\n \"sys_id\": \"7439fd84c2494ba6951e58f333cfe8d4\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:27:29\",\n \"sys_updated_on\": \"2023-10-09 11:27:29\",\n \"entitlement_name\": \"Child CLI - ENTL\",\n \"account\": \"4c325111d1f53110f8776589fa411f3d\",\n \"consumer\": null,\n \"household\": null,\n \"contract\": \"d8641151d1f53110f8776589fa411fde\",\n \"service_contract_line\": \"3a39ecdc01154f4ab782da0169c9c922\",\n \"state\": \"active\",\n \"product_offering\": null,\n \"product_specification\": null,\n \"sold_entitlement\": null,\n \"product\": null,\n \"start_date\": \"2022-12-03\",\n \"end_date\": \"\",\n \"entitlement_characteristics\": [],\n \"sold_products_covered\": [],\n \"install_base_items_covered\": []\n }\n ],\n \"sold_products_covered\": [\n {\n \"sys_id\": \"dfb62e9c4c6843009be02a68f65b9118\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:27:29\",\n \"sys_updated_on\": \"2023-10-09 11:27:29\",\n \"contract\": \"d8641151d1f53110f8776589fa411fde\",\n \"service_contract_line\": \"d4641d91d1f53110f8776589fa411fbb\",\n \"entitlement\": null,\n \"sold_product\": \"ec235d9dd1b53110f8776589fa411fe2\",\n \"added\": \"2023-12-03\",\n \"removed\": \"2023-12-03\"\n }\n ],\n \"install_base_items_covered\": [\n {\n \"sys_id\": \"2583912e81964501b52a2e44d4797a28\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:27:29\",\n \"sys_updated_on\": \"2023-10-09 11:27:29\",\n \"contract\": \"d8641151d1f53110f8776589fa411fde\",\n \"service_contract_line\": \"d4641d91d1f53110f8776589fa411fbb\",\n \"entitlement\": null,\n \"install_base\": \"a1731551d1f53110f8776589fa411f8d\",\n \"added\": \"2023-12-03\",\n \"removed\": \"2023-12-03\"\n }\n ],\n \"entitlement_characteristics\": [\n {\n \"sys_id\": \"3a00c975bb49412cae169200c7f6236e\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:27:29\",\n \"sys_updated_on\": \"2023-10-09 11:27:29\",\n \"service_contract_line\": \"d4641d91d1f53110f8776589fa411fbb\",\n \"entitlement\": null,\n \"characteristic_option\": \"495149b7539e61106bfcddeeff7b1262\",\n \"value\": \"5\",\n \"characteristic\": \"63418db7539e61106bfcddeeff7b1238\",\n \"type\": \"coverage\"\n }\n ]\n }\n ],\n \"entitlements\": [\n {\n \"sys_id\": \"a8641d91d1f53110f8776589fa411fc0\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:27:29\",\n \"sys_updated_on\": \"2023-10-09 11:27:29\",\n \"entitlement_name\": \"ENTL\",\n \"account\": \"4c325111d1f53110f8776589fa411f3d\",\n \"consumer\": null,\n \"household\": null,\n \"contract\": \"d8641151d1f53110f8776589fa411fde\",\n \"service_contract_line\": \"d4641d91d1f53110f8776589fa411fbb\",\n \"state\": \"active\",\n \"product_offering\": null,\n \"product_specification\": null,\n \"sold_entitlement\": null,\n \"product\": null,\n \"start_date\": \"2022-12-03\",\n \"end_date\": \"\",\n \"sold_products_covered\": [\n {\n \"sys_id\": \"a0641d91d1f53110f8776589fa411fc2\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:27:29\",\n \"sys_updated_on\": \"2023-10-09 11:27:29\",\n \"contract\": \"d8641151d1f53110f8776589fa411fde\",\n \"service_contract_line\": \"d4641d91d1f53110f8776589fa411fbb\",\n \"entitlement\": \"a8641d91d1f53110f8776589fa411fc0\",\n \"sold_product\": \"da23d151d1f53110f8776589fa411f27\",\n \"added\": \"\",\n \"removed\": \"\"\n }\n ],\n \"install_base_items_covered\": [\n {\n \"sys_id\": \"e0641d91d1f53110f8776589fa411fc3\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:27:29\",\n \"sys_updated_on\": \"2023-10-09 11:27:29\",\n \"contract\": \"d8641151d1f53110f8776589fa411fde\",\n \"service_contract_line\": \"d4641d91d1f53110f8776589fa411fbb\",\n \"entitlement\": \"a8641d91d1f53110f8776589fa411fc0\",\n \"install_base\": \"43739151d1f53110f8776589fa411fc1\",\n \"added\": \"2023-12-03\",\n \"removed\": \"2023-12-03\"\n }\n ],\n \"entitlement_characteristics\": [\n {\n \"sys_id\": \"a8641d91d1f53110f8776589fa411fd0\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:27:29\",\n \"sys_updated_on\": \"2023-10-09 11:27:29\",\n \"service_contract_line\": null,\n \"entitlement\": \"a8641d91d1f53110f8776589fa411fc0\",\n \"characteristic_option\": \"495149b7539e61106bfcddeeff7b1262\",\n \"value\": \"5\",\n \"characteristic\": \"63418db7539e61106bfcddeeff7b1238\",\n \"type\": \"coverage_and_usage\",\n \"entitlement_usage\": [\n {\n \"sys_id\": \"a8641d91d1f53110f8776589fa411fd1\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:27:29\",\n \"sys_updated_on\": \"2023-10-09 11:27:29\",\n \"entitlement\": \"a8641d91d1f53110f8776589fa411fc0\",\n \"service_contract_line\": null,\n \"entitlement_characteristic\": \"a8641d91d1f53110f8776589fa411fd0\",\n \"period_start\": \"2022-12-03\",\n \"period_end\": \"\",\n \"total_units\": \"5\",\n \"used_units\": \"3\"\n }\n ]\n }\n ]\n }\n ],\n \"sold_products_covered\": [\n {\n \"sys_id\": \"98641d91d1f53110f8776589fa411fbc\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:27:29\",\n \"sys_updated_on\": \"2023-10-09 11:27:29\",\n \"contract\": \"d8641151d1f53110f8776589fa411fde\",\n \"service_contract_line\": \"d4641d91d1f53110f8776589fa411fbb\",\n \"entitlement\": null,\n \"sold_product\": \"ec235d9dd1b53110f8776589fa411fe2\",\n \"added\": \"2023-12-03\",\n \"removed\": \"2023-12-03\"\n }\n ],\n \"install_base_items_covered\": [\n {\n \"sys_id\": \"58641d91d1f53110f8776589fa411fbd\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:27:29\",\n \"sys_updated_on\": \"2023-10-09 11:27:29\",\n \"contract\": \"d8641151d1f53110f8776589fa411fde\",\n \"service_contract_line\": \"d4641d91d1f53110f8776589fa411fbb\",\n \"entitlement\": null,\n \"install_base\": \"a1731551d1f53110f8776589fa411f8d\",\n \"added\": \"2023-12-03\",\n \"removed\": \"2023-12-03\"\n }\n ],\n \"entitlement_characteristics\": [\n {\n \"sys_id\": \"e0641d91d1f53110f8776589fa411fbf\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:27:29\",\n \"sys_updated_on\": \"2023-10-09 11:27:29\",\n \"service_contract_line\": \"d4641d91d1f53110f8776589fa411fbb\",\n \"entitlement\": null,\n \"characteristic_option\": \"495149b7539e61106bfcddeeff7b1262\",\n \"value\": \"5\",\n \"characteristic\": \"63418db7539e61106bfcddeeff7b1238\",\n \"type\": \"coverage\"\n }\n ]\n },\n {\n \"sys_id\": \"e4641d91d1f53110f8776589fa411fd2\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:27:29\",\n \"sys_updated_on\": \"2023-10-09 11:27:29\",\n \"name\": \"CLI 2\",\n \"number\": \"CNTRL0000003”,\n \"contract\": \"d8641151d1f53110f8776589fa411fde\",\n \"parent_contract_line\": null,\n \"sold_product\": null,\n \"starts\": \"2022-12-03\",\n \"ends\": \"\",\n \"product_offering\": null,\n \"product_specification\": null,\n \"product_model\": null,\n \"child_contract_lines\": [],\n \"entitlements\": [],\n \"sold_products_covered\": [\n {\n \"sys_id\": \"e8641d91d1f53110f8776589fa411fd3\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:27:29\",\n \"sys_updated_on\": \"2023-10-09 11:27:29\",\n \"contract\": \"d8641151d1f53110f8776589fa411fde\",\n \"service_contract_line\": \"e4641d91d1f53110f8776589fa411fd2\",\n \"entitlement\": null,\n \"sold_product\": \"7f23995dd1b53110f8776589fa411f66\",\n \"added\": \"2023-12-03\",\n \"removed\": \"2023-12-03\"\n }\n ],\n \"install_base_items_covered\": [\n {\n \"sys_id\": \"a8641d91d1f53110f8776589fa411fd4\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:27:29\",\n \"sys_updated_on\": \"2023-10-09 11:27:29\",\n \"contract\": \"d8641151d1f53110f8776589fa411fde\",\n \"service_contract_line\": \"e4641d91d1f53110f8776589fa411fd2\",\n \"entitlement\": null,\n \"install_base\": \"a483d951d1f53110f8776589fa411fad\",\n \"added\": \"2023-12-03\",\n \"removed\": \"2023-12-03\"\n }\n ],\n \"entitlement_characteristics\": [\n {\n \"sys_id\": \"a8641d91d1f53110f8776589fa411fd5\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:27:29\",\n \"sys_updated_on\": \"2023-10-09 11:27:29\",\n \"service_contract_line\": \"e4641d91d1f53110f8776589fa411fd2\",\n \"entitlement\": null,\n \"characteristic_option\": \"495149b7539e61106bfcddeeff7b1262\",\n \"value\": \"5\",\n \"characteristic\": \"63418db7539e61106bfcddeeff7b1238\",\n \"type\": \"coverage\"\n }\n ]\n }\n ],\n \"sold_products_covered\": [\n {\n \"sys_id\": \"9c641d91d1f53110f8776589fa411fb9\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:27:29\",\n \"sys_updated_on\": \"2023-10-09 11:27:29\",\n \"contract\": \"d8641151d1f53110f8776589fa411fde\",\n \"service_contract_line\": null,\n \"entitlement\": null,\n \"sold_product\": \"0df21151d1f53110f8776589fa411f1b\",\n \"added\": \"2023-12-03\",\n \"removed\": \"2023-12-03\"\n }\n ],\n \"install_base_items_covered\": [\n {\n \"sys_id\": \"d8641d91d1f53110f8776589fa411fba\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:27:29\",\n \"sys_updated_on\": \"2023-10-09 11:27:29\",\n \"contract\": \"d8641151d1f53110f8776589fa411fde\",\n \"service_contract_line\": null,\n \"entitlement\": null,\n \"install_base\": \"e2639951d1f53110f8776589fa411f2b\",\n \"added\": \"2023-12-03\",\n \"removed\": \"2023-12-03\"\n }\n ]\n }\n}\n```\n\n## Service Contract - GET /sn\\_pss\\_core/servicecontract/contractline/\\{id\\}\n\nRetrieves the details of a specified service contract line record and its related entities.\n\nThis endpoint retrieves data in the following tables when processing the request:\n\n- Characteristic \\[sn\\_pss\\_core\\_entitlement\\_characteristic\\]\n- Entitlement \\[service\\_entitlement\\]\n- Entitlement Usage \\[sn\\_pss\\_core\\_entitlement\\_usage\\]\n- Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\] - This table contains information for both sold products covered and install base items covered.\n- Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n### URL format\n\nVersioned URL: `/api/sn_pss_core/{api_version}/servicecontract/contractline/{id}`\n\nDefault URL: `/api/sn_pss_core/servicecontract/contractline/{id}`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. 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\n\n
\n\nid\n\n\n\nSys\\_id of the service contract line record to retrieve.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n
\n\nName\n\n\n\nDescription\n\n
\n\ndisplay\\_value\n\n\n\nType of data to return.Valid values:\n\n- false: Return the `value` for all fields. For example, `\"state\":\"draft\"`.\n- true: Return the `display_value` for all fields. For example, `\"state\":\"Draft\"`\n- all: Return all information for all fields.\n\nData type: String\n\nDefault: false\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|200|Successful. The request was successfully processed.|\n|400|Bad Request. A bad request type or malformed request was detected.|\n|403|Forbidden. The user doesn't have permission to access the API.|\n|404|Not found. The requested item wasn't found.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nchild\\_contract\\_lines\n\n\n\nList of child service contract lines associated with the service contract line.Data type: Array of Objects\n\n```\n\"child_contract_lines\": [\n {\n \"child_contract_lines\": [Array],\n \"contract\": \"String\",\n \"ends\": \"String\",\n \"entitlements\": [Array],\n \"entitlement_characteristics\": [Array],\n \"install_base_items_covered\": [Array],\n \"name\": \"String\",\n \"number\": \"String\",\n \"parent_contract_line\": \"String\",\n \"product_model\": \"String\",\n \"product_offering\": \"String\",\n \"product_specification\": \"String\",\n \"sold_product\": \"String\",\n \"sold_products_covered\": [Array],\n \"starts\": \"String\",\n \"state\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_update_on\": \"String\"\n }\n]\n```\n\n
\n\nchild\\_contract\\_lines.​child\\_contract\\_lines\n\n\n\nList of child service contract line objects created under the child service contract line. The objects in this array have the same elements as the objects in the **child\\_contract\\_lines** parameter.Data type: Array of Objects\n\n
\n\nchild\\_contract\\_lines.​contract\n\n\n\nSys\\_id of the service contract associated with the child service contract line.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nchild\\_contract\\_lines.​ends\n\n\n\nDate on which the child service contract line ends.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Never ends until manually removed.\n\n
\n\nchild\\_contract\\_lines.​entitlements\n\n\n\nList of entitlements associated with the child service contract line.Data type: Array of Objects\n\n```\n\"entitlements\": [\n {\n \"account\": \"String\",\n \"consumer\": \"String\",\n \"contract\": \"String\",\n \"end_date\": \"String\",\n \"entitlement_characteristics\": [Array],\n \"entitlement_name\": \"String\",\n \"household\": \"String\",\n \"install_base_items_covered\": [Array],\n \"product\": \"String\",\n \"product_offering\": \"String\",\n \"product_specification\": \"String\",\n \"service_contract_line\": \"String\",\n \"sold_entitlement\": \"String\",\n \"sold_products_covered\": [Array],\n \"start_date\": \"String\",\n \"state\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\"\n }\n]\n```\n\n
\n\nchild\\_contract\\_lines.​entitlements.​account\n\n\n\nSys\\_id of the account record to which the entitlement belongs.\n\nData type: String\n\nTable: Account \\[customer\\_account\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​consumer\n\n\n\nSys\\_id of the consumer record to which the entitlement belongs.\n\nData type: String\n\nTable: Consumer \\[csm\\_consumer\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​contract\n\n\n\nSys\\_id of the contract record to which the entitlement belongs.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​end\\_date\n\n\n\nEnd date of the entitlement.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Never ends until manually removed.\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_characteristics\n\n\n\nList of characteristics associated with the entitlement.Data type: Array of Objects\n\n```\n\"entitlement_characteristics\": [\n {\n \"characteristic\": \"String\",\n \"characteristic_option\": \"String\",\n \"entitlement\": \"String\",\n \"entitlement_usage\": [Array],\n \"service_contract_line\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\"\n \"type\": \"String\",\n \"value\": \"String\"\n }\n]\n```\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​characteristic\n\n\n\nSys\\_id of the characteristic record associated with the entitlement.\n\nData type: String\n\nTable: Characteristic \\[sn\\_prd\\_pm\\_characteristic\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​characteristic\\_option\n\n\n\nSys\\_id of the characteristic option record associated with the entitlement.Data type: String\n\nTable: Characteristic Option \\[sn\\_prd\\_pm\\_characteristic\\_option\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\n\n\n\nSys\\_id of the entitlement record.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage\n\n\n\nList of entitlement usages associated with the entitlement characteristic.Data type: Array of Objects\n\n```\n\"entitlement_usage\": [\n {\n \"entitlement\": \"String\",\n \"entitlement_characteristic\": \"String\",\n \"period_end\": \"String\",\n \"period_start\": \"String\",\n \"service_contract_line\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\",\n \"total_units\": \"String\",\n \"used_units\": \"String\"\n }\n]\n```\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​entitlement\n\n\n\nSys\\_id of the entitlement record associated with the entitlement usage.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​entitlement\\_characteristic\n\n\n\nSys\\_id of the entitlement characteristic record associated with the entitlement usage.Data type: String\n\nTable: Characteristic \\[sn\\_pss\\_core\\_entitlement\\_characteristic\\]\n\n
\n\ncchild\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​period\\_end\n\n\n\nEnd date when the entitlement usage is no longer tracked.Data type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​period\\_start\n\n\n\nStarting date of when the entitlement usage is tracked.Data type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​service\\_contract\\_line\n\n\n\nSys\\_id of the service contract line to which the current entitlement usage belongs. Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_created\\_by\n\n\n\nName of the user that created the entitlement usage record.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_created\\_on\n\n\n\nDate and time that the entitlement usage record was created.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_id\n\n\n\nSys\\_id of the entitlement usage record.Data type: String\n\nTable: Entitlement Usage \\[sn\\_pss\\_core\\_entitlement\\_usage\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the entitlement usage record.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_updated\\_on\n\n\n\nDate and time that the entitlement usage record was last updated.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​total\\_units\n\n\n\nTotal coverage value of the associated entitlement characteristic.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​used\\_units\n\n\n\nNumber of units used by the account or consumer between the **period\\_start** and the **period\\_end**.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​type\n\n\n\nType of entitlement characteristic. Valid values:\n\n- coverage\n- coverage\\_and\\_usage\n\nData type: String\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​value\n\n\n\nValue of the characteristic.\n\nData type: String\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_name\n\n\n\nName of the entitlement.\n\nData type: String\n\n
\n\nchild\\_contract\\_lines.​entitlements.​household\n\n\n\nSys\\_id of the household record associated with the entitlement.\n\nData type: String\n\nTable: Household \\[csm\\_household\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered\n\n\n\nList of install base items covered under the  child service contract line.Data type: Array of Objects\n\n```\n \"install_base_items_covered\": [ \n {\n \"added\": \"String\",\n \"contract\": \"String\",\n \"entitlement\": \"String\",\n \"install_base\": \"String\",\n \"removed\": \"String\",\n \"service_contract_line\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\"\n }\n]\n```\n\nTable: Sold Product Covered  \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​added\n\n\n\nDate that the associated install base item was added to the service contract line.\n\nData type: String\n\n Format: yyyy-mm-dd\n\n
\n\nchild\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​contract\n\n\n\nSys\\_id of the service contract record associated with the install base item.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​entitlement\n\n\n\nSys\\_id of the entitlement record associated with the install base item.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​install\\_base\n\n\n\nSys\\_id of the associated install base item record.Data type: String\n\nTable: Install Base Item \\[sn\\_install\\_base\\_item\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​removed\n\n\n\nDate that the associated service contract line ends coverage of the install base item.\n\nData type: String\n\n Format: yyyy-mm-dd\n\n
\n\nchild\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​service\\_contract\\_line\n\n\n\nSys\\_id of the associated service contract line record.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​sys\\_created\\_by\n\n\n\nName of the user that created the install base item record.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​sys\\_created\\_on\n\n\n\nDate and time that the install base item record was created.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​sys\\_id\n\n\n\nSys\\_id of the install base item covered.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the install base item record.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​sys\\_updated\\_on\n\n\n\nDate and time that the install base item record was last updated.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlements.​product\n\n\n\nSys\\_id of the product model record associated with the entitlement.Data type: String\n\nTable: Product Model \\[cmdb\\_model\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​product\\_offering\n\n\n\nSys\\_id of the product offering record associated with the entitlement.Data type: String\n\nTable: Product Offering \\[sn\\_prd\\_pm\\_product\\_offering\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​product\\_specification\n\n\n\nSys\\_id of the product specification record associated with the entitlement.Data type: String\n\nTable: Product Specification \\[sn\\_prd\\_pm\\_product\\_specification\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​service\\_contract\\_line\n\n\n\nSys\\_id of the service contract line record associated with the entitlement.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​sold\\_entitlement\n\n\n\nSys\\_id of the sold product record associated with the entitlement.Data type: String\n\nTable: Sold Product \\[sn\\_install\\_base\\_sold\\_product\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​sold\\_products\\_covered\n\n\n\nList of products covered.Data type: Array of Objects\n\n```\n\"sold_products_covered\": [ \n {\n \"added\": \"String\",\n \"contract\": \"String\",\n \"entitlement\": \"String\",\n \"removed\": \"String\",\n \"service_contract_line\": \"String\",\n \"sold_product\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\"\n }\n]\n```\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​added\n\n\n\nDate that the associated service contract starts to cover the product.\n\nData type: String\n\n Format: yyyy-mm-dd\n\n Default: Current date\n\n
\n\nchild\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​contract\n\n\n\nSys\\_id of the service contract record associated with the sold product covered.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​entitlement\n\n\n\nSys\\_id of the entitlement record associated with the sold product covered.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​removed\n\n\n\nDate that the associated service contract ends coverage of the associated product.\n\nData type: String\n\n Format: yyyy-mm-dd\n\n Default: No end date\n\n
\n\nchild\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​service\\_contract\\_line\n\n\n\nSys\\_id of the service contract line record associated with the sold product covered.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​sold\\_product\n\n\n\nSys\\_id of the product covered by the service contract.Data type: String\n\nTable: Sold Product \\[sn\\_install\\_base\\_sold\\_product\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​sold\\_products\\_covered​sys\\_created\\_by\n\n\n\nName of the user that created the sold product covered record.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​sys\\_created\\_on\n\n\n\nDate and time that the sold product covered record was created.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​sys\\_id\n\n\n\nSys\\_id of the product covered by this service contract.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the sold product covered record.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​sys\\_updated\\_on\n\n\n\nName of the user that last updated the sold product covered record.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlements.​start\\_date\n\n\n\nStart date of the entitlement.\n\nData type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nchild\\_contract\\_lines.​entitlements.​state\n\n\n\nCurrent state of the entitlement.\n\nValid values: \\(case-sensitive\\)\n\n- active\n- cancelled\n- draft\n- expired\n- suspended\n\nData type: String\n\n
\n\nchild\\_contract\\_lines.​entitlements.​sys\\_created\\_by\n\n\n\nName of the user that created the entitlement record.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlements.​sys\\_created\\_on\n\n\n\nDate and time that the entitlement record was created.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlements.​sys\\_id\n\n\n\nSys\\_id of the associated entitlement record.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the entitlement record.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlements.​sys\\_updated\\_on\n\n\n\nDate and time that the entitlement record was created.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics\n\n\n\nList of characteristics associated with the entitlement.Data type: Array of Objects\n\n```\n\"entitlement_characteristics\": [\n {\n \"characteristic\": \"String\",\n \"characteristic_option\": \"String\",\n \"entitlement\": \"String\",\n \"entitlement_usage\": [Array],\n \"service_contract_line\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\"\n \"type\": \"String\",\n \"value\": \"String\"\n }\n]\n```\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​characteristic\n\n\n\nSys\\_id of the characteristic record associated with the entitlement.\n\nData type: String\n\nTable: Characteristic \\[sn\\_prd\\_pm\\_characteristic\\]\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​characteristic\\_option\n\n\n\nSys\\_id of the characteristic option record associated with the entitlement.Data type: String\n\nTable: Characteristic Option \\[sn\\_prd\\_pm\\_characteristic\\_option\\]\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\n\n\n\nSys\\_id of the entitlement record.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage\n\n\n\nList of entitlement usages associated with the entitlement characteristic.Data type: Array of Objects\n\n```\n\"entitlement_usage\": [\n {\n \"entitlement\": \"String\",\n \"entitlement_characteristic\": \"String\",\n \"period_end\": \"String\",\n \"period_start\": \"String\",\n \"service_contract_line\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\",\n \"total_units\": \"String\",\n \"used_units\": \"String\"\n }\n]\n```\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage.​entitlement\n\n\n\nSys\\_id of the entitlement record associated with the entitlement usage.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage.​entitlement\\_characteristic\n\n\n\nSys\\_id of the entitlement characteristic record associated with the entitlement usage.Data type: String\n\nTable: Characteristic \\[sn\\_pss\\_core\\_entitlement\\_characteristic\\]\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage.​period\\_end\n\n\n\nEnd date when the entitlement usage is no longer tracked.Data type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage.​period\\_start\n\n\n\nStarting date of when the entitlement usage is tracked.Data type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage.​service\\_contract\\_line\n\n\n\nSys\\_id of the service contract line to which the current entitlement usage belongs. Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_created\\_by\n\n\n\nName of the user that created the entitlement usage record.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_created\\_on\n\n\n\nDate and time that the entitlement usage record was created.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_id\n\n\n\nSys\\_id of the entitlement usage record.Data type: String\n\nTable: Entitlement Usage \\[sn\\_pss\\_core\\_entitlement\\_usage\\]\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the entitlement usage record.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_updated\\_on\n\n\n\nDate and time that the entitlement usage record was last updated.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage.​total\\_units\n\n\n\nTotal coverage value of the associated entitlement characteristic.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage.​used\\_units\n\n\n\nNumber of units used by the account or consumer between the **period\\_start** and the **period\\_end**.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​service\\_contract\\_line\n\n\n\nSys\\_id of the service contract line record associated with the entitlement characteristic.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​sys\\_created\\_by\n\n\n\nName of the user that created the entitlement characteristics record.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​sys\\_created\\_on\n\n\n\nDate and time that the entitlement characteristics record was created.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​sys\\_id\n\n\n\nSys\\_id of the entitlement characteristics record.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the entitlement characteristics record.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​sys\\_updated\\_on\n\n\n\nDate and time that the entitlement characteristics record was last updated.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​type\n\n\n\nType of entitlement characteristic. Valid values:\n\n- coverage\n- coverage\\_and\\_usage\n\nData type: String\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​value\n\n\n\nValue of the characteristic.\n\nData type: String\n\n
\n\nchild\\_contract\\_lines.​install\\_base\\_items\\_covered\n\n\n\nList of install base items covered under the  child service contract line.Data type: Array of Objects\n\n```\n \"install_base_items_covered\": [ \n {\n \"added\": \"String\",\n \"contract\": \"String\",\n \"entitlement\": \"String\",\n \"install_base\": \"String\",\n \"removed\": \"String\",\n \"service_contract_line\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\"\n }\n]\n```\n\nTable: Sold Product Covered  \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nchild\\_contract\\_lines.​install\\_base\\_items\\_covered.​added\n\n\n\nDate that the associated install base item was added to the service contract line.\n\nData type: String\n\n Format: yyyy-mm-dd\n\n
\n\nchild\\_contract\\_lines.​install\\_base\\_items\\_covered.​contract\n\n\n\nSys\\_id of the service contract record associated with the install base item.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nchild\\_contract\\_lines.​install\\_base\\_items\\_covered.​entitlement\n\n\n\nSys\\_id of the entitlement record associated with the install base item.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nchild\\_contract\\_lines.​install\\_base\\_items\\_covered.​install\\_base\n\n\n\nSys\\_id of the associated install base item record.Data type: String\n\nTable: Install Base Item \\[sn\\_install\\_base\\_item\\]\n\n
\n\nchild\\_contract\\_lines.​install\\_base\\_items\\_covered.​removed\n\n\n\nDate that the associated service contract line ends coverage of the install base item.\n\nData type: String\n\n Format: yyyy-mm-dd\n\n
\n\nchild\\_contract\\_lines.​install\\_base\\_items\\_covered.​service\\_contract\\_line\n\n\n\nSys\\_id of the associated service contract line record.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nchild\\_contract\\_lines.​install\\_base\\_items\\_covered.​sys\\_created\\_by\n\n\n\nName of the user that created the install base item record.Data type: String\n\n
\n\nchild\\_contract\\_lines.​install\\_base\\_items\\_covered.​sys\\_created\\_on\n\n\n\nDate and time that the install base item record was created.Data type: String\n\n
\n\nchild\\_contract\\_lines.​install\\_base\\_items\\_covered.​sys\\_id\n\n\n\nSys\\_id of the install base item covered.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nchild\\_contract\\_lines.​install\\_base\\_items\\_covered.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the install base item record.Data type: String\n\n
\n\nchild\\_contract\\_lines.​install\\_base\\_items\\_covered.​sys\\_updated\\_on\n\n\n\nDate and time that the install base item record was last updated.Data type: String\n\n
\n\nchild\\_contract\\_lines.​name\n\n\n\nName of the child service contract line.Data type: String\n\n
\n\nchild\\_contract\\_lines.​number\n\n\n\nUnique number of the service contract line. Automatically generated by the endpoint. For example: CTRL000001.Data type: String\n\n
\n\nchild\\_contract\\_lines.​parent\\_contract\\_line\n\n\n\nSys\\_id of the parent contract line record associated with the child service contract line.Data type: String\n\n
\n\nchild\\_contract\\_lines.​product\\_model\n\n\n\nSys\\_id of the product associated with the child service contract line.Data type: String\n\nTable: Product Model \\[cmdb\\_model\\]\n\n
\n\nchild\\_contract\\_lines.​product\\_offering\n\n\n\nSys\\_id of the product offering record associated with the child service contract line.Data type: String\n\nTable: Product Offering \\[sn\\_prd\\_pm\\_product\\_offering\\]\n\n
\n\nchild\\_contract\\_lines.​product\\_specification\n\n\n\nSys\\_id of the product specification record associated with the child service contract line.Data type: String\n\nTable: Product Specification \\[sn\\_prd\\_pm\\_product\\_specification\\]\n\n
\n\nchild\\_contract\\_lines.​sold\\_product\n\n\n\nSys\\_id of the sold product record associated with the child service contract line.Data type: String\n\nTable: Sold Product \\[sn\\_install\\_base\\_sold\\_product\\]\n\n
\n\nchild\\_contract\\_lines.​sold\\_products\\_covered\n\n\n\nList of products covered.Data type: Array of Objects\n\n```\n\"sold_products_covered\": [ \n {\n \"added\": \"String\",\n \"contract\": \"String\",\n \"entitlement\": \"String\",\n \"removed\": \"String\",\n \"service_contract_line\": \"String\",\n \"sold_product\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\"\n }\n]\n```\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nchild\\_contract\\_lines.​sold\\_products\\_covered.​added\n\n\n\nDate that the associated service contract starts to cover the product.\n\nData type: String\n\n Format: yyyy-mm-dd\n\n Default: Current date\n\n
\n\nchild\\_contract\\_lines.​sold\\_products\\_covered.​contract\n\n\n\nSys\\_id of the service contract record associated with the sold product covered.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nchild\\_contract\\_lines.​sold\\_products\\_covered.​entitlement\n\n\n\nSys\\_id of the entitlement record associated with the sold product covered.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nchild\\_contract\\_lines.​sold\\_products\\_covered.​removed\n\n\n\nDate that the associated service contract ends coverage of the associated product.\n\nData type: String\n\n Format: yyyy-mm-dd\n\n Default: No end date\n\n
\n\nchild\\_contract\\_lines.​sold\\_products\\_covered.​service\\_contract\\_line\n\n\n\nSys\\_id of the service contract line record associated with the sold product covered.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nchild\\_contract\\_lines.​sold\\_products\\_covered.​sold\\_product\n\n\n\nSys\\_id of the product covered by the service contract.Data type: String\n\nTable: Sold Product \\[sn\\_install\\_base\\_sold\\_product\\]\n\n
\n\nchild\\_contract\\_lines.​sold\\_products\\_covered.​sys\\_created\\_by\n\n\n\nName of the user that created the sold product covered record.Data type: String\n\n
\n\nchild\\_contract\\_lines.​sold\\_products\\_covered.​sys\\_created\\_on\n\n\n\nDate and time that the sold product covered record was created.Data type: String\n\n
\n\nchild\\_contract\\_lines.​sold\\_products\\_covered.​sys\\_id\n\n\n\nSys\\_id of the product covered by this service contract.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nchild\\_contract\\_lines.​sold\\_products\\_covered.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the sold product covered record.Data type: String\n\n
\n\nchild\\_contract\\_lines.​sold\\_products\\_covered.​sys\\_updated\\_on\n\n\n\nName of the user that last updated the sold product covered record.Data type: String\n\n
\n\nchild\\_contract\\_lines.​starts\n\n\n\nStart date of the child service contract line.Data type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nchild\\_contract\\_lines.​state\n\n\n\nCurrent state of the contract line.\n\nValid values: \\(case-sensitive\\)\n\n- active\n- cancelled\n- draft\n- expired\n- suspended\n\nData type: String\n\n
\n\nchild\\_contract\\_lines.​sys\\_created\\_by\n\n\n\nName of the user that created the child service contract line record.Data type: String\n\n
\n\nchild\\_contract\\_lines.​sys\\_created\\_on\n\n\n\nDate and time that the child service contract line record was created.Data type: String\n\n
\n\nchild\\_contract\\_lines.​sys\\_id\n\n\n\nSys\\_id of a child service contract line record.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nchild\\_contract\\_lines.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the child service contract line record.Data type: String\n\n
\n\nchild\\_contract\\_lines.​sys\\_updated\\_on\n\n\n\nDate and time that the child service contract line record was last updated.Data type: String\n\n
\n\ncontract\n\n\n\nSys\\_id of the service contract associated with the service contract line.\n\nData type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nends\n\n\n\nDate on which the service contract line ends.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Never ends until manually removed.\n\n
\n\nentitlements\n\n\n\nList of entitlements associated with the service contract line.Data type: Array of Objects\n\n```\n\"entitlements\": [\n {\n \"account\": \"String\",\n \"consumer\": \"String\",\n \"contract\": \"String\",\n \"end_date\": \"String\",\n \"entitlement_characteristics\": [Array],\n \"entitlement_name\": \"String\",\n \"household\": \"String\",\n \"install_base_items_covered\": [Array],\n \"product\": \"String\",\n \"product_offering\": \"String\",\n \"product_specification\": \"String\",\n \"service_contract_line\": \"String\",\n \"sold_entitlement\": \"String\",\n \"sold_products_covered\": [Array],\n \"start_date\": \"String\",\n \"state\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\"\n }\n]\n```\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nentitlements.​account\n\n\n\nSys\\_id of the account record to which the entitlement belongs.\n\nData type: String\n\nTable: Account \\[customer\\_account\\]\n\n
\n\nentitlements.​consumer\n\n\n\nSys\\_id of the consumer record to which the entitlement belongs.\n\nData type: String\n\nTable: Consumer \\[csm\\_consumer\\]\n\n
\n\nentitlements.​contract\n\n\n\nSys\\_id of the contract record to which the entitlement belongs.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nentitlements.​end\\_date\n\n\n\nEnd date of the entitlement.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Never ends until manually removed.\n\n
\n\nentitlements.​entitlement\\_characteristics\n\n\n\nList of characteristics associated with the entitlement.Data type: Array of Objects\n\n```\n\"entitlement_characteristics\": [\n {\n \"characteristic\": \"String\",\n \"characteristic_option\": \"String\",\n \"entitlement\": \"String\",\n \"entitlement_usage\": [Array],\n \"service_contract_line\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\",\n \"type\": \"String\",\n \"value\": \"String\"\n }\n]\n```\n\nTable: Characteristic \\[sn\\_pss\\_core\\_entitlement\\_characteristic\\]\n\n
\n\nentitlements.​entitlement\\_characteristics.characteristic\n\n\n\nSys\\_id of the characteristic record associated with the entitlement.\n\nData type: String\n\nTable: Characteristic \\[sn\\_prd\\_pm\\_characteristic\\]\n\n
\n\nentitlements.​entitlement\\_characteristics.characteristic\\_option\n\n\n\nSys\\_id of the characteristic option record associated with the entitlement.Data type: String\n\nTable: Characteristic Option \\[sn\\_prd\\_pm\\_characteristic\\_option\\]\n\n
\n\nentitlements.​entitlement\\_characteristics.​entitlement\n\n\n\nSys\\_id of the associated entitlement record.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nentitlements.​entitlement\\_characteristics.​entitlement\\_usage\n\n\n\nEntitlement usage details.Data type: Array of Objects\n\n```\n\"entitlement_usage\": [\n {\n \"entitlement\": \"String\",\n \"entitlement_characteristic\": [Array],\n \"period_end\": \"String\",\n \"period_start\": \"String\",\n \"service_contract_line\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\",\n \"total_units\": \"String\",\n \"used_units\": \"String\"\n }\n]\n```\n\n
\n\nentitlements.​entitlement\\_characteristics.​entitlement\\_usage.​entitlement\n\n\n\nSys\\_id of the entitlement record associated with the entitlement usage.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nentitlements.​entitlement\\_characteristics.​entitlement\\_usage.​entitlement\\_characteristic\n\n\n\nSys\\_id of the entitlement characteristic record associated with the entitlement usage.Data type: String\n\nTable: Characteristic \\[sn\\_pss\\_core\\_entitlement\\_characteristic\\]\n\n
\n\nentitlements.​entitlement\\_characteristics.​entitlement\\_usage.​period\\_end\n\n\n\nEnd date when the entitlement usage is no longer tracked.Data type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nentitlements.​entitlement\\_characteristics.​entitlement\\_usage.​period\\_start\n\n\n\nStarting date of when the entitlement usage is tracked.Data type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nentitlements.​entitlement\\_characteristics.​entitlement\\_usage.​service\\_contract\\_line\n\n\n\nService contract line to which the current entitlement usage belongs. Data type: String\n\n
\n\nentitlements.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_created\\_by\n\n\n\nName of the user that created the entitlement usage record.Data type: String\n\n
\n\nentitlements.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_created\\_on\n\n\n\nDate and time that the entitlement usage record was created.Data type: String\n\n
\n\nentitlements.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_id\n\n\n\nSys\\_id of the entitlement usage record.Data type: String\n\nTable: Entitlement Usage \\[sn\\_pss\\_core\\_entitlement\\_usage\\]\n\n
\n\nentitlements.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the entitlement usage record.Data type: String\n\n
\n\nentitlements.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_updated\\_on\n\n\n\nDate and time that the entitlement usage record was last updated.Data type: String\n\n
\n\nentitlements.​entitlement\\_characteristics.​entitlement\\_usage.​total\\_units\n\n\n\nTotal coverage value of the associated entitlement characteristic.Data type: String\n\n
\n\nentitlements.​entitlement\\_characteristics.​entitlement\\_usage.​used\\_units\n\n\n\nNumber of units used by the account or consumer between the **period\\_start** and the **period\\_end**.Data type: String\n\n
\n\nentitlements.​entitlement\\_characteristics.​service\\_contract\\_line\n\n\n\nSys\\_id of the service contract line record associated with the entitlement characteristic.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nentitlements.​entitlement\\_characteristics.​sys\\_created\\_by\n\n\n\nName of the user that created the entitlement characteristics record.Data type: String\n\n
\n\nentitlements.​entitlement\\_characteristics.​sys\\_created\\_on\n\n\n\nDate and time that the entitlement characteristics record was created.Data type: String\n\n
\n\nentitlements.​entitlement\\_characteristics.​sys\\_id\n\n\n\nSys\\_id of the entitlement characteristics record.Data type: String\n\n
\n\nentitlements.​entitlement\\_characteristics.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the entitlement characteristics record.Data type: String\n\n
\n\nentitlements.​entitlement\\_characteristics.​sys\\_updated\\_on\n\n\n\nDate and time that the entitlement characteristics record was last updated.Data type: String\n\n
\n\nentitlements.​entitlement\\_characteristics.type\n\n\n\nType of entitlement characteristic. Valid values:\n\n- coverage\n- coverage\\_and\\_usage\n\nData type: String\n\n
\n\nentitlements.​entitlement\\_characteristics.value\n\n\n\nValue of the characteristic.\n\nData type: String\n\n
\n\nentitlements.​entitlement\\_name\n\n\n\nName of the entitlement.\n\nData type: String\n\n
\n\nentitlements.​household\n\n\n\nSys\\_id of the household record associated with the entitlement.\n\nData type: String\n\nTable: Household \\[csm\\_household\\]\n\n
\n\nentitlements.​install\\_base\\_items\\_covered\n\n\n\nList of install base items covered under the service contract line.Data type: Array of Objects\n\n```\n\"install_base_items_covered\": [ \n {\n \"added\": \"String\",\n \"contract\": \"String\",\n \"entitlement\": \"String\",\n \"install_base\": \"String\",\n \"removed\": \"String\",\n \"service_contract_line\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\"\n }\n]\n```\n\n
\n\nentitlements.​install\\_base\\_items\\_covered.​added\n\n\n\nDate that the associated install base item was added to the entitlement.Data type: String\n\n
\n\nentitlements.​install\\_base\\_items\\_covered.​contract\n\n\n\nSys\\_id of the service contract record associated with the install base item.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nentitlements.​install\\_base\\_items\\_covered.​entitlement\n\n\n\nSys\\_id of the entitlement record associated with the install base item.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nentitlements.​install\\_base\\_items\\_covered.​install\\_base\n\n\n\nSys\\_id of the associated install base item record.Data type: String\n\nTable: Install Base Item \\[sn\\_install\\_base\\_item\\]\n\n
\n\nentitlements.​install\\_base\\_items\\_covered.​removed\n\n\n\nDate that the associated install base item was removed from the entitlement.Data type: String\n\n
\n\nentitlements.​install\\_base\\_items\\_covered.​service\\_contract\\_line\n\n\n\nSys\\_id of the associated service contract line record.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nentitlements.​install\\_base\\_items\\_covered.​sys\\_created\\_by\n\n\n\nName of the user that created the install base item record.Data type: String\n\n
\n\nentitlements.​install\\_base\\_items\\_covered.​sys\\_created\\_on\n\n\n\nDate and time that the install base item record was created.Data type: String\n\n
\n\nentitlements.​install\\_base\\_items\\_covered.​sys\\_id\n\n\n\nSys\\_id of the install base item covered.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nentitlements.​install\\_base\\_items\\_covered.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the install base item record.Data type: String\n\n
\n\nentitlements.​install\\_base\\_items\\_covered.​sys\\_updated\\_on\n\n\n\nDate and time that the install base item record was last updated.Data type: String\n\n
\n\nentitlements.​product\n\n\n\nSys\\_id of the product model record associated with the entitlement.Data type: String\n\nTable: Product Model \\[cmdb\\_model\\]\n\n
\n\nentitlements.​product\\_offering\n\n\n\nSys\\_id of the product offering record associated with the entitlement.Data type: String\n\nTable: Product Offering \\[sn\\_prd\\_pm\\_product\\_offering\\]\n\n
\n\nentitlements.​product\\_specification\n\n\n\nSys\\_id of the product specification record associated with the entitlement.Data type: String\n\nTable: Product Specification \\[sn\\_prd\\_pm\\_product\\_specification\\]\n\n
\n\nentitlements.​service\\_contract\\_line\n\n\n\nSys\\_id of the service contract line record associated with the entitlement.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nentitlements.​sold\\_entitlement\n\n\n\nSys\\_id of the sold product record associated with the entitlement.Data type: String\n\nTable: Sold Product \\[sn\\_install\\_base\\_sold\\_product\\]\n\n
\n\nentitlements.​sold\\_products\\_covered\n\n\n\nList of products covered.Data type: Array of Objects\n\n```\n\"sold_products_covered\": [ \n {\n \"added\": \"String\",\n \"contract\": \"String\",\n \"entitlement\": \"String\",\n \"removed\": \"String\",\n \"service_contract_line\": \"String\",\n \"sold_product\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\"\n }\n]\n```\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nentitlements.​sold\\_products\\_covered.​added\n\n\n\nDate that the associated sold product was added to the entitlement.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Current date\n\n
\n\nentitlements.​sold\\_products\\_covered.​contract\n\n\n\nSys\\_id of the service contract record associated with the sold product covered.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nentitlements.​sold\\_products\\_covered.​entitlement\n\n\n\nSys\\_id of the entitlement record associated with the sold product covered.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nentitlements.​sold\\_products\\_covered.removed\n\n\n\nDate that the associated sold product was removed from the entitlement.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: No end date\n\n
\n\nentitlements.​sold\\_products\\_covered.​service\\_contract\\_line\n\n\n\nSys\\_id of the service contract line record associated with the sold product covered.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nentitlements.​sold\\_products\\_covered.​sold\\_product\n\n\n\nSys\\_id of the product covered by the entitlement.Data type: String\n\nTable: Sold Product \\[sn\\_install\\_base\\_sold\\_product\\]\n\n
\n\nentitlements.​sold\\_products\\_covered.​sys\\_created\\_by\n\n\n\nName of the user that created the sold product covered record.Data type: String\n\n
\n\nentitlements.​sold\\_products\\_covered.​sys\\_created\\_on\n\n\n\nDate and time that the sold product covered record was created.Data type: String\n\n
\n\nentitlements.​sold\\_products\\_covered.​sys\\_id\n\n\n\nSys\\_id of the product covered by this service contract.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nentitlements.​sold\\_products\\_covered.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the sold product covered record.Data type: String\n\n
\n\nentitlements.​sold\\_products\\_covered.​sys\\_updated\\_on\n\n\n\nDate and time that the sold product covered record was last updated.Data type: String\n\n
\n\nentitlements.​start\\_date\n\n\n\nStart date of the entitlement.\n\nData type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nentitlements.​state\n\n\n\nCurrent state of the entitlement.\n\nValid values: \\(case-sensitive\\)\n\n- active\n- cancelled\n- draft\n- expired\n- suspended\n\nData type: String\n\n
\n\nentitlements.​sys\\_created\\_by\n\n\n\nName of the user that created the entitlement record.Data type: String\n\n
\n\nentitlements.​sys\\_created\\_on\n\n\n\nDate and time that the entitlement record was created.Data type: String\n\n
\n\nentitlements.​sys\\_id\n\n\n\nSys\\_id of the associated entitlement record.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nentitlements.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the entitlement record.Data type: String\n\n
\n\nentitlements.​sys\\_updated\\_on\n\n\n\nDate and time that the entitlement record was created.Data type: String\n\n
\n\nentitlement\\_characteristics\n\n\n\nList of entitlement characteristics associated with the service contract line.Data type: Array of Objects\n\n```\n\"entitlement_characteristics\": [\n {\n \"characteristic\": \"String\",\n \"characteristic_option\": \"String\",\n \"entitlement\": \"String\",\n \"service_contract_line\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\",\n \"type\": \"String\",\n \"value\": \"String\"\n }\n]\n```\n\nTable: Characteristic \\[sn\\_pss\\_core\\_entitlement\\_characteristic\\]\n\n
\n\nentitlement\\_characteristics.​characteristic\n\n\n\nSys\\_id of the characteristic record associated with the entitlement.\n\nData type: String\n\nTable: Characteristic \\[sn\\_prd\\_pm\\_characteristic\\]\n\n
\n\nentitlement\\_characteristics.​characteristic\\_option\n\n\n\nSys\\_id of the characteristic option record associated with the entitlement.Data type: String\n\nTable: Characteristic Option \\[sn\\_prd\\_pm\\_characteristic\\_option\\]\n\n
\n\nentitlement\\_characteristics.​entitlement\n\n\n\nSys\\_id of the entitlement record.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nentitlement\\_characteristics.​service\\_contract\\_line\n\n\n\nSys\\_id of the service contract line record associated with the entitlement characteristic.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nentitlement\\_characteristics.​sys\\_created\\_by\n\n\n\nName of the user that created the entitlement characteristics record.Data type: String\n\n
\n\nentitlement\\_characteristics.​sys\\_created\\_on\n\n\n\nDate and time that the entitlement characteristics record was created.Data type: String\n\n
\n\nentitlement\\_characteristics.​sys\\_id\n\n\n\nSys\\_id of the entitlement characteristics record.Data type: String\n\n
\n\nentitlement\\_characteristics.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the entitlement characteristics record.Data type: String\n\n
\n\nentitlement\\_characteristics.​sys\\_updated\\_on\n\n\n\nDate and time that the entitlement characteristics record was last updated.Data type: String\n\n
\n\nentitlement\\_characteristics.​type\n\n\n\nType of entitlement characteristic. Valid values:\n\n- coverage\n- coverage\\_and\\_usage\n\nData type: String\n\n
\n\nentitlement\\_characteristics.​value\n\n\n\nValue of the characteristic.\n\nData type: String\n\n
\n\ninstall\\_base\\_items\\_covered\n\n\n\nList of install base items covered under the  service contract line.Data type: Array of Objects\n\n```\n \"install_base_items_covered\": [ \n {\n \"added\": \"String\",\n \"contract\": \"String\",\n \"entitlement\": \"String\",\n \"install_base\": \"String\",\n \"removed\": \"String\",\n \"service_contract_line\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\"\n }\n]\n```\n\nTable: Sold Product Covered  \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\ninstall\\_base\\_items\\_covered.​added\n\n\n\nDate that the associated install base item was added to the service contract line.\n\nData type: String\n\n
\n\ninstall\\_base\\_items\\_covered.​contract\n\n\n\nSys\\_id of the service contract record associated with the install base item.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\ninstall\\_base\\_items\\_covered.​entitlement\n\n\n\nSys\\_id of the entitlement record associated with the install base item.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\ninstall\\_base\\_items\\_covered.​install\\_base\n\n\n\nSys\\_id of the install base item covered by the service contract line.Data type: String\n\nTable: Install Base Item \\[sn\\_install\\_base\\_item\\]\n\n
\n\ninstall\\_base\\_items\\_covered.​removed\n\n\n\nDate that the associated service contract line ends coverage of the install base item.\n\nData type: String\n\n
\n\ninstall\\_base\\_items\\_covered.​service\\_contract\\_line\n\n\n\nSys\\_id of the associated service contract line record.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\ninstall\\_base\\_items\\_covered.​sys\\_created\\_by\n\n\n\nName of the user that created the install base item record.Data type: String\n\n
\n\ninstall\\_base\\_items\\_covered.​sys\\_created\\_on\n\n\n\nDate and time that the install base item record was created.Data type: String\n\n
\n\ninstall\\_base\\_items\\_covered.​sys\\_id\n\n\n\nSys\\_id of the install base item covered.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\ninstall\\_base\\_items\\_covered.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the install base item record.Data type: String\n\n
\n\ninstall\\_base\\_items\\_covered.​sys\\_updated\\_on\n\n\n\nDate and time that the install base item record was last updated.Data type: String\n\n
\n\nname\n\n\n\nName of the service contract line.\n\nData type: String\n\n
\n\nnumber\n\n\n\nUnique number of the service contract line. Automatically generated by the endpoint. For example: CTRL9812347.Data type: String\n\n
\n\nparent\\_contract\\_line\n\n\n\nSys\\_id of the service contract line to which the current service contract line is a child of.Null for the contract lines created under a contract.\n\nData type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nproduct\\_model\n\n\n\nSys\\_id of the product associated with the service contract line.Data type: String\n\nTable: Product Model \\[cmdb\\_model\\]\n\n
\n\nproduct\\_offering\n\n\n\nSys\\_id of the product offering record associated with the service contract line.Data type: String\n\nTable: Product Offering \\[sn\\_prd\\_pm\\_product\\_offering\\]\n\n
\n\nproduct\\_specification\n\n\n\nSys\\_id of the product specification record associated with the service contract line.Data type: String\n\nTable: Product Specification \\[sn\\_prd\\_pm\\_product\\_specification\\]\n\n
\n\nsold\\_product\n\n\n\nSys\\_id of the sold product record associated with the service contract line.Data type: String\n\nTable: Sold Product \\[sn\\_install\\_base\\_sold\\_product\\]\n\n
\n\nsold\\_products\\_covered\n\n\n\nList of products covered.Data type: Array of Objects\n\n```\n\"sold_products_covered\": [ \n {\n \"added\": \"String\",\n \"contract\": \"String\",\n \"entitlement\": \"String\",\n \"removed\": \"String\",\n \"service_contract_line\": \"String\",\n \"sold_product\": \"String\",\n \"sys_created_by\": \"String\",\n \"sys_created_on\": \"String\",\n \"sys_id\": \"String\",\n \"sys_updated_by\": \"String\",\n \"sys_updated_on\": \"String\"\n }\n]\n```\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nsold\\_products\\_covered.​added\n\n\n\nDate that the associated sold product was added to the service contract line.Data type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nsold\\_products\\_covered.​contract\n\n\n\nSys\\_id of the service contract record associated with the sold product covered.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nsold\\_products\\_covered.​entitlement\n\n\n\nSys\\_id of the entitlement record associated with the sold product covered.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nsold\\_products\\_covered.removed\n\n\n\nDate that the associated sold product was removed from the service contract line.Data type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nsold\\_products\\_covered.​service\\_contract\\_line\n\n\n\nSys\\_id of the service contract line record associated with the sold product covered.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nsold\\_products\\_covered.​sold\\_product\n\n\n\nSys\\_id of the product covered by the entitlement.Data type: String\n\nTable: Sold Product \\[sn\\_install\\_base\\_sold\\_product\\]\n\n
\n\nsold\\_products\\_covered.​sys\\_created\\_by\n\n\n\nName of the user that created the sold product covered record.Data type: String\n\n
\n\nsold\\_products\\_covered.​sys\\_created\\_on\n\n\n\nDate and time that the sold product covered record was created.Data type: String\n\n
\n\nsold\\_products\\_covered.​sys\\_id\n\n\n\nSys\\_id of the product covered by this service contract.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nsold\\_products\\_covered.​sys\\_updated\\_by\n\n\n\nName of the user that last updated the sold product covered record.Data type: String\n\n
\n\nsold\\_products\\_covered.​sys\\_updated\\_on\n\n\n\nDate and time that the sold product covered record was last updated.Data type: String\n\n
\n\nstarts\n\n\n\nStart date of the service contract line.\n\nData type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nstate\n\n\n\nCurrent state of the contract line.\n\nValid values: \\(case-sensitive\\)\n\n- active\n- cancelled\n- draft\n- expired\n- suspended\n\nData type: String\n\n
\n\nsys\\_created\\_by\n\n\n\nName of the user that created the service contract line record.Data type: String\n\n
\n\nsys\\_created\\_on\n\n\n\nDate and time that the service contract line record was created.Data type: String\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of a service contract line record.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nsys\\_updated\\_by\n\n\n\nName of the user that last updated the service contract line record.Data type: String\n\n
\n\nsys\\_updated\\_on\n\n\n\nDate and time that the service contract line record was last updated.Data type: String\n\n
### cURL request\n\nThe following code example shows how to call this endpoint.\n\n```\ncurl \"https://instance.servicenow.com/api/sn_pss_core/servicecontract/contractline/fc73d2de89226110f877430a4e008add\" \\\n--request GET \\\n--header \"Accept:application/json\" \\\n--user \"username\":\"password\"\n```\n\nResponse:\n\n```\n{\n \"result\": {\n \"sys_id\": \"16e451d1d1f53110f8776589fa411f80\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:29:47\",\n \"sys_updated_on\": \"2023-10-09 11:29:47\",\n \"name\": \"CLI\",\n \"number\": \"CTRL0000001\",\n \"contract\": \"a4b415d1d1f53110f8776589fa411f20\",\n \"parent_contract_line\": null,\n \"sold_product\": null,\n \"starts\": \"2022-12-03\",\n \"ends\": \"\",\n \"product_offering\": null,\n \"product_specification\": null,\n \"product_model\": null,\n \"child_contract_lines\": [\n {\n \"sys_id\": \"3a39ecdc01154f4ab782da0169c9c922\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:27:29\",\n \"sys_updated_on\": \"2023-10-09 11:27:29\",\n \"name\": \"Child CLI\",\n \"number\": \"CTRL0000002\",\n \"contract\": \"a4b415d1d1f53110f8776589fa411f20\",\n \"parent_contract_line\": \"16e451d1d1f53110f8776589fa411f80\",\n \"sold_product\": null,\n \"starts\": \"2022-12-03\",\n \"ends\": \"\",\n \"product_offering\": null,\n \"product_model\": null,\n \"product_specification\": null,\n \"child_contract_lines\": [],\n \"entitlements\": [\n {\n \"sys_id\": \"7439fd84c2494ba6951e58f333cfe8d4\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:27:29\",\n \"sys_updated_on\": \"2023-10-09 11:27:29\",\n \"entitlement_name\": \"Child CLI - ENTL\",\n \"account\": \"4c325111d1f53110f8776589fa411f3d\",\n \"consumer\": null,\n \"household\": null,\n \"contract\": \"a4b415d1d1f53110f8776589fa411f20\",\n \"service_contract_line\": \"3a39ecdc01154f4ab782da0169c9c922\",\n \"state\": \"active\",\n \"product_offering\": null,\n \"product_specification\": null,\n \"sold_entitlement\": null,\n \"product\": null,\n \"start_date\": \"2022-12-03\",\n \"end_date\": \"\",\n \"entitlement_characteristics\": [],\n \"sold_products_covered\": [],\n \"install_base_items_covered\": []\n }\n ],\n \"sold_products_covered\": [\n {\n \"sys_id\": \"dfb62e9c4c6843009be02a68f65b9118\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:27:29\",\n \"sys_updated_on\": \"2023-10-09 11:27:29\",\n \"contract\": \"a4b415d1d1f53110f8776589fa411f20\",\n \"service_contract_line\": \"3a39ecdc01154f4ab782da0169c9c922\",\n \"entitlement\": null,\n \"sold_product\": \"ec235d9dd1b53110f8776589fa411fe2\",\n \"added\": \"2023-12-03\",\n \"removed\": \"2023-12-03\"\n }\n ],\n \"install_base_items_covered\": [\n {\n \"sys_id\": \"2583912e81964501b52a2e44d4797a28\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:27:29\",\n \"sys_updated_on\": \"2023-10-09 11:27:29\",\n \"contract\": \"a4b415d1d1f53110f8776589fa411f20\",\n \"service_contract_line\": \"3a39ecdc01154f4ab782da0169c9c922\",\n \"entitlement\": null,\n \"install_base\": \"a1731551d1f53110f8776589fa411f8d\",\n \"added\": \"2023-12-03\",\n \"removed\": \"2023-12-03\"\n }\n ],\n \"entitlement_characteristics\": [\n {\n \"sys_id\": \"3a00c975bb49412cae169200c7f6236e\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:27:29\",\n \"sys_updated_on\": \"2023-10-09 11:27:29\",\n \"service_contract_line\": \"3a39ecdc01154f4ab782da0169c9c922\",\n \"entitlement\": null,\n \"characteristic_option\": \"495149b7539e61106bfcddeeff7b1262\",\n \"value\": \"5\",\n \"characteristic\": \"63418db7539e61106bfcddeeff7b1238\",\n \"type\": \"coverage\"\n }\n ]\n }\n ],\n \"entitlements\": [\n {\n \"sys_id\": \"16e419d1d1f53110f8776589fa411f3c\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:29:48\",\n \"sys_updated_on\": \"2023-10-09 11:29:48\",\n \"entitlement_name\": \"ENTL 2\",\n \"account\": \"4c325111d1f53110f8776589fa411f3d\",\n \"consumer\": null,\n \"household\": null,\n \"contract\": \"a4b415d1d1f53110f8776589fa411f20\",\n \"service_contract_line\": \"16e451d1d1f53110f8776589fa411f80\",\n \"state\": \"active\",\n \"product_offering\": null,\n \"product_specification\": null,\n \"sold_entitlement\": null,\n \"product\": null,\n \"start_date\": \"2022-12-03\",\n \"end_date\": \"\",\n \"sold_products_covered\": [\n {\n \"sys_id\": \"1ae419d1d1f53110f8776589fa411f3d\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:29:48\",\n \"sys_updated_on\": \"2023-10-09 11:29:48\",\n \"contract\": \"a4b415d1d1f53110f8776589fa411f20\",\n \"service_contract_line\": \"16e451d1d1f53110f8776589fa411f80\",\n \"entitlement\": \"16e419d1d1f53110f8776589fa411f3c\",\n \"sold_product\": \"da23d151d1f53110f8776589fa411f27\",\n \"added\": \"\",\n \"removed\": \"\"\n }\n ],\n \"install_base_items_covered\": [],\n \"entitlement_characteristics\": [\n {\n \"sys_id\": \"1ae419d1d1f53110f8776589fa411f3e\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:29:48\",\n \"sys_updated_on\": \"2023-10-09 11:29:48\",\n \"service_contract_line\": null,\n \"entitlement\": \"16e419d1d1f53110f8776589fa411f3c\",\n \"characteristic_option\": \"495149b7539e61106bfcddeeff7b1262\",\n \"value\": \"5\",\n \"characteristic\": \"63418db7539e61106bfcddeeff7b1238\",\n \"type\": \"coverage_and_usage\",\n \"entitlement_usage\": [\n {\n \"sys_id\": \"56e419d1d1f53110f8776589fa411f3f\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:29:48\",\n \"sys_updated_on\": \"2023-10-09 11:29:48\",\n \"entitlement\": \"16e419d1d1f53110f8776589fa411f3c\",\n \"service_contract_line\": null,\n \"entitlement_characteristic\": \"1ae419d1d1f53110f8776589fa411f3e\",\n \"period_start\": \"2022-12-03\",\n \"period_end\": \"\",\n \"total_units\": \"5\",\n \"used_units\": \"2\"\n }\n ]\n }\n ]\n }\n ],\n \"sold_products_covered\": [\n {\n \"sys_id\": \"5ae451d1d1f53110f8776589fa411f81\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:29:47\",\n \"sys_updated_on\": \"2023-10-09 11:29:47\",\n \"contract\": \"a4b415d1d1f53110f8776589fa411f20\",\n \"service_contract_line\": \"16e451d1d1f53110f8776589fa411f80\",\n \"entitlement\": null,\n \"sold_product\": \"0df21151d1f53110f8776589fa411f1b\",\n \"added\": \"2023-12-03\",\n \"removed\": \"2023-12-03\"\n }\n ],\n \"install_base_items_covered\": [],\n \"entitlement_characteristics\": [\n {\n \"sys_id\": \"dae451d1d1f53110f8776589fa411f82\",\n \"sys_created_by\": \"admin\",\n \"sys_updated_by\": \"admin\",\n \"sys_created_on\": \"2023-10-09 11:29:47\",\n \"sys_updated_on\": \"2023-10-09 11:29:47\",\n \"service_contract_line\": \"16e451d1d1f53110f8776589fa411f80\",\n \"entitlement\": null,\n \"characteristic_option\": \"495149b7539e61106bfcddeeff7b1262\",\n \"value\": \"5\",\n \"characteristic\": \"63418db7539e61106bfcddeeff7b1238\",\n \"type\": \"coverage\"\n }\n ]\n }\n}\n```\n\n## Service Contract - POST /sn\\_pss\\_core/servicecontract\n\nCreates a service contract record and all its related entities from a specified payload.\n\nThe Service Contract API stores data in various tables. The following is the list of tables in which records are created by this endpoint when creating a service contract:\n\n- Characteristic \\[sn\\_pss\\_core\\_entitlement\\_characteristic\\]\n- Entitlement \\[service\\_entitlement\\]\n- Entitlement Usage \\[sn\\_pss\\_core\\_entitlement\\_usage\\]\n- Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\] - This table contains information for both sold products covered and install base items covered.\n- Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n- Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\nThe request body of this endpoint references fields in the following tables. This information needs to be added to your instance before utilizing this API. For additional information, see [Create service contracts](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/customer-service-management/create-csm-service-contracts.md).\n\n- Account \\[customer\\_account\\]\n- Characteristic Option \\[sn\\_prd\\_pm\\_characteristic\\_option\\]\n- Consumer \\[csm\\_consumer\\]\n- Household \\[csm\\_household\\]\n\n### URL format\n\nVersioned URL: `/api/sn_pss_core/{api_version}/servicecontract`\n\nDefault URL: `/api/sn_pss_core/servicecontract`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. 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\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\naccount\n\n\n\nRequired if the **consumer** parameter is not specified. Sys\\_id of the account record to which the service contract belongs.\n\nData type: String\n\nTable: Account \\[customer\\_account\\]\n\n
\n\nconsumer\n\n\n\nRequired if the **account** parameter is not specified. Sys\\_id of the consumer record to which the service contract belongs.\n\nData type: String\n\nTable: Consumer \\[csm\\_consumer\\]\n\n
\n\nends\n\n\n\nDate on which the service contract ends.\n\nData type: String\n\nFormat: yyyy-mm-dd\n\n Default: Never ends until manually removed.\n\n
\n\nhousehold\n\n\n\nOnly valid for consumer service contracts. Sys\\_id of the household associated with the service contract.\n\nData type: String\n\nTable: Household \\[csm\\_household\\]\n\nDefault: null \\(no household\\)\n\n
\n\ninstall\\_base\\_items\\_covered\n\n\n\nList of install base items covered under the service contract.For more information on Install Base Items [Configure install base](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/customer-service-management/configure-install-base.md).\n\nData type: Array of Objects\n\n```\n\"install_base_items_covered\": [ \n {\n \"added\": \"String\",\n \"install_base\": \"String\",\n \"removed\": \"String\"\n }\n]\n```\n\nStored in: The Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\] table.\n\n
\n\ninstall\\_base\\_items\\_covered.added\n\n\n\nDate that the associated service contract starts to cover the install base item.\n\nData type: String\n\nFormat: yyyy-mm-dd\n\n Default: Current date\n\n
\n\ninstall\\_base\\_items\\_covered.​install\\_base\n\n\n\nSys\\_id of the associated install base item record.Data type: String\n\nTable: Install Base Item \\[sn\\_install\\_base\\_item\\]\n\n
\n\ninstall\\_base\\_items\\_covered.​removed\n\n\n\nDate that the associated service contract ends coverage of the install base item.\n\nData type: String\n\nFormat: yyyy-mm-dd\n\n Default: No end date\n\n
\n\nservice\\_contract\\_lines\n\n\n\nList of service contract lines associated with the service contract.Data type: Array of Objects\n\n```\n\"service_contract_lines\": [\n {\n \"child_contract_lines\": [Array],\n \"ends\": \"String\",\n \"entitlements\": [Array],\n \"entitlement_characteristics\": [Array],\n \"install_base_items_covered\": [Array],\n \"name\": \"String\",\n \"number\": \"String\",\n \"product_model\": \"String\",\n \"product_offering\": \"String\",\n \"product_specification\": \"String\",\n \"sold_product\": \"String\",\n \"sold_products_covered\": [Array],\n \"starts\": \"String\",\n \"state\": \"String\"\n }\n]\n```\n\nStored in: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines\n\n\n\nList of child service contract lines under the service contract line.Data type: Array of Objects\n\n```\n\"child_contract_lines\": [\n {\n \"child_contract_lines\": [Array],\n \"ends\": \"String\",\n \"entitlements\": [Array],\n \"entitlement_characteristics\": [Array],\n \"install_base_items_covered\": [Array],\n \"name\": \"String\",\n \"product_model\": \"String\",\n \"product_offering\": \"String\",\n \"product_specification\": \"String\",\n \"sold_product\": \"String\",\n \"sold_products_covered\": [Array],\n \"starts\": \"String\",\n \"state\": \"String\"\n }\n]\n```\n\nStored in: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​child\\_contract\\_lines\n\n\n\nList of child service contract line objects to create under the child service contract line. The objects in this array have the same elements as the objects in the **service\\_contract\\_lines.child\\_contract\\_lines** parameter.Data type: Array of Objects\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​ends\n\n\n\nDate on which the service contract line ends.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Never ends until manually removed.\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements\n\n\n\nList of entitlements to associate with the child service contract line.Data type: Array of Objects\n\n```\n\"entitlements:\" [\n {\n \"account\": \"String\",\n \"consumer\": \"String\",\n \"end_date\": \"String\",\n \"entitlement_characteristics\": [Array],\n \"entitlement_name\": \"String\",\n \"household\": \"String\",\n \"install_base_items_covered\": [Array],\n \"product\": \"String\",\n \"product_offering\": \"String\",\n \"product_specification\": \"String\",\n \"sold_entitlement\": \"String\",\n \"sold_products_covered\": [Array],\n \"start_date\": \"String\",\n \"state\": \"String\"\n }\n]\n```\n\nStored in: Entitlement \\[service\\_entitlement\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​account\n\n\n\nSys\\_id of the account record to which the entitlement belongs.\n\nData type: String\n\nTable: Account \\[customer\\_account\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​consumer\n\n\n\nSys\\_id of the consumer record to which the entitlement belongs.\n\nData type: String\n\nTable: Consumer \\[csm\\_consumer\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​end\\_date\n\n\n\nEnd date of the entitlement.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Never ends until manually removed.\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics\n\n\n\nList of characteristics associated with the entitlement.Data type: Array of Objects\n\n```\n\"entitlement_characteristics\": [\n {\n \"characteristic\": \"String\",\n \"characteristic_option\": \"String\",\n \"entitlement_usage\": {Object},\n \"type\": \"String\",\n \"value\": \"String\"\n }\n]\n```\n\nStored in: Characteristic \\[sn\\_pss\\_core\\_entitlement\\_characteristic\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.characteristic\n\n\n\nRequired. Sys\\_id of the characteristic record associated with the entitlement.\n\nData type: String\n\nTable: Characteristic \\[sn\\_prd\\_pm\\_characteristic\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.characteristic\\_option\n\n\n\nSys\\_id of the characteristic option record associated with the entitlement.Data type: String\n\nTable: Characteristic Option \\[sn\\_prd\\_pm\\_characteristic\\_option\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.entitlement\\_usage\n\n\n\nUsed unit value for the associated entitlement characteristic.Only pass this parameter if the entitlement\\_characteristics are under the entitlement.\n\nData type: Object\n\n```\n\"entitlement_usage\": {\n \"used_units\": \"String\"\n}\n```\n\nStored in: Entitlement Usage \\[sn\\_pss\\_core\\_entitlement\\_usage\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.entitlement\\_usage.​used\\_units\n\n\n\nUsage of the associated entitlement characteristic.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.type\n\n\n\nType of entitlement characteristic. Valid values:\n\n- coverage\n- coverage\\_and\\_usage\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.value\n\n\n\nRequired if the **input\\_type** parameter contained in the record specified in the **entitlement\\_characteristics.characteristic** parameter, is not `choice`.Value of the characteristic.\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_name\n\n\n\nRequired. Name of the entitlement.\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​household\n\n\n\nOnly passed when the household plugins are active and the **consumer** parameter is passed. Sys\\_id of the household record associated with the entitlement.\n\nData type: String\n\nTable: Household \\[csm\\_household\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered\n\n\n\nList of install base items covered under the entitlement. The information in this array is inserted in the Sold Product Covered  \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\] table.\n\nData type: Array of Objects\n\n ```\n\"install_base_items_covered\": [ \n {\n \"added\": \"String\",\n \"install_base\": \"String\",\n \"removed\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​added\n\n\n\nDate that the associated install base item was added to the entitlement.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Current date\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​install\\_base\n\n\n\nSys\\_id of the install base item covered by the entitlement.Data type: String\n\nTable: Install Base Item \\[sn\\_install\\_base\\_item\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​removed\n\n\n\nDate that the associated install base item was removed from the entitlement.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: No end date\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​product\n\n\n\nSys\\_id of the product model record associated with the entitlement.Data type: String\n\nTable: Product Model \\[cmdb\\_model\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​product\\_offering\n\n\n\nSys\\_id of the product offering record associated with the entitlement.Data type: String\n\nTable: Product Offering \\[sn\\_prd\\_pm\\_product\\_offering\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​product\\_specification\n\n\n\nSys\\_id of the product specification record associated with the entitlement.Data type: String\n\nTable: Product Specification \\[sn\\_prd\\_pm\\_product\\_specification\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​sold\\_entitlement\n\n\n\nSys\\_id of the sold product record associated with the entitlement.Data type: String\n\nTable: Sold Product \\[sn\\_install\\_base\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​sold\\_products\\_covered\n\n\n\nList of sold products covered under the entitlement. Data type: Array of Objects\n\n```\n\"sold_products_covered\": [ \n {\n \"added\": \"String\",\n \"removed\": \"String\",\n \"sold_product\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​added\n\n\n\nDate that the associated sold product was added to the entitlement.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Current date\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​removed\n\n\n\nDate that the associated sold product was removed from the entitlement.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: No end date\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​start\\_date\n\n\n\nRequired. Start date of the entitlement.\n\nData type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​state\n\n\n\nRequired.Current state of the entitlement.\n\nValid values: \\(case-sensitive\\)\n\n- active\n- cancelled\n- draft\n- expired\n- suspended\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlement\\_characteristics\n\n\n\nList of characteristics associated with the service contract line.Data type: Array of Objects\n\n```\n\"entitlement_characteristics\" [\n {\n \"characteristic\": \"String\",\n \"characteristic_option\": \"String\",\n \"entitlement_usage\": {Object},\n \"type\": \"String\",\n \"value\": \"String\"\n }\n]\n```\n\nStored in: Characteristic \\[sn\\_pss\\_core\\_entitlement\\_characteristic\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlement\\_characteristics.characteristic\n\n\n\nRequired. Sys\\_id of the characteristic record associated with the service contract line.\n\nData type: String\n\nTable: Characteristic \\[sn\\_prd\\_pm\\_characteristic\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlement\\_characteristics.characteristic\\_option\n\n\n\nSys\\_id of the characteristic option record associated with the service contract line.\n\nData type: String\n\nTable: Characteristic Option \\[sn\\_prd\\_pm\\_characteristic\\_option\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlement\\_characteristics.entitlement\\_usage\n\n\n\nUsed unit value for the associated service contract line characteristic.Data type: Object\n\n```\n\"entitlement_usage\": {\n \"used_units\": \"String\"\n}\n```\n\nStored in: Entitlement Usage \\[sn\\_pss\\_core\\_entitlement\\_usage\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlement\\_characteristics.entitlement\\_usage.​usage\\_units\n\n\n\nUsage of the associated entitlement characteristic.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlement\\_characteristics.type\n\n\n\nType of service contract line characteristic. Valid values:\n\n- coverage\n- coverage \\_and\\_usage\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlement\\_characteristics.value\n\n\n\nRequired if the **entitlement\\_characteristics.type** parameter is not passed. Value of the characteristic.\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​install\\_base\\_items\\_covered\n\n\n\nList of install base items covered under the  service contract line.\n\nData type: Array of Objects\n\n```\n \"install_base_items_covered\": [ \n {\n \"added\": \"String\",\n \"install_base\": \"String\",\n \"removed\": \"String\"\n }\n]\n```\n\nStored in: Sold Product Covered  \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​install\\_base\\_items\\_covered.​added\n\n\n\nDate that the associated install base item was added to the service contract line.\n\nData type: String\n\n Format: yyyy-mm-dd\n\n Default: Current date\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​install\\_base\\_items\\_covered.​install\\_base\n\n\n\nSys\\_id of the install base item covered by the service contract line.Data type: String\n\nTable: Install Base Item \\[sn\\_install\\_base\\_item\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​install\\_base\\_items\\_covered.​removed\n\n\n\nDate that the associated service contract line ends coverage of the install base item.\n\nData type: String\n\n Format: yyyy-mm-dd\n\n Default: No end date\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​name\n\n\n\nName of the service contract line.\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​product\\_model\n\n\n\nSys\\_id of the product associated with the service contract line.Data type: String\n\nTable: Product Model \\[cmdb\\_model\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​product\\_offering\n\n\n\nSys\\_id of the product offering record associated with the service contract line.Data type: String\n\nTable: Product Offering \\[sn\\_prd\\_pm\\_product\\_offering\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​product\\_specification\n\n\n\nSys\\_id of the product specification record associated with the service contract line.Data type: String\n\nTable: Product Specification \\[sn\\_prd\\_pm\\_product\\_specification\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​sold\\_product\n\n\n\nSys\\_id of the sold product record associated with the service contract line.Data type: String\n\nTable: Sold Product \\[sn\\_install\\_base\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​sold\\_products\\_covered\n\n\n\nList of products covered under the service contract line.\n\nData type: Array of Objects\n\n ```\n\"sold_products_covered\": [ \n {\n \"added\": \"String\",\n \"removed\": \"String\",\n \"sold_product\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​.sold\\_products\\_covered.​added\n\n\n\nDate that the associated service contract line starts to cover the associated product.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Current date\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​sold\\_products\\_covered.​removed\n\n\n\nDate that the associated service contract line ends coverage of the associated product.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: No end date\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​sold\\_products\\_covered.​sold\\_product\n\n\n\nSys\\_id of a product associated with the service contract line.\n\nData type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​starts\n\n\n\nRequired. Start date of the service contract line.\n\nData type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​state\n\n\n\nRequired.Current state of the contract line.\n\nValid values: \\(case-sensitive\\)\n\n- active\n- cancelled\n- draft\n- expired\n- suspended\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.ends\n\n\n\nDate on which the service contract line ends.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Never ends until manually removed.\n\n
\n\nservice\\_contract\\_lines.entitlements\n\n\n\nList of entitlements to associate with the service contract line. These entitlements are inserted in the Entitlement \\[service\\_entitlement\\] table.Data type: Array of Objects\n\n```\n\"entitlements:\" [\n {\n \"account\": \"String\",\n \"consumer\": \"String\",\n \"end_date\": \"String\",\n \"entitlement_characteristics\": [Array],\n \"entitlement_name\": \"String\",\n \"household\": \"String\",\n \"install_base_items_covered\": [Array],\n \"product\": \"String\",\n \"product_offering\": \"String\",\n \"product_specification\": \"String\",\n \"sold_entitlement\": \"String\",\n \"sold_products_covered\": [Array],\n \"start_date\": \"String\",\n \"state\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​entitlements.​account\n\n\n\nSys\\_id of the account record to which the entitlement belongs.\n\nData type: String\n\nTable: Account \\[customer\\_account\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​consumer\n\n\n\nSys\\_id of the consumer record to which the entitlement belongs.\n\nData type: String\n\nTable: Consumer \\[csm\\_consumer\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​end\\_date\n\n\n\nEnd date of the entitlement.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Never ends until manually removed.\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics\n\n\n\nList of characteristics associated with the entitlement.Data type: Array of Objects\n\n```\n\"entitlement_characteristics\": [\n {\n \"characteristic\": \"String\",\n \"characteristic_option\": \"String\",\n \"entitlement_usage\": {Object},\n \"type\": \"String\",\n \"value\": \"String\"\n }\n]\n```\n\nStored in: Characteristic \\[sn\\_pss\\_core\\_entitlement\\_characteristic\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.characteristic\n\n\n\nRequired. Sys\\_id of the characteristic record associated with the entitlement.\n\nData type: String\n\nTable: Characteristic \\[sn\\_prd\\_pm\\_characteristic\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.characteristic\\_option\n\n\n\nSys\\_id of the characteristic option record associated with the entitlement.Data type: String\n\nTable: Characteristic Option \\[sn\\_prd\\_pm\\_characteristic\\_option\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.entitlement\\_usage\n\n\n\nUsed unit value for the associated entitlement characteristic.Only pass this parameter if the entitlement\\_characteristics are under the entitlement.\n\nData type: Object\n\n```\n\"entitlement_usage\": {\n \"used_units\": \"String\"\n}\n```\n\nStored in: Entitlement Usage \\[sn\\_pss\\_core\\_entitlement\\_usage\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.entitlement\\_usage.​usage\\_units\n\n\n\nUsage of the associated entitlement characteristic.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.type\n\n\n\nType of entitlement characteristic. Valid values:\n\n- coverage\n- coverage\\_and\\_usage\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.value\n\n\n\nRequired if the **input\\_type** parameter contained in the record specified in the **entitlement\\_characteristics.characteristic** parameter, is not `choice`.Value of the characteristic.\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_name\n\n\n\nRequired. Name of the entitlement.\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​household\n\n\n\nOnly passed when the household plugins are active and the **consumer** parameter is passed. Sys\\_id of the household record associated with the entitlement.\n\nData type: String\n\nTable: Household \\[csm\\_household\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered\n\n\n\nList of install base items covered under the entitlement. The information in this array is inserted in the Sold Product Covered  \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\] table.\n\nData type: Array of Objects\n\n ```\n\"install_base_items_covered\": [ \n {\n \"added\": \"String\",\n \"install_base\": \"String\",\n \"removed\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​added\n\n\n\nDate that the associated install base item was added to the entitlement.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Current date\n\n
\n\nservice\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​install\\_base\n\n\n\nSys\\_id of the install base item covered by the entitlement.Data type: String\n\nTable: Install Base Item \\[sn\\_install\\_base\\_item\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​removed\n\n\n\nDate that the associated install base item was removed from the entitlement.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: No end date\n\n
\n\nservice\\_contract\\_lines.​entitlements.​product\n\n\n\nSys\\_id of the product model record associated with the entitlement.Data type: String\n\nTable: Product Model \\[cmdb\\_model\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​product\\_offering\n\n\n\nSys\\_id of the product offering record associated with the entitlement.Data type: String\n\nTable: Product Offering \\[sn\\_prd\\_pm\\_product\\_offering\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​product\\_specification\n\n\n\nSys\\_id of the product specification record associated with the entitlement.Data type: String\n\nTable: Product Specification \\[sn\\_prd\\_pm\\_product\\_specification\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​sold\\_entitlement\n\n\n\nSys\\_id of the sold product record associated with the entitlement.Data type: String\n\nTable: Sold Product \\[sn\\_install\\_base\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​sold\\_products\\_covered\n\n\n\nList of sold products covered under the entitlement. Data type: Array of Objects\n\n```\n\"sold_products_covered\": [ \n {\n \"added\": \"String\",\n \"removed\": \"String\",\n \"sold_product\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​added\n\n\n\nDate that the associated sold product was added to the entitlement.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Current date\n\n
\n\nservice\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​removed\n\n\n\nDate that the associated sold product was removed from the entitlement.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: No end date\n\n
\n\nservice\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​sold\\_product\n\n\n\nSys\\_id of a product associated with the entitlement.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​start\\_date\n\n\n\nRequired. Start date of the entitlement.\n\nData type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nservice\\_contract\\_lines.​entitlements.​state\n\n\n\nRequired.Current state of the entitlement.\n\nValid values: \\(case-sensitive\\)\n\n- active\n- cancelled\n- draft\n- expired\n- suspended\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics\n\n\n\nList of characteristics associated with the service contract line.Data type: Array of Objects\n\n```\n\"entitlement_characteristics\" [\n {\n \"characteristic\": \"String\",\n \"characteristic_option\": \"String\",\n \"entitlement_usage\": {Object},\n \"type\": \"String\",\n \"value\": \"String\"\n }\n]\n```\n\nStored in: Characteristic \\[sn\\_pss\\_core\\_entitlement\\_characteristic\\]\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.​characteristic\n\n\n\nRequired. Sys\\_id of the characteristic record associated with the service contract line.\n\nData type: String\n\nTable: Characteristic \\[sn\\_prd\\_pm\\_characteristic\\]\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.​characteristic\\_option\n\n\n\nSys\\_id of the characteristic option record associated with the service contract line.\n\nData type: String\n\nTable: Characteristic Option \\[sn\\_prd\\_pm\\_characteristic\\_option\\]\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage\n\n\n\nUsed unit value for the associated service contract line characteristic.Data type: Object\n\n```\n\"entitlement_usage\": {\n \"used_units\": \"String\"\n}\n```\n\nStored in: Entitlement Usage \\[sn\\_pss\\_core\\_entitlement\\_usage\\]\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage.​usage\\_units\n\n\n\nUsage of the associated entitlement characteristic.Data type: String\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.​type\n\n\n\nType of service contract line characteristic. Valid values:\n\n- coverage\n- coverage \\_and\\_usage\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.​value\n\n\n\nRequired if the **entitlement\\_characteristics.type** parameter is not passed. Value of the characteristic.\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​install\\_base\\_items\\_covered\n\n\n\nList of install base items covered under the  service contract line.\n\nData type: Array of Objects\n\n```\n \"install_base_items_covered\": [ \n {\n \"added\": \"String\",\n \"install_base\": \"String\",\n \"removed\": \"String\"\n }\n]\n```\n\nStored in: Sold Product Covered  \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​install\\_base\\_items\\_covered.​added\n\n\n\nDate that the associated install base item was added to the service contract line.\n\nData type: String\n\n Format: yyyy-mm-dd\n\n Default: Current date\n\n
\n\nservice\\_contract\\_lines.​install\\_base\\_items\\_covered.​install\\_base\n\n\n\nSys\\_id of the install base item covered by the service contract line.Data type: String\n\nTable: Install Base Item \\[sn\\_install\\_base\\_item\\]\n\n
\n\nservice\\_contract\\_lines.​install\\_base\\_items\\_covered.​removed\n\n\n\nDate that the associated service contract line ends coverage of the install base item.\n\nData type: String\n\n Format: yyyy-mm-dd\n\n Default: No end date\n\n
\n\nservice\\_contract\\_lines.​name\n\n\n\nName of the service contract line.\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​product\\_model\n\n\n\nSys\\_id of the product associated with the service contract line.Data type: String\n\nTable: Product Model \\[cmdb\\_model\\]\n\n
\n\nservice\\_contract\\_lines.​product\\_offering\n\n\n\nSys\\_id of the product offering record associated with the service contract line.Data type: String\n\nTable: Product Offering \\[sn\\_prd\\_pm\\_product\\_offering\\]\n\n
\n\nservice\\_contract\\_lines.​product\\_specification\n\n\n\nSys\\_id of the product specification record associated with the service contract line.Data type: String\n\nTable: Product Specification \\[sn\\_prd\\_pm\\_product\\_specification\\]\n\n
\n\nservice\\_contract\\_lines.​sold\\_product\n\n\n\nSys\\_id of the sold product record associated with the service contract line.Data type: String\n\nTable: Sold Product \\[sn\\_install\\_base\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​sold\\_products\\_covered\n\n\n\nList of products covered under the service contract line.\n\nData type: Array of Objects\n\n ```\n\"sold_products_covered\": [ \n {\n \"added\": \"String\",\n \"removed\": \"String\",\n \"sold_product\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​sold\\_products\\_covered.​added\n\n\n\nDate that the associated service contract line starts to cover the associated product.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Current date\n\n
\n\nservice\\_contract\\_lines.​sold\\_products\\_covered.​removed\n\n\n\nDate that the associated service contract line ends coverage of the associated product.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: No end date\n\n
\n\nservice\\_contract\\_lines.​sold\\_products\\_covered.​sold\\_product\n\n\n\nSys\\_id of a product associated with the service contract line.\n\nData type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​starts\n\n\n\nRequired. Start date of the service contract line.\n\nData type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nservice\\_contract\\_lines.​state\n\n\n\nRequired.Current state of the contract line.\n\nValid values: \\(case-sensitive\\)\n\n- active\n- cancelled\n- draft\n- expired\n- suspended\n\nData type: String\n\n
\n\nshort\\_description\n\n\n\nBrief description or name of the service contract.\n\nData type: String\n\n Default: null \\(empty string\\)\n\n
\n\nsold\\_products\\_covered\n\n\n\nRequired if the **install\\_base\\_items\\_covered** parameter is not specified. List of products covered under the service contract. The data in this parameter is inserted in the Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\] table.\n\nData type: Array of Objects\n\n```\n\"sold_products_covered\": [ \n {\n \"added\": \"String\",\n \"removed\": \"String\",\n \"sold_product\": \"String\"\n }\n]\n```\n\n
\n\nsold\\_products\\_covered.added\n\n\n\nDate that the associated service contract starts to cover the product.\n\nData type: String\n\n Format: yyyy-mm-dd\n\n Default: Current date\n\n
\n\nsold\\_products\\_covered.removed\n\n\n\nDate that the associated service contract ends coverage of the associated product.\n\nData type: String\n\n Format: yyyy-mm-dd\n\n Default: No end date\n\n
\n\nsold\\_products\\_covered.sold\\_product\n\n\n\nSys\\_id of the product covered by the service contract.Data type: String\n\nTable: Sold Product \\[sn\\_install\\_base\\_sold\\_product\\]\n\n
\n\nstarts\n\n\n\nRequired.Date on which the service contract begins.\n\nData type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nstate\n\n\n\nRequired.Current state of the service contract.\n\nValid values: \\(case-sensitive\\)\n\n- active\n- cancelled\n- draft\n- expired\n\nData type: String\n\n
\n\nvendor\\_contract\n\n\n\nRequired.Unique identifier for an associated external contract.\n\nData type: String\n\n
### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
\n\nContent-Type\n\n\n\nData format of the request body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|201|Successful. The request was successfully processed and the records were created.|\n|400|Bad Request. A bad request type or malformed request was detected.|\n|403|Forbidden. The user doesn't have permission to access the API.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\ninstall\\_base\\_items\\_covered\n\n\n\nList of sys\\_ids of the install base items covered under the service contract. Data type: Array of Objects\n\n```\n\"install_base_items_covered\": [ \n {\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\ninstall\\_base\\_items\\_covered.​sys\\_id\n\n\n\nSys\\_id of the install base item covered.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nnumber\n\n\n\nAuto-generated service contract number.Data type: String\n\n
\n\nservice\\_contract\\_lines\n\n\n\nList of service contract lines associated with the service contract.Data type: Array of Objects\n\n```\n\"service_contract_lines\": [\n {\n \"child_contract_lines\": [Array],\n \"entitlements\": [Array],\n \"entitlement_characteristics\": [Array],\n \"install_base_items_covered\": [Array],\n \"name\": \"String\",\n \"number\": \"String\",\n \"sold_products_covered\": [Array],\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines\n\n\n\nList of child service contract line objects created under the service contract line.Data type: Array of Objects\n\n```\n\"child_contract_lines\": [\n {\n \"child_contract_lines\": [Array],\n \"entitlements\": [Array],\n \"entitlement_characteristics\": [Array],\n \"install_base_items_covered\": [Array],\n \"name\": \"String\",\n \"number\": \"String\",\n \"sold_products_covered\": [Array],\n \"sys_id\" \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​child\\_contract\\_lines\n\n\n\nList of child service contract line objects created under the child service contract line. The objects in this array have the same elements as the **service\\_contract\\_lines.child\\_contract\\_lines** parameter.Data type: Array of Objects\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements\n\n\n\nList of entitlements associated with the child service contract line.Data type: Array of Objects\n\n```\n\"entitlements\": [\n {\n \"entitlement_name\": \"String\",\n \"entitlement_characteristics\": [Array],\n \"install_base_items_covered\": [Array],\n \"sold_products_covered\": [Array],\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_name\n\n\n\nName of the entitlement.\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics\n\n\n\nList of the entitlement characteristic objects  created under the entitlement. Data type: Array of Objects\n\n```\n\"entitlement_characteristics\": [\n {\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​sys\\_id\n\n\n\nSys\\_id of an entitlement characteristics record associated with the child service contract line.Data type: String\n\nTable: Characteristic \\[sn\\_pss\\_core\\_entitlement\\_characteristic\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered\n\n\n\nList of sys\\_ids of the install base items covered under the entitlement. Data type: Array of Objects\n\n```\n\"install_base_items_covered\": [ \n {\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​sys\\_id\n\n\n\nSys\\_id of a install base items covered by the entitlement.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​sold\\_products\\_covered\n\n\n\nList of sys\\_ids of the products covered under the entitlement. Data type: Array of Objects\n\n```\n\"sold_products_covered\": [ \n {\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​sys\\_id\n\n\n\nSys\\_id of a product associated with the entitlement.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlements.​sys\\_id\n\n\n\nSys\\_id of the entitlement record associated with the child service contract line.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlement\\_characteristics\n\n\n\nList of characteristics associated with the chile contract line. Data type: Array of Objects\n\n```\n\"entitlement_characteristics\": [\n {\n \"entitlement_usage\": {Object},\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage\n\n\n\nEntitlement usage object inserted under the entitlement\\_characteristic.Data type: Object\n\n```\n\"entitlement_usage\": {\n \"sys_id\": \"String\"\n}\n```\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_id\n\n\n\nSys\\_id of the entitlement usage record.Data type: String\n\nTable: Entitlement Usage \\[sn\\_pss\\_core\\_entitlement\\_usage\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​entitlement\\_characteristics.​sys\\_id\n\n\n\nSys\\_id of a entitlement characteristics record associated with the child service contract line.Data type: String\n\nTable: Characteristic \\[sn\\_pss\\_core\\_entitlement\\_characteristic\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​install\\_base\\_items\\_covered\n\n\n\nList of sys\\_ids of the install base items covered under the child contract line. Data type: Array of Objects\n\n```\n\"install_base_items_covered\": [ \n {\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​install\\_base\\_items\\_covered.​sys\\_id\n\n\n\nSys\\_id of the install base item covered.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​name\n\n\n\nName of the child service contract line.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​number\n\n\n\nUnique number of the service contract line. Automatically generated by the endpoint. For example: CTRL000001.Data type: String\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​sold\\_products\\_covered\n\n\n\nList of sys\\_ids of the products covered under the child service contract line. Data type: Array of Objects\n\n```\n\"sold_products_covered\": [ \n {\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​sold\\_products\\_covered.​sys\\_id\n\n\n\nSys\\_id of a product covered by the child service contract line.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​child\\_contract\\_lines.​sys\\_id\n\n\n\nSys\\_id of a child service contract line record.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements\n\n\n\nList of entitlements associated with the service contract.Data type: Array of Objects\n\n```\n\"entitlements\" [\n {\n \"entitlement_name\": \"String\",\n \"entitlement_characteristics\": [Array],\n \"install_base_items_covered\": [Array],\n \"sold_products_covered\": [Array],\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_name\n\n\n\nName of the entitlement.\n\nData type: String\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics\n\n\n\nList of the entitlement characteristic objects  created under the entitlement. Data type: Array of Objects\n\n```\n\"entitlement_characteristics\" [\n {\n \"entitlement_usage\": {Object},\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage\n\n\n\nEntitlement usage object inserted under the entitlement\\_characteristic.Data type: Object\n\n```\n\"entitlement_usage\": {\n \"sys_id\": \"String\"\n}\n```\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_id\n\n\n\nSys\\_id of the entitlement usage record.Data type: String\n\nTable: Entitlement Usage \\[sn\\_pss\\_core\\_entitlement\\_usage\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​sys\\_id\n\n\n\nSys\\_id of a entitlement characteristics record associated with the service contract line.Data type: String\n\nTable: Characteristic \\[sn\\_pss\\_core\\_entitlement\\_characteristic\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered\n\n\n\nList of sys\\_ids of the install base items covered under the entitlement. Data type: Array of Objects\n\n```\n\"install_base_items_covered\": [ \n {\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​sys\\_id\n\n\n\nSys\\_id of a install base items covered by the entitlement.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​sold\\_products\\_covered\n\n\n\nList of sys\\_ids of the products covered under the entitlement. Data type: Array of Objects\n\n```\n\"sold_products_covered\": [ \n {\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​sys\\_id\n\n\n\nSys\\_id of a product associated with the entitlement.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​entitlements.​sys\\_id\n\n\n\nSys\\_id of the entitlement record associated with the service contract line.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics\n\n\n\nList of characteristics associated with the chile contract line. Data type: Array of Objects\n\n```\n\"entitlement_characteristics\": [\n {\n \"entitlement_usage\": {Object},\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage\n\n\n\nEntitlement usage object inserted under the entitlement\\_characteristic.Data type: Object\n\n```\n\"entitlement_usage\": {\n \"sys_id\": \"String\"\n}\n```\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_id\n\n\n\nSys\\_id of the entitlement usage record.Data type: String\n\nTable: Entitlement Usage \\[sn\\_pss\\_core\\_entitlement\\_usage\\]\n\n
\n\nservice\\_contract\\_lines.​entitlement\\_characteristics.​sys\\_id\n\n\n\nSys\\_id of a entitlement characteristics record associated with the child service contract line.Data type: String\n\nTable: Characteristic \\[sn\\_pss\\_core\\_entitlement\\_characteristic\\]\n\n
\n\nservice\\_contract\\_lines.​install\\_base\\_items\\_covered\n\n\n\nList of sys\\_ids of the install base items covered under the child contract line. Data type: Array of Objects\n\n```\n\"install_base_items_covered\": [ \n {\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​install\\_base\\_items\\_covered.​sys\\_id\n\n\n\nSys\\_id of the install base item covered.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​name\n\n\n\nName of the child service contract line.Data type: String\n\n
\n\nservice\\_contract\\_lines.​number\n\n\n\nUnique number of the service contract line. Automatically generated by the endpoint. For example: CTRL000001.Data type: String\n\n
\n\nservice\\_contract\\_lines.​sold\\_products\\_covered\n\n\n\nList of sys\\_ids of the products covered under the service contract line. Data type: Array of Objects\n\n```\n\"sold_products_covered\": [ \n {\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nservice\\_contract\\_lines.​sold\\_products\\_covered.​sys\\_id\n\n\n\nSys\\_id of a product covered by the service contract line.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nservice\\_contract\\_lines.​sys\\_id\n\n\n\nSys\\_id of a service contract line record.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nshort\\_description\n\n\n\nBrief description or name of the service contract.\n\nData type: String\n\n
\n\nsold\\_products\\_covered\n\n\n\nList of sys\\_ids of the products covered under the service contract. Data type: Array of Objects\n\n```\n\"sold_products_covered\": [ \n {\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nsold\\_products\\_covered.​sys\\_id\n\n\n\nSys\\_id of a product covered by the service contract.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of the service contract record.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
### cURL request\n\nThe following is a code example that shows how to call this endpoint and create a service contract with one sold product covered record, one install base items covered record, and two service contract lines.\n\n```\ncurl \"https://instance.servicenow.com/api/sn_pss_core/servicecontract\" \\\n--request POST \\\n--header \"Accept:application/json\" \\\n--data\n{\n \"state\": \"active\",\n \"account\": \"4c325111d1f53110f8776589fa411f3d\",\n \"vendor_contract\": \"External Reference\",\n \"starts\": \"2022-12-03\",\n \"service_contract_lines\": [\n {\n \"state\": \"active\",\n \"name\": \"CLI\",\n \"starts\": \"2022-12-03\",\n \"child_contract_lines\": [\n {\n \"state\": \"active\",\n \"name\": \"Child CLI\",\n \"starts\": \"2022-12-03\",\n \"entitlements\": [\n {\n \"state\": \"active\",\n \"entitlement_name\": \"Child CLI - ENTL\",\n \"start_date\": \"2022-12-03\"\n }\n ],\n \"sold_products_covered\": [\n {\n \"sold_product\": \"8db4258949f14ef7b90d90822dfc5800\",\n \"added\": \"2023-12-03\",\n \"removed\": \"2023-12-03\"\n }\n ],\n \"install_base_items_covered\": [\n {\n \"install_base\": \"2f270832699b46e78aa899a5a5dc6682\",\n \"added\": \"2023-12-03\",\n \"removed\": \"2023-12-03\"\n }\n ],\n \"entitlement_characteristics\": [\n {\n \"characteristic\": \"63418db7539e61106bfcddeeff7b1238\",\n \"characteristic_option\": \"495149b7539e61106bfcddeeff7b1262\",\n \"value\": \"20\",\n \"type\": \"coverage\"\n }\n ]\n }\n ],\n \"entitlements\": [\n {\n \"state\": \"active\",\n \"entitlement_name\": \"ENTL\",\n \"start_date\": \"2022-12-03\",\n \"sold_products_covered\": [\n {\n \"sold_product\": \"da23d151d1f53110f8776589fa411f27\"\n }\n ],\n \"install_base_items_covered\": [\n {\n \"install_base\": \"43739151d1f53110f8776589fa411fc1\",\n \"added\": \"2023-12-03\",\n \"removed\": \"2023-12-03\"\n }\n ],\n \"entitlement_characteristics\": [\n {\n \"characteristic\": \"63418db7539e61106bfcddeeff7b1238\",\n \"characteristic_option\": \"495149b7539e61106bfcddeeff7b1262\",\n \"value\": \"20\",\n \"type\": \"coverage_and_usage\",\n \"entitlement_usage\": {\n \"used_units\": \"3\"\n }\n }\n ]\n }\n ],\n \"sold_products_covered\": [\n {\n \"sold_product\": \"ec235d9dd1b53110f8776589fa411fe2\",\n \"added\": \"2023-12-03\",\n \"removed\": \"2023-12-03\"\n }\n ],\n \"install_base_items_covered\": [\n {\n \"install_base\": \"a1731551d1f53110f8776589fa411f8d\",\n \"added\": \"2023-12-03\",\n \"removed\": \"2023-12-03\"\n }\n ],\n \"entitlement_characteristics\": [\n {\n \"characteristic\": \"63418db7539e61106bfcddeeff7b1238\",\n \"characteristic_option\": \"495149b7539e61106bfcddeeff7b1262\",\n \"value\": \"20\",\n \"type\": \"coverage\"\n }\n ]\n },\n {\n \"state\": \"active\",\n \"name\": \"CLI 2\",\n \"starts\": \"2022-12-03\",\n \"sold_products_covered\": [\n {\n \"sold_product\": \"7f23995dd1b53110f8776589fa411f66\",\n \"added\": \"2023-12-03\",\n \"removed\": \"2023-12-03\"\n }\n ],\n \"install_base_items_covered\": [\n {\n \"install_base\": \"a483d951d1f53110f8776589fa411fad\",\n \"added\": \"2023-12-03\",\n \"removed\": \"2023-12-03\"\n }\n ],\n \"entitlement_characteristics\": [\n {\n \"characteristic\": \"63418db7539e61106bfcddeeff7b1238\",\n \"characteristic_option\": \"495149b7539e61106bfcddeeff7b1262\",\n \"value\": \"20\",\n \"type\": \"coverage\"\n }\n ]\n }\n ],\n \"sold_products_covered\": [\n {\n \"sold_product\": \"0df21151d1f53110f8776589fa411f1b\",\n \"added\": \"2023-12-03\",\n \"removed\": \"2023-12-03\"\n }\n ],\n \"install_base_items_covered\": [\n {\n \"install_base\": \"e2639951d1f53110f8776589fa411f2b\",\n \"added\": \"2023-12-03\",\n \"removed\": \"2023-12-03\"\n }\n ]\n} \n--user \"username\":\"password\"\n```\n\nResponse:\n\n```\n{\n \"result\": {\n \"sys_id\": \"d8641151d1f53110f8776589fa411fde\",\n \"number\": \"CNTR0010004\",\n \"short_description\": null,\n \"service_contract_lines\": [\n {\n \"sys_id\": \"d4641d91d1f53110f8776589fa411fbb\",\n \"name\": \"CLI\",\n \"number\": \"CTRL0000001, \n \"child_contract_lines\": [\n {\n \"sys_id\": \"3a39ecdc01154f4ab782da0169c9c922\",\n \"name\": \"Child CLI\",\n \"number\": \"CTRL0000002\",\n \"child_contract_lines\": [],\n \"entitlements\": [\n {\n \"sys_id\": \"7439fd84c2494ba6951e58f333cfe8d4\",\n \"entitlement_name\": \"Child CLI - ENTL\",\n \"sold_products_covered\": [],\n \"install_base_items_covered\": [],\n \"entitlement_characteristics\": []\n }\n ],\n \"sold_products_covered\": [\n {\n \"sys_id\": \"dfb62e9c4c6843009be02a68f65b9118\"\n }\n ],\n \"install_base_items_covered\": [\n {\n \"sys_id\": \"2583912e81964501b52a2e44d4797a28\"\n }\n ],\n \"entitlement_characteristics\": [\n {\n \"sys_id\": \"3a00c975bb49412cae169200c7f6236e\",\n \"entitlement_usage\": {}\n }\n ]\n }\n ],\n \"entitlements\": [\n {\n \"sys_id\": \"a8641d91d1f53110f8776589fa411fc0\",\n \"entitlement_name\": \"ENTL\",\n \"sold_products_covered\": [\n {\n \"sys_id\": \"a0641d91d1f53110f8776589fa411fc2\"\n }\n ],\n \"install_base_items_covered\": [\n {\n \"sys_id\": \"e0641d91d1f53110f8776589fa411fc3\"\n }\n ],\n \"entitlement_characteristics\": [\n {\n \"sys_id\": \"a8641d91d1f53110f8776589fa411fd0\",\n \"entitlement_usage\": {\n \"sys_id\": \"a8641d91d1f53110f8776589fa411fd1\"\n }\n }\n ]\n }\n ],\n \"sold_products_covered\": [\n {\n \"sys_id\": \"98641d91d1f53110f8776589fa411fbc\"\n }\n ],\n \"install_base_items_covered\": [\n {\n \"sys_id\": \"58641d91d1f53110f8776589fa411fbd\"\n }\n ],\n \"entitlement_characteristics\": [\n {\n \"sys_id\": \"e0641d91d1f53110f8776589fa411fbf\",\n \"entitlement_usage\": {}\n }\n ]\n },\n {\n \"sys_id\": \"e4641d91d1f53110f8776589fa411fd2\",\n \"name\": \"CLI 2\",\n \"number\": \"CTRL0000003\",\n \"child_contract_lines\": [],\n \"entitlements\": [],\n \"sold_products_covered\": [\n {\n \"sys_id\": \"e8641d91d1f53110f8776589fa411fd3\"\n }\n ],\n \"install_base_items_covered\": [\n {\n \"sys_id\": \"a8641d91d1f53110f8776589fa411fd4\"\n }\n ],\n \"entitlement_characteristics\": [\n {\n \"sys_id\": \"a8641d91d1f53110f8776589fa411fd5\",\n \"entitlement_usage\": {}\n }\n ]\n }\n ],\n \"sold_products_covered\": [\n {\n \"sys_id\": \"9c641d91d1f53110f8776589fa411fb9\"\n }\n ],\n \"install_base_items_covered\": [\n {\n \"sys_id\": \"d8641d91d1f53110f8776589fa411fba\"\n }\n ]\n }\n}\n```\n\n## Service Contract - POST /sn\\_pss\\_core/servicecontract/contractline\n\nCreates a contract line record and all of its related entities.\n\nThis endpoint stores data in the following tables when processing the request:\n\n- Characteristic \\[sn\\_pss\\_core\\_entitlement\\_characteristic\\]\n- Entitlement \\[service\\_entitlement\\]\n- Entitlement Usage \\[sn\\_pss\\_core\\_entitlement\\_usage\\]\n- Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\] - This table contains information for both sold products covered and install base items covered.\n- Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n### URL format\n\nVersioned URL: `/api/sn_pss_core/{api_version}/servicecontract/contractline`\n\nDefault URL: `/api/sn_pss_core/servicecontract/contractline`\n\n**Note:** Available versions are specified in the [REST API Explorer](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/use-REST-API-Explorer.md). For scripted REST APIs there is additional version information on the [Scripted REST Service form](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_CustomWebServices.md).\n\n### Supported request parameters\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\napi\\_version\n\n\n\nOptional. 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\n\n
|Name|Description|\n|----|-----------|\n|None| |\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nchild\\_contract\\_lines\n\n\n\nList of child service contract line objects created under the service contract line. Data type: Array of Objects\n\n```\n\"child_contract_lines\": [\n {\n \"child_contract_lines\": [Array],\n \"contract\": \"String\",\n \"ends\": \"String\",\n \"entitlements\": [Array],\n \"entitlement_characteristics\": [Array],\n \"install_base_items_covered\": [Array],\n \"name\": \"String\",\n \"parent_contract_line\": \"String\",\n \"product_model\": \"String\",\n \"product_offering\": \"String\",\n \"product_specification\": \"String\",\n \"sold_product\": \"String\",\n \"sold_products_covered\": [Array],\n \"starts\": \"String\",\n \"state\": \"String\"\n }\n]\n```\n\nStored in: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nchild\\_contract\\_lines.​child\\_contract\\_lines\n\n\n\nList of child service contract line objects to create under the child service contract line. The objects in this array have the same elements as the objects in the **child\\_contract\\_lines** parameter.Data type: Array of Objects\n\n
\n\nchild\\_contract\\_lines.​contract\n\n\n\nSys\\_id of the service contract associated with the child service contract line.Data type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nchild\\_contract\\_lines.​ends\n\n\n\nDate on which the child service contract line ends.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Never ends until manually removed.\n\n
\n\nchild\\_contract\\_lines.​entitlements\n\n\n\nList of entitlements associated with the child service contract line.Data type: Array of Objects\n\n```\n\"entitlements:\" [\n {\n \"account\": \"String\",\n \"consumer\": \"String\",\n \"end_date\": \"String\",\n \"entitlement_characteristics\": [Array],\n \"entitlement_name\": \"String\",\n \"household\": \"String\",\n \"install_base_items_covered\": [Array],\n \"product\": \"String\",\n \"product_offering\": \"String\",\n \"product_specification\": \"String\",\n \"sold_entitlement\": \"String\",\n \"sold_products_covered\": [Array],\n \"start_date\": \"String\",\n \"state\": \"String\"\n }\n]\n```\n\nStored in: Entitlement \\[service\\_entitlement\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​account\n\n\n\nRequired if the **consumer** parameter is not passed.Sys\\_id of the account record to which the entitlement belongs.\n\nData type: String\n\nTable: Account \\[customer\\_account\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​consumer\n\n\n\nRequired if the **account** parameter is not passed.Sys\\_id of the consumer record to which the entitlement belongs.\n\nData type: String\n\nTable: Consumer \\[csm\\_consumer\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​end\\_date\n\n\n\nEnd date of the entitlement.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Never ends until manually removed.\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_characteristics\n\n\n\nList of characteristics associated with the entitlement.Data type: Array of Objects\n\n```\n\"entitlement_characteristics\": [\n {\n \"characteristic\": \"String\",\n \"characteristic_option\": \"String\",\n \"entitlement_usage\": {Object},\n \"type\": \"String\",\n \"value\": \"String\"\n }\n]\n```\n\nStored in: Characteristic \\[sn\\_pss\\_core\\_entitlement\\_characteristic\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.characteristic\n\n\n\nRequired. Sys\\_id of the characteristic record associated with the entitlement.\n\nData type: String\n\nTable: Characteristic \\[sn\\_prd\\_pm\\_characteristic\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.characteristic\\_option\n\n\n\nSys\\_id of the characteristic option record associated with the entitlement.Data type: String\n\nTable: Characteristic Option \\[sn\\_prd\\_pm\\_characteristic\\_option\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.entitlement\\_usage\n\n\n\nUsed unit value for the associated entitlement characteristic.Only pass this parameter if the entitlement\\_characteristics are under the entitlement.\n\nData type: Object\n\n```\n\"entitlement_usage\": {\n \"used_units\": \"String\"\n}\n```\n\nStored in: Entitlement Usage \\[sn\\_pss\\_core\\_entitlement\\_usage\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.entitlement\\_usage.​used\\_units\n\n\n\nUsage of the associated entitlement characteristic.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.type\n\n\n\nType of entitlement characteristic. Valid values:\n\n- coverage\n- coverage\\_and\\_usage\n\nData type: String\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.value\n\n\n\nRequired if the **input\\_type** parameter contained in the record specified in the **entitlement\\_characteristics.characteristic** parameter, is not `choice`.Value of the characteristic.\n\nData type: String\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_name\n\n\n\nRequired. Name of the entitlement.\n\nData type: String\n\n
\n\nchild\\_contract\\_lines.​entitlements.​household\n\n\n\nOnly passed when the household plugins are active and the **consumer** parameter is passed. Sys\\_id of the household record associated with the entitlement.\n\nData type: String\n\nTable: Household \\[csm\\_household\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered\n\n\n\nList of install base items covered under the entitlement. The information in this array is inserted in the Sold Product Covered  \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\] table.\n\nData type: Array of Objects\n\n ```\n\"install_base_items_covered\": [ \n {\n \"added\": \"String\",\n \"install_base\": \"String\",\n \"removed\": \"String\"\n }\n]\n```\n\n
\n\nchild\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​added\n\n\n\nDate that the associated install base item was added to the entitlement.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Current date\n\n
\n\nchild\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​install\\_base\n\n\n\nSys\\_id of the install base item covered by the entitlement.Data type: String\n\nTable: Install Base Item \\[sn\\_install\\_base\\_item\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​removed\n\n\n\nDate that the associated install base item was removed from the entitlement.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: No end date\n\n
\n\nchild\\_contract\\_lines.​entitlements.​product\n\n\n\nSys\\_id of the product model record associated with the entitlement.Data type: String\n\nTable: Product Model \\[cmdb\\_model\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​product\\_offering\n\n\n\nSys\\_id of the product offering record associated with the entitlement.Data type: String\n\nTable: Product Offering \\[sn\\_prd\\_pm\\_product\\_offering\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​product\\_specification\n\n\n\nSys\\_id of the product specification record associated with the entitlement.Data type: String\n\nTable: Product Specification \\[sn\\_prd\\_pm\\_product\\_specification\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​sold\\_entitlement\n\n\n\nSys\\_id of the sold product record associated with the entitlement.Data type: String\n\nTable: Sold Product \\[sn\\_install\\_base\\_sold\\_product\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​sold\\_products\\_covered\n\n\n\nList of sold products covered under the entitlement. Data type: Array of Objects\n\n```\n\"sold_products_covered\": [ \n {\n \"added\": \"String\",\n \"removed\": \"String\",\n \"sold_product\": \"String\"\n }\n]\n```\n\n
\n\nchild\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​added\n\n\n\nDate that the associated sold product was added to the entitlement.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Current date\n\n
\n\nchild\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​removed\n\n\n\nDate that the associated sold product was removed from the entitlement.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: No end date\n\n
\n\nchild\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​sold\\_product\n\n\n\nSys\\_id of a product associated with the entitlement.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​start\\_date\n\n\n\nRequired. Start date of the entitlement.\n\nData type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nchild\\_contract\\_lines.​entitlements.​state\n\n\n\nRequired.Current state of the entitlement.\n\nValid values: \\(case-sensitive\\)\n\n- active\n- cancelled\n- draft\n- expired\n- suspended\n\nData type: String\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics\n\n\n\nList of characteristics associated with the entitlement.Data type: Array of Objects\n\n```\n\"entitlement_characteristics\": [\n {\n \"characteristic\": \"String\",\n \"characteristic_option\": \"String\",\n \"entitlement_usage\": {Object},\n \"type\": \"String\",\n \"value\": \"String\"\n }\n]\n```\n\nStored in: Characteristic \\[sn\\_pss\\_core\\_entitlement\\_characteristic\\]\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​characteristic\n\n\n\nSys\\_id of the characteristic record associated with the entitlement.\n\nData type: String\n\nTable: Characteristic \\[sn\\_prd\\_pm\\_characteristic\\]\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​characteristic\\_option\n\n\n\nSys\\_id of the characteristic option record associated with the entitlement.Data type: String\n\nTable: Characteristic Option \\[sn\\_prd\\_pm\\_characteristic\\_option\\]\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage\n\n\n\nUsed unit value for the associated entitlement characteristic.Only pass this parameter if the entitlement\\_characteristics are under the entitlement.\n\nData type: Object\n\n```\n\"entitlement_usage\": {\n \"used_units\": \"String\"\n}\n```\n\nStored in: Entitlement Usage \\[sn\\_pss\\_core\\_entitlement\\_usage\\]\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage.​used\\_units\n\n\n\nUsage of the associated entitlement characteristic.Data type: String\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​type\n\n\n\nType of entitlement characteristic. Valid values:\n\n- coverage\n- coverage\\_and\\_usage\n\nData type: String\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​value\n\n\n\nValue of the characteristic.\n\nData type: String\n\n
\n\nchild\\_contract\\_lines.​install\\_base\\_items\\_covered\n\n\n\nList of install base items covered under the entitlement. The information in this array is inserted in the Sold Product Covered  \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\] table.\n\nData type: Array of Objects\n\n ```\n\"install_base_items_covered\": [ \n {\n \"added\": \"String\",\n \"install_base\": \"String\",\n \"removed\": \"String\"\n }\n]\n```\n\n
\n\nchild\\_contract\\_lines.​install\\_base\\_items\\_covered.​added\n\n\n\nDate that the associated install base item was added to the child service contract line.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Current date\n\n
\n\nchild\\_contract\\_lines.​install\\_base\\_items\\_covered.​install\\_base\n\n\n\nSys\\_id of the install base item covered by the child service contract line. Data type: String\n\nTable: Install Base Item \\[sn\\_install\\_base\\_item\\]\n\n
\n\nchild\\_contract\\_lines.​install\\_base\\_items\\_covered.​removed\n\n\n\nDate that the associated child service contract line ends coverage of the install base item.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: No end date\n\n
\n\nchild\\_contract\\_lines.​name\n\n\n\nName of the child service contract line.Data type: String\n\n
\n\nchild\\_contract\\_lines.​parent\\_contract\\_line\n\n\n\nSys\\_id of the parent contract line record associated with the child service contract line.Data type: String\n\n
\n\nchild\\_contract\\_lines.​product\\_model\n\n\n\nSys\\_id of the product associated with the child service contract line.Data type: String\n\nTable: Product Model \\[cmdb\\_model\\]\n\n
\n\nchild\\_contract\\_lines.​product\\_offering\n\n\n\nSys\\_id of the product offering record associated with the child service contract line.Data type: String\n\nTable: Product Offering \\[sn\\_prd\\_pm\\_product\\_offering\\]\n\n
\n\nchild\\_contract\\_lines.​product\\_specification\n\n\n\nSys\\_id of the product specification record associated with the child service contract line.Data type: String\n\nTable: Product Specification \\[sn\\_prd\\_pm\\_product\\_specification\\]\n\n
\n\nchild\\_contract\\_lines.​sold\\_product\n\n\n\nSys\\_id of the sold product record associated with the child service contract line.Data type: String\n\nTable: Sold Product \\[sn\\_install\\_base\\_sold\\_product\\]\n\n
\n\nchild\\_contract\\_lines.​sold\\_products\\_covered\n\n\n\nList of products covered under the child service contract line.Data type: Array of Objects\n\n```\n\"sold_products_covered\": [ \n {\n \"added\": \"String\",\n \"removed\": \"String\",\n \"sold_product\": \"String\"\n }\n]\n```\n\n
\n\nchild\\_contract\\_lines.​sold\\_products\\_covered.​added\n\n\n\nDate that the associated child service contract line starts to cover the associated product.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Current date\n\n
\n\nchild\\_contract\\_lines.​sold\\_products\\_covered.​removed\n\n\n\nDate that the associated child service contract line ends coverage of the associated product.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: No end date\n\n
\n\nchild\\_contract\\_lines.​sold\\_products\\_covered.​sold\\_product\n\n\n\nSys\\_id of a product associated with the child service contract line.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nchild\\_contract\\_lines.​starts\n\n\n\nStart date of the child service contract line.Data type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nchild\\_contract\\_lines.​state\n\n\n\nCurrent state of the contract line.\n\nValid values: \\(case-sensitive\\)\n\n- active\n- cancelled\n- draft\n- expired\n- suspended\n\nData type: String\n\n
\n\ncontract\n\n\n\nSys\\_id of the service contract associated with the service contract line.\n\nData type: String\n\nTable: Service Contract \\[sn\\_pss\\_core\\_service\\_contract\\]\n\n
\n\nends\n\n\n\nDate on which the service contract line ends.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Never ends until manually removed.\n\n
\n\nentitlements\n\n\n\nList of entitlements to associate with the service contract line. These entitlements are inserted in the Entitlement \\[service\\_entitlement\\] table.Data type: Array of Objects\n\n```\n\"entitlements:\" [\n {\n \"account\": \"String\",\n \"consumer\": \"String\",\n \"end_date\": \"String\",\n \"entitlement_characteristics\": [Array],\n \"entitlement_name\": \"String\",\n \"household\": \"String\",\n \"install_base_items_covered\": [Array],\n \"product\": \"String\",\n \"product_offering\": \"String\",\n \"product_specification\": \"String\",\n \"sold_entitlement\": \"String\",\n \"sold_products_covered\": [Array],\n \"start_date\": \"String\",\n \"state\": \"String\"\n }\n]\n```\n\n
\n\nentitlements.​account\n\n\n\nRequired if the **consumer** parameter is not passed.Sys\\_id of the account record to which the entitlement belongs.\n\nData type: String\n\nTable: Account \\[customer\\_account\\]\n\n
\n\nentitlements.​consumer\n\n\n\nRequired if the **account** parameter is not passed.Sys\\_id of the consumer record to which the entitlement belongs.\n\nData type: String\n\nTable: Consumer \\[csm\\_consumer\\]\n\n
\n\nentitlements.​end\\_date\n\n\n\nEnd date of the entitlement.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Never ends until manually removed.\n\n
\n\nentitlements.​entitlement\\_characteristics\n\n\n\nList of characteristics associated with the entitlement.Data type: Array of Objects\n\n```\n\"entitlement_characteristics\": [\n {\n \"characteristic\": \"String\",\n \"characteristic_option\": \"String\",\n \"entitlement_usage\": {Object},\n \"type\": \"String\",\n \"value\": \"String\"\n }\n]\n```\n\nStored in: Characteristic \\[sn\\_pss\\_core\\_entitlement\\_characteristic\\]\n\n
\n\nentitlements.​entitlement\\_characteristics.characteristic\n\n\n\nRequired. Sys\\_id of the characteristic record associated with the entitlement.\n\nData type: String\n\nTable: Characteristic \\[sn\\_prd\\_pm\\_characteristic\\]\n\n
\n\nentitlements.​entitlement\\_characteristics.characteristic\\_option\n\n\n\nSys\\_id of the characteristic option record associated with the entitlement.Data type: String\n\nTable: Characteristic Option \\[sn\\_prd\\_pm\\_characteristic\\_option\\]\n\n
\n\nentitlements.​entitlement\\_characteristics.entitlement\\_usage\n\n\n\nUsed unit value for the associated entitlement characteristic.Only pass this parameter if the entitlement\\_characteristics are under the entitlement.\n\nData type: Object\n\n```\n\"entitlement_usage\": {\n \"used_units\": \"String\"\n}\n```\n\nStored in: Entitlement Usage \\[sn\\_pss\\_core\\_entitlement\\_usage\\]\n\n
\n\nentitlements.​entitlement\\_characteristics.entitlement\\_usage.​used\\_units\n\n\n\nUsage of the associated entitlement characteristic.Data type: String\n\n
\n\nentitlements.​entitlement\\_characteristics.type\n\n\n\nType of entitlement characteristic. Valid values:\n\n- coverage\n- coverage\\_and\\_usage\n\nData type: String\n\n
\n\nentitlements.​entitlement\\_characteristics.value\n\n\n\nRequired if the **input\\_type** parameter contained in the record specified in the **entitlement\\_characteristics.characteristic** parameter, is not `choice`.Value of the characteristic.\n\nData type: String\n\n
\n\nentitlements.​entitlement\\_name\n\n\n\nRequired. Name of the entitlement.\n\nData type: String\n\n
\n\nentitlements.​household\n\n\n\nOnly passed when the household plugins are active and the **consumer** parameter is passed. Sys\\_id of the household record associated with the entitlement.\n\nData type: String\n\nTable: Household \\[csm\\_household\\]\n\n
\n\nentitlements.​install\\_base\\_items\\_covered\n\n\n\nList of install base items covered under the entitlement. The information in this array is inserted in the Sold Product Covered  \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\] table.\n\nData type: Array of Objects\n\n ```\n\"install_base_items_covered\": [ \n {\n \"added\": \"String\",\n \"install_base\": \"String\",\n \"removed\": \"String\"\n }\n]\n```\n\n
\n\nentitlements.​install\\_base\\_items\\_covered.​added\n\n\n\nDate that the associated install base item was added to the entitlement.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Current date\n\n
\n\nentitlements.​install\\_base\\_items\\_covered.​removed\n\n\n\nDate that the associated install base item was removed from the entitlement.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: No end date\n\n
\n\nentitlements.​product\n\n\n\nSys\\_id of the product model record associated with the entitlement.Data type: String\n\nTable: Product Model \\[cmdb\\_model\\]\n\n
\n\nentitlements.​product\\_offering\n\n\n\nSys\\_id of the product offering record associated with the entitlement.Data type: String\n\nTable: Product Offering \\[sn\\_prd\\_pm\\_product\\_offering\\]\n\n
\n\nentitlements.​product\\_specification\n\n\n\nSys\\_id of the product specification record associated with the entitlement.Data type: String\n\nTable: Product Specification \\[sn\\_prd\\_pm\\_product\\_specification\\]\n\n
\n\nentitlements.​sold\\_entitlement\n\n\n\nSys\\_id of the sold product record associated with the entitlement.Data type: String\n\nTable: Sold Product \\[sn\\_install\\_base\\_sold\\_product\\]\n\n
\n\nentitlements.​sold\\_products\\_covered\n\n\n\nList of sold products covered under the entitlement. Data type: Array of Objects\n\n```\n\"sold_products_covered\": [ \n {\n \"added\": \"String\",\n \"removed\": \"String\",\n \"sold_product\": \"String\"\n }\n]\n```\n\n
\n\nentitlements.​sold\\_products\\_covered.​added\n\n\n\nDate that the associated sold product was added to the entitlement.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Current date\n\n
\n\nentitlements.​sold\\_products\\_covered.​removed\n\n\n\nDate that the associated sold product was removed from the entitlement.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: No end date\n\n
\n\nentitlements.​sold\\_products\\_covered.​sold\\_product\n\n\n\nSys\\_id of a product associated with the entitlement.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nentitlements.​start\\_date\n\n\n\nRequired. Start date of the entitlement.\n\nData type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nentitlements.​state\n\n\n\nRequired.Current state of the entitlement.\n\nValid values: \\(case-sensitive\\)\n\n- active\n- cancelled\n- draft\n- expired\n- suspended\n\nData type: String\n\n
\n\nentitlement\\_characteristics\n\n\n\nList of characteristics associated with the service contract line.Data type: Array of Objects\n\n```\n\"entitlement_characteristics\" [\n {\n \"characteristic\": \"String\",\n \"characteristic_option\": \"String\",\n \"entitlement_usage\": {Object},\n \"type\": \"String\",\n \"value\": \"String\"\n }\n]\n```\n\nStored in: Characteristic \\[sn\\_pss\\_core\\_entitlement\\_characteristic\\]\n\n
\n\nentitlement\\_characteristics.​characteristic\n\n\n\nRequired. Sys\\_id of the characteristic record associated with the service contract line.\n\nData type: String\n\nTable: Characteristic \\[sn\\_prd\\_pm\\_characteristic\\]\n\n
\n\nentitlement\\_characteristics.​characteristic\\_option\n\n\n\nRequired if the **input\\_type** parameter contained in the record specified in the **entitlement\\_characteristics.characteristic** parameter, is set to `choice`.Sys\\_id of the characteristic option record associated with the service contract line.\n\nData type: String\n\nTable: Characteristic Option \\[sn\\_prd\\_pm\\_characteristic\\_option\\]\n\n
\n\nentitlement\\_characteristics.​entitlement\\_usage\n\n\n\nUsed unit value for the associated service contract line characteristic.Data type: Object\n\n```\n\"entitlement_usage\": {\n \"used_units\": \"String\"\n}\n```\n\nStored in: Entitlement Usage \\[sn\\_pss\\_core\\_entitlement\\_usage\\]\n\n
\n\nentitlement\\_characteristics.​entitlement\\_usage.​used\\_units\n\n\n\nUsage of the associated entitlement characteristic.Data type: String\n\n
\n\nentitlement\\_characteristics.​type\n\n\n\nType of service contract line characteristic. Valid values:\n\n- coverage\n- coverage \\_and\\_usage\n\nData type: String\n\n
\n\nentitlement\\_characteristics.​value\n\n\n\nRequired if the **entitlement\\_characteristics.type** parameter is not passed. Value of the characteristic.\n\nData type: String\n\n
\n\ninstall\\_base\\_items\\_covered\n\n\n\nRequired if the **sold\\_products\\_covered** parameter is not passed.List of install base items covered under the  service contract line.\n\nData type: Array of Objects\n\n```\n \"install_base_items_covered\": [ \n {\n \"added\": \"String\",\n \"install_base\": \"String\",\n \"removed\": \"String\"\n }\n]\n```\n\nStored in: Sold Product Covered  \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\ninstall\\_base\\_items\\_covered.​added\n\n\n\nDate that the associated install base item was added to the service contract line.\n\nData type: String\n\n Format: yyyy-mm-dd\n\n Default: Current date\n\n
\n\ninstall\\_base\\_items\\_covered.​install\\_base\n\n\n\nSys\\_id of the install base item covered by the service contract line.Data type: String\n\nTable: Install Base Item \\[sn\\_install\\_base\\_item\\]\n\n
\n\ninstall\\_base\\_items\\_covered.​removed\n\n\n\nDate that the associated service contract line ends coverage of the install base item.\n\nData type: String\n\n Format: yyyy-mm-dd\n\n Default: No end date\n\n
\n\nname\n\n\n\nRequired. Name of the service contract line.\n\nData type: String\n\n
\n\nparent\\_contract\\_line\n\n\n\nSys\\_id of the service contract line to which the current service contract line is a child of.Null for the contract lines created under a contract.\n\nData type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
\n\nproduct\\_model\n\n\n\nSys\\_id of the product associated with the service contract line.Data type: String\n\nTable: Product Model \\[cmdb\\_model\\]\n\n
\n\nproduct\\_offering \n\n\n\nSys\\_id of the product offering record associated with the service contract line.Data type: String\n\nTable: Product Offering \\[sn\\_prd\\_pm\\_product\\_offering\\]\n\n
\n\nproduct\\_specification\n\n\n\nSys\\_id of the product specification record associated with the service contract line.Data type: String\n\nTable: Product Specification \\[sn\\_prd\\_pm\\_product\\_specification\\]\n\n
\n\nsold\\_product\n\n\n\nSys\\_id of the sold product record associated with the service contract line.Data type: String\n\nTable: Sold Product \\[sn\\_install\\_base\\_sold\\_product\\]\n\n
\n\nsold\\_products\\_covered\n\n\n\nRequired if the **install\\_base\\_items\\_covered** parameter is not passed.List of products covered under the service contract line.\n\nData type: Array of Objects\n\n```\n\"sold_products_covered\": [ \n {\n \"added\": \"String\",\n \"removed\": \"String\",\n \"sold_product\": \"String\"\n }\n]\n```\n\nData is stored in the Sold Products Covered  \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\] table.\n\n
\n\nsold\\_products\\_covered.​added\n\n\n\nDate that the associated service contract line starts to cover the associated product.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: Current date\n\n
\n\nsold\\_products\\_covered.​removed\n\n\n\nDate that the associated service contract line ends coverage of the associated product.Data type: String\n\nFormat: yyyy-mm-dd\n\nDefault: No end date\n\n
\n\nsold\\_products\\_covered.​sold\\_product\n\n\n\nSys\\_id of a product associated with the service contract line.\n\nData type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nstarts\n\n\n\nRequired. Start date of the service contract line.\n\nData type: String\n\nFormat: yyyy-mm-dd\n\n
\n\nstate\n\n\n\nRequired.Current state of the contract line.\n\nValid values: \\(case-sensitive\\)\n\n- active\n- cancelled\n- draft\n- expired\n- suspended\n\nData type: String\n\n
### Headers\n\nThe following request and response headers apply to this HTTP action only, or apply to this action in a distinct way. For a list of general headers used in the REST API, see [Supported REST API headers](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n\n
\n\nHeader\n\n\n\nDescription\n\n
\n\nAccept\n\n\n\nData format of the response body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
\n\nContent-Type\n\n\n\nData format of the request body. Supported types: **application/json** or **application/xml**. Default: **application/json**\n\n
|Header|Description|\n|------|-----------|\n|None| |\n\n### Status codes\n\nThe following status codes apply to this HTTP action. For a list of possible status codes used in the REST API, see [REST API HTTP response codes](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/rest-api-explorer/c_RESTAPI.md).\n\n|Status code|Description|\n|-----------|-----------|\n|201|Successful. The request was successfully processed and the records were created.|\n|400|Bad Request. A bad request type or malformed request was detected.|\n|403|Forbidden. The user doesn't have permission to access the API.|\n|500|Internal server error. An unexpected error occurred while processing the request. The response contains additional information about the error.|\n\n### Response body parameters \\(JSON or XML\\)\n\n\n
\n\nName\n\n\n\nDescription\n\n
\n\nchild\\_contract\\_lines\n\n\n\nList of child service contract line objects created under the service contract line.Data type: Array of Objects\n\n```\n\"child_contract_lines\": [\n {\n \"child_contract_lines\": [Array],\n \"entitlements\": [Array],\n \"entitlement_characteristics\": [Array],\n \"install_base_items_covered\": [Array],\n \"name\": \"String\",\n \"number\": \"String\",\n \"sold_products_covered\": [Array],\n \"sys_id\" \"String\"\n }\n]\n```\n\n
\n\nchild\\_contract\\_lines.​child\\_contract\\_lines\n\n\n\nList of child service contract line objects created under the child service contract line. The objects in this array have the same elements as the **child\\_contract\\_lines** parameter.Data type: Array of Objects\n\n
\n\nchild\\_contract\\_lines.​entitlements\n\n\n\nList of entitlements associated with the child service contract line.Data type: Array of Objects\n\n```\n\"entitlements\": [\n {\n \"entitlement_name\": \"String\",\n \"entitlement_characteristics\": [Array],\n \"install_base_items_covered\": [Array],\n \"sold_products_covered\": [Array],\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_name\n\n\n\nName of the entitlement.\n\nData type: String\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_characteristics\n\n\n\nList of the entitlement characteristic objects  created under the entitlement. Data type: Array of Objects\n\n```\n\"entitlement_characteristics\": [\n {\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nchild\\_contract\\_lines.​entitlements.​entitlement\\_characteristics.​sys\\_id\n\n\n\nSys\\_id of an entitlement characteristics record associated with the child service contract line.Data type: String\n\nTable: Characteristic \\[sn\\_pss\\_core\\_entitlement\\_characteristic\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered\n\n\n\nList of sys\\_ids of the install base items covered under the entitlement. Data type: Array of Objects\n\n```\n\"install_base_items_covered\": [ \n {\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nchild\\_contract\\_lines.​entitlements.​install\\_base\\_items\\_covered.​sys\\_id\n\n\n\nSys\\_id of a install base items covered by the entitlement.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​sold\\_products\\_covered\n\n\n\nList of sys\\_ids of the products covered under the entitlement. Data type: Array of Objects\n\n```\n\"sold_products_covered\": [ \n {\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nchild\\_contract\\_lines.​entitlements.​sold\\_products\\_covered.​sys\\_id\n\n\n\nSys\\_id of a product associated with the entitlement.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nchild\\_contract\\_lines.​entitlements.​sys\\_id\n\n\n\nSys\\_id of the entitlement record associated with the child service contract line.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics\n\n\n\nList of characteristics associated with the chile contract line. Data type: Array of Objects\n\n```\n\"entitlement_characteristics\": [\n {\n \"entitlement_usage\": {Object},\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage\n\n\n\nEntitlement usage object inserted under the entitlement\\_characteristic.Data type: Object\n\n```\n\"entitlement_usage\": {\n \"sys_id\": \"String\"\n}\n```\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_id\n\n\n\nSys\\_id of the entitlement usage record.Data type: String\n\nTable: Entitlement Usage \\[sn\\_pss\\_core\\_entitlement\\_usage\\]\n\n
\n\nchild\\_contract\\_lines.​entitlement\\_characteristics.​sys\\_id\n\n\n\nSys\\_id of a entitlement characteristics record associated with the child service contract line.Data type: String\n\nTable: Characteristic \\[sn\\_pss\\_core\\_entitlement\\_characteristic\\]\n\n
\n\nchild\\_contract\\_lines.​install\\_base\\_items\\_covered\n\n\n\nList of sys\\_ids of the install base items covered under the child service contract line. Data type: Array of Objects\n\n```\n\"install_base_items_covered\": [ \n {\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nchild\\_contract\\_lines.​install\\_base\\_items\\_covered.​sys\\_id\n\n\n\nSys\\_id of the install base item covered.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nchild\\_contract\\_lines.​name\n\n\n\nName of the child service contract line.Data type: String\n\n
\n\nchild\\_contract\\_lines.​number\n\n\n\nUnique number of the service contract line. Automatically generated by the endpoint. For example: CTRL9812347.Data type: String\n\n
\n\nchild\\_contract\\_lines.​sold\\_products\\_covered\n\n\n\nList of sys\\_ids of the products covered under the child service contract line. Data type: Array of Objects\n\n```\n\"sold_products_covered\": [ \n {\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nchild\\_contract\\_lines.​sold\\_products\\_covered.​sys\\_id\n\n\n\nSys\\_id of a product covered by the child service contract line.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nchild\\_contract\\_lines.​sys\\_id\n\n\n\nSys\\_id of a product covered by the child contract item.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nentitlements\n\n\n\nList of entitlements associated with the service contract line.Data type: Array of Objects\n\n```\n\"entitlements\": [\n {\n \"entitlement_characteristics\": [Array],\n \"entitlement_name\": \"String\",\n \"install_base_items_covered\": [Array],\n \"sold_products_covered\": [Array],\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nentitlements.​entitlement\\_characteristics\n\n\n\nList of the entitlement characteristic objects  created under the entitlement. Data type: Array of Objects\n\n```\n\"entitlement_characteristics\" [\n {\n \"entitlement_usage\": {Object},\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nentitlements.​entitlement\\_characteristics.​entitlement\\_usage\n\n\n\nEntitlement usage object inserted under the entitlement\\_characteristic.Data type: Object\n\n```\n\"entitlement_usage\": {\n \"sys_id\": \"String\"\n}\n```\n\n
\n\nentitlements.​entitlement\\_characteristics.​entitlement\\_usage.​sys\\_id\n\n\n\nSys\\_id of the entitlement usage record.Data type: String\n\nTable: Entitlement Usage \\[sn\\_pss\\_core\\_entitlement\\_usage\\]\n\n
\n\nentitlements.​entitlement\\_characteristics.​sys\\_id\n\n\n\nSys\\_id of the entitlement characteristics record.Data type: String\n\n
\n\nentitlements.​entitlement\\_name\n\n\n\nName of the entitlement.\n\nData type: String\n\n
\n\nentitlements.​install\\_base\\_items\\_covered\n\n\n\nList of sys\\_ids of the install base items covered under the entitlement. Data type: Array of Objects\n\n```\n\"install_base_items_covered\": [ \n {\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nentitlements.​install\\_base\\_items\\_covered.​sys\\_id\n\n\n\nSys\\_id of a install base items covered by the entitlement.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nentitlements.​sold\\_products\\_covered\n\n\n\nList of sys\\_ids of the products covered under the entitlement. Data type: Array of Objects\n\n```\n\"sold_products_covered\": [ \n {\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nentitlements.​sold\\_products\\_covered.​sys\\_id\n\n\n\nSys\\_id of a product associated with the entitlement.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nentitlements.​sys\\_id\n\n\n\nSys\\_id of the entitlement record associated with the service contract line.Data type: String\n\nTable: Entitlement \\[service\\_entitlement\\]\n\n
\n\nentitlement\\_characteristics\n\n\n\nList of the entitlement characteristic objects  created under the service contract line. Data type: Array of Objects\n\n```\n\"entitlement_characteristics\" [\n {\n \"entitlement_usage\": {Object},\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nentitlement\\_characteristics.​entitlement\\_usage\n\n\n\nEntitlement usage object inserted under the entitlement\\_characteristic.Data type: Object\n\n```\n\"entitlement_usage\": {\n \"sys_id\": \"String\"\n}\n```\n\n
\n\nentitlement\\_characteristics.​entitlement\\_usage.​sys\\_id\n\n\n\nSys\\_id of the entitlement usage record.Data type: String\n\nTable: Entitlement Usage \\[sn\\_pss\\_core\\_entitlement\\_usage\\]\n\n
\n\nentitlement\\_characteristics.​sys\\_id\n\n\n\nSys\\_id of the entitlement characteristics record.Data type: String\n\n
\n\ninstall\\_base\\_items\\_covered\n\n\n\nList of sys\\_ids of the install base items covered under the service contract line. Data type: Array of Objects\n\n```\n\"install_base_items_covered\": [ \n {\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\ninstall\\_base\\_items\\_covered.​sys\\_id\n\n\n\nSys\\_id of the install base item covered.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nname\n\n\n\nName of the service contract line.\n\nData type: String\n\n
\n\nnumber\n\n\n\nUnique number of the service contract line. Automatically generated by the endpoint. For example: CTRL9812347.Data type: String\n\n
\n\nsold\\_products\\_covered\n\n\n\nList of sys\\_ids of the products covered under the service contract line. Data type: Array of Objects\n\n```\n\"sold_products_covered\": [ \n {\n \"sys_id\": \"String\"\n }\n]\n```\n\n
\n\nsold\\_products\\_covered.​sys\\_id\n\n\n\nSys\\_id of a product covered by the service contract line.Data type: String\n\nTable: Sold Product Covered \\[sn\\_install\\_base\\_m2m\\_contract\\_sold\\_product\\]\n\n
\n\nsys\\_id\n\n\n\nSys\\_id of a service contract line record.Data type: String\n\nTable: Service Contract Line \\[sn\\_pss\\_core\\_service\\_contract\\_line\\]\n\n
### cURL request\n\nThe following is a code example that shows how to call this endpoint and create a service contract line record.\n\n```\ncurl \"https://instance.servicenow.com/api/sn_pss_core/servicecontract/contractline\" \\\n--request POST \\\n--header \"Accept:application/json\" \\\n--data\n{\n \"state\": \"active\",\n \"contract\": \"a4b415d1d1f53110f8776589fa411f20\",\n \"parent_contract_line\": null,\n \"name\": \"CLI\",\n \"starts\": \"2022-12-03\",\n \"child_contract_lines\": [\n {\n \"state\": \"active\",\n \"name\": \"Child CLI\",\n \"starts\": \"2022-12-03\",\n \"entitlements\": [\n {\n \"state\": \"active\",\n \"entitlement_name\": \"Child CLI - ENTL\",\n \"start_date\": \"2022-12-03\"\n }\n ],\n \"sold_products_covered\": [\n {\n \"sold_product\": \"8db4258949f14ef7b90d90822dfc5800\",\n \"added\": \"2023-12-03\",\n \"removed\": \"2023-12-03\"\n }\n ],\n \"install_base_items_covered\": [\n {\n \"install_base\": \"2f270832699b46e78aa899a5a5dc6682\",\n \"added\": \"2023-12-03\",\n \"removed\": \"2023-12-03\"\n }\n ],\n \"entitlement_characteristics\": [\n {\n \"characteristic\": \"63418db7539e61106bfcddeeff7b1238\",\n \"characteristic_option\": \"495149b7539e61106bfcddeeff7b1262\",\n \"value\": \"20\",\n \"type\": \"coverage\"\n }\n ]\n }\n ],\n \"entitlements\": [\n {\n \"state\": \"active\",\n \"entitlement_name\": \"ENTL 1\",\n \"start_date\": \"2022-12-03\",\n \"sold_products_covered\": [\n {\n \"sold_product\": \"ec235d9dd1b53110f8776589fa411fe2\"\n }\n ],\n \"entitlement_characteristics\": [\n {\n \"characteristic\": \"63418db7539e61106bfcddeeff7b1238\",\n \"characteristic_option\": \"495149b7539e61106bfcddeeff7b1262\",\n \"value\": \"20\",\n \"type\": \"coverage_and_usage\",\n \"entitlement_usage\": {\n \"used_units\": \"3\"\n }\n }\n ]\n }\n ],\n \"sold_products_covered\": [\n {\n \"sold_product\": \"0df21151d1f53110f8776589fa411f1b\",\n \"added\": \"2023-12-03\",\n \"removed\": \"2023-12-03\"\n }\n ],\n \"entitlement_characteristics\": [\n {\n \"characteristic\": \"63418db7539e61106bfcddeeff7b1238\",\n \"characteristic_option\": \"495149b7539e61106bfcddeeff7b1262\",\n \"value\": \"tyfy6h\",\n \"type\": \"coverage\"\n }\n ]\n}\n```\n\nResponse:\n\n```\n{\n \"result\": {\n \"sys_id\": \"16e451d1d1f53110f8776589fa411f80\",\n \"name\": \"CLI\",\n \"number\": \"CTRL00000001\",\n \"child_contract_lines\": [\n {\n \"sys_id\": \"3a39ecdc01154f4ab782da0169c9c922\",\n \"name\": \"Child CLI\",\n \"number\": \"CTRL00000001\",\n \"child_contract_lines\": [],\n \"entitlements\": [\n {\n \"sys_id\": \"7439fd84c2494ba6951e58f333cfe8d4\",\n \"entitlement_name\": \"Child CLI - ENTL\",\n \"sold_products_covered\": [],\n \"install_base_items_covered\": [],\n \"entitlement_characteristics\": []\n }\n ],\n \"sold_products_covered\": [\n {\n \"sys_id\": \"dfb62e9c4c6843009be02a68f65b9118\"\n }\n ],\n \"install_base_items_covered\": [\n {\n \"sys_id\": \"2583912e81964501b52a2e44d4797a28\"\n }\n ],\n \"entitlement_characteristics\": [\n {\n \"sys_id\": \"3a00c975bb49412cae169200c7f6236e\",\n \"entitlement_usage\": {}\n }\n ]\n }\n ],\n \"entitlements\": [\n {\n \"sys_id\": \"9ee451d1d1f53110f8776589fa411f83\",\n \"entitlement_name\": \"ENTL 1\",\n \"sold_products_covered\": [\n {\n \"sys_id\": \"92e451d1d1f53110f8776589fa411f85\"\n }\n ],\n \"install_base_items_covered\": [],\n \"entitlement_characteristics\": [\n {\n \"sys_id\": \"92e451d1d1f53110f8776589fa411f86\",\n \"entitlement_usage\": {\n \"sys_id\": \"dee451d1d1f53110f8776589fa411f86\"\n }\n }\n ]\n }\n ],\n \"sold_products_covered\": [\n {\n \"sys_id\": \"5ae451d1d1f53110f8776589fa411f81\"\n }\n ],\n \"install_base_items_covered\": [],\n \"entitlement_characteristics\": [\n {\n \"sys_id\": \"dae451d1d1f53110f8776589fa411f82\",\n \"entitlement_usage\": {}\n }\n ]\n }\n}\n```\n\n"}}