| \n\nName\n\n | \n\nType\n\n | \n\nDescription\n\n |
|---|---|---|
| \n\ncontext\n\n | \n\nObject\n\n | \n\nOptional. Additional parameter options for displaying attribute values and for invoking more than one instance at a time.```\n\"context\": {\n \"entityConfigId\": \"String\",\n \"isMultiSelect\": \"Boolean\",\n \"loadDisplayValue\": \"Boolean\"\n}\n```\n\n |
| \n\ncontext.entityConfigId\n\n | \n\nString\n\n | \n\nOptional. Configuration ID of the entity. If both **entityConfigId** and **sourceToTargetConfigID** are provided, priority is given to **entityConfigId**.Table: Lead To Cash Entity \\[sn\\_l2c\\_core\\_entity\\]\n\nData type: String\n\n |
| \n\ncontext.isMultiSelect\n\n | \n\nBoolean\n\n | \n\nOptional. Flag that indicates whether to pass multiple entities as input to create the instance. Valid values:\n\n- true: Enables the passing of multiple entities as input. When true, you can pass multiple line items in a comma-separated list.\n- false: Doesn't enable the passing of multiple entities as input. Only one input may be passed in the API script.\n\nDefault: false\n\n |
| \n\ncontext.loadDisplayValue\n\n | \n\nBoolean\n\n | \n\nOptional. Flag that indicates whether to load the display value for each attribute.Valid values:\n\n- true: Enables the loading of an attribute's display value.\n- false: Doesn't enable the loading of an attribute's display value.\n\nDefault: false\n\n |
| \n\nsourceToTargetConfigID\n\n | \n\nString\n\n | \n\nMapping configuration ID for the source-to-target mapping. Table: Lead To Cash Entity Mapping \\[sn\\_l2c\\_core\\_entity\\_mapping\\]\n\n |
| \n\nName\n\n | \n\nType\n\n | \n\nDescription\n\n |
|---|---|---|
| \n\nadditionalParams\n\n | \n\nObject\n\n | \n\nOptional. Additional parameters to use.\n\n |
| \n\nadditionalParams.skipLines\n\n | \n\nBoolean\n\n | \n\nOptional. Flag that indicates whether to fetch line items for the specified entity.Valid values:\n\n- true: Skip returning line items information for the entity.\n- false: Return line items information for the entity.\n\nDefault: false\n\n |
| \n\nfetchRecordSysIds\n\n | \n\nArray of Objects\n\n | \n\nEnables selective fetching of data for both header‑based and header‑less scenarios by explicitly mapping table names to sys\\_ids.Behavior:\n\n- With header: Allows selective fetching of child entities \\(like ramps\\) linked to the header. If ramp IDs aren't provided, fetches all ramps linked to header.\n- Without header: Supports fetching of ramps where direct relationships are missing in header-less entities. Ramp IDs must be included; without them, doesn't return ramp data.\n\nStructure:\n\n```\n[{\n \" |
| \n\nmultiSelectMerge\n\n | \n\nBoolean\n\n | \n\nOnly for no-header scenarios. Flag that indicates whether to merge data of same context-type into a single flat structure.Valid values:\n\n- true: Merges same context-type data in a flat structure.\n- false: Doesn't merge data.\n\n |
| \n\nadditionalParams.allowedContextTypes\n\n | \n\nArray of Strings\n\n | \n\nOptional. Controls population and processing to only those types listed in allowedContextTypes, excluding all other unrelated sections.Valid values:\n\n- For header-based partial sync, `header` must be passed in **allowedContextTypes** to allow this method to build the root structure.\n- For no-header partial sync, `lineItems` must be passed in **allowedContextTypes** to allow this method to build the structure for processing child data.\n\nStructure:\n\n```\nallowedContextTypes: [\"header\",\"headerRelatedParty\"] }; \n```\n\n |
| \n\nheaderSysIDs\n\n | \n\nString\n\n | \n\nHeader sys\\_id\\(s\\) of an entity to retrieve data from. Required if you don't provide the **lineSysIDs** parameter. Pass `null` if you aren't passing any header sys\\_ids.To designate one or more header sys\\_ids in your script, set `context.isMultiSelect = true` in the getPrimitivesEPService\\(\\) utility method. For more details, see the Parameters table in [LeadtoCashCore - getPrimitivesEPService\\(String sourceToTargetConfigID, Object context\\)](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/LeadToCashCoreAPI.md).\n\n**Note:** At least one **headerSysID** or **lineSysIDs** parameter is required.\n\n |
| \n\nisTarget\n\n | \n\nBoolean\n\n | \n\nOptional. Flag that determines whether to fetch target entity data.Valid values:\n\n- true: Fetch data of the target entity.\n- false: Don't fetch data of the target entity.\n\nDefault: false\n\n |
| \n\nlineSysIDs\n\n | \n\nString\n\n | \n\nLine item sys\\_id\\(s\\) of an entity to retrieve entity data from. Required if you don't provide **headerSysIDs** and if the entity structure starts with line items such as sold product. To designate one or more line item sys\\_ids in your script, set `context.isMultiSelect = true` in the getPrimitivesEPService\\(\\) utility method. For more details, see the Parameters table in [LeadtoCashCore - getPrimitivesEPService\\(String sourceToTargetConfigID, Object context\\)](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/LeadToCashCoreAPI.md).\n\n**Note:** At least one **headerSysID** or **lineSysIDs** parameter is required. If passing multiple **lineSysIDs**, all records must belong to the same **headerSysID**.\n\n |
| \n\nType\n\n | \n\nDescription\n\n |
|---|---|
| \n\nJSON Object\n\n | \n\nA JSON containing details of the entity record.Data type: Array of objects\n\n```\n{\n\"items\": [\n {\n \"attributes\": {Object},\n \"sys_id\": {Object},\n \"table\": \"String\",\n \"lineItems\": [\n {\n \"attributes\": {Object},\n \"sys_id\": {Object},\n \"table\": \"String\",\n \"characteristics\": [Array],\n \"lineItems\": [Array]\n }\n ],\n \"characteristics\": [Array],\n \"_state\": \"String\"\n }\n ]\n}\n```\n\n |
| \n\n\\_state\n\n | \n\nActivity state of the entity.Possible values:\n\n- active: The entity is active.\n- inactive: The entity is inactive.\n\nDefault: active\n\nData type: String\n\n |
| \n\ncharacteristics\n\n | \n\nList of entity characteristics. Characteristics may vary between entities.Data type: Array of objects\n\n```\n\"characteristics\": [ \n { \n \"attributes\": {Object},\n \"sys_id\": {Object}, \n \"table\": \"String\"\n } \n ]\n```\n\n |
| \n\ncharacteristics.attributes\n\n | \n\nOne or more objects that contain information about attributes associated with the characteristic record. The <attribute type> can be different values based on the records/functionality associated with the characteristic. For example, this object could contain references to the attributes record's sys\\_id, associated characteristic records, characteristic option records, or sold product information.Data type: Object\n\n```\n\"attributes\": {\n \" |
| \n\ncharacteristics.attributes.<attribute\\_type>\n\n | \n\nInformation about the key name of the item attribute.```\n\" |
| \n\ncharacteristics.attributes.<attribute\\_type>.value\n\n | \n\nTypically the sys\\_id of the of the associate attribute record, but can be any meaningful text string that describes the associated attribute type.Data type: String\n\n |
| \n\ncharacteristics.sys\\_id\n\n | \n\nObject containing the sys\\_id of the associated characteristic record.Data type: Object\n\n```\n\"sys_id\": { \n \"value\": \"String\" \n }\n```\n\n |
| \n\ncharacteristics.sys\\_id.value\n\n | \n\nSys\\_id of the associated characteristic record.Data type: String\n\n |
| \n\ncharacteristics.table\n\n | \n\nName of the table that contains the characteristic record of the lead to cash entity.Data type: String\n\n |
| \n\nitems\n\n | \n\nContains an array of selected objects when **context.isMultiSelect** is set to true.Data type: Array of Objects\n\n```\n\"items\": [\n{ \n \"attributes\": {Object}, \n \"sys_id\": {Object}, \n \"table\": \"String\",\n \"lineItems\": [Array]\n }, \n]\n```\n\n |
| \n\nitems.attributes\n\n | \n\nAttributes of the item record. Attributes may vary between entities.```\n\"attributes\": {\n \"account\": {Object},\n \"name\": {Object}\n}\n```\n\nData type: Object\n\n |
| \n\nitems.attributes.account\n\n | \n\nInformation about the account associated with the item attribute.```\n\"account\": { \n \"value\": \"String\" \n}\n```\n\n |
| \n\nitems.attributes.account.value\n\n | \n\nAttributes of the item. Attributes may vary between entities.```\n\"attributes\": {\n \"account\": {Object},\n \" |
| \n\nitems.attributes.<key\\_name>\n\n | \n\nInformation about the key name of the item attribute.```\n\" |
| \n\nitems.attributes.<key\\_name>.value\n\n | \n\nValue of the key name attribute.Data type: String\n\n |
| \n\nitems.sys\\_id\n\n | \n\nObject containing sys\\_id information about the entity item. Values vary between entities.Data type: Object\n\n```\n\"sys_id\": {\n \"value\": \"String\"\n}\n```\n\n |
| \n\nitems.sys\\_id.value\n\n | \n\nSys\\_id of an associated item.Data type: String\n\n |
| \n\nitems.table\n\n | \n\nName of the table that contains line item record associated with the lead to cash entity.Data type: String\n\n |
| \n\nitems.lineItems\n\n | \n\nJSON object that contains the line item details of the entity record. Data type: Array of objects\n\n```\n\"lineItems\": [ \n { \n \"attributes\": {Object},\n \"characteristics\": [Array],\n \"lineItems\": [Array],\n \"_state\": \"String\",\n \"sys_id\": {Object},\n \"table\": \"String\"\n }\n]\n```\n\n |
| \n\nitems.lineItems.\\_state\n\n | \n\nActivity state of the line item entity.Possible values:\n\n- active: The entity is active.\n- inactive: The entity is inactive.\n\nDefault: active\n\nData type: String\n\n |
| \n\nitems.lineItems.attributes\n\n | \n\nAttributes of the line item record. Attributes may vary between entities.```\n\"attributes\": {\n \"account\": {Object},\n \" |
| \n\nitems.lineItems.attributes.<key\\_name>\n\n | \n\nInformation about the key name of the line item attribute.```\n\" |
| \n\nitems.lineItems.attributes.<key\\_name>.value\n\n | \n\nValue of the key name attribute.Data type: String\n\n |
| \n\nitems.lineItems.attributes.account\n\n | \n\nInformation about the account associated with the line item attribute.```\n\"account\": { \n \"value\": \"String\" \n}\n```\n\n |
| \n\nitems.lineItems.attributes.account.value\n\n | \n\nSys\\_id of the account associated with the line item attribute.Data type: String\n\n |
| \n\nitems.lineItems.characteristics\n\n | \n\nList of characteristics associated with the line item. Characteristics may vary between entities.Data type: Array of objects\n\n```\n\"characteristics\": [ \n { \n \"attributes\": {Object},\n \"sys_id\": {Object}, \n \"table\": \"String\"\n } \n ]\n```\n\n |
| \n\nitems.lineItems.characteristics.attributes\n\n | \n\nOne or more objects that contain information about attributes associated with the characteristic record. The <attribute type> can be different values based on the records/functionality associated with the characteristic. For example, this object could contain references to the attributes record's sys\\_id, associated characteristic records, characteristic option records, or sold product information.Data type: Object\n\n```\n\"attributes\": {\n \" |
| \n\nitems.lineItems.characteristics.attributes.<attribute\\_type>.value\n\n | \n\nTypically the sys\\_id of the of the associate attribute record, but can be any meaningful text string that describes the associated attribute type.Data type: String\n\n |
| \n\nitems.lineItems.characteristics.sys\\_id\n\n | \n\nObject containing the sys\\_id of the associated characteristic record.Data type: Object\n\n```\n\"sys_id\": { \n \"value\": \"String\" \n }\n```\n\n |
| \n\nitems.lineItems.characteristics.sys\\_id.value\n\n | \n\nSys\\_id of the associated characteristic record.Data type: String\n\n |
| \n\nitems.lineItems.characteristics.table\n\n | \n\nName of the table that contains the characteristic record of the lead to cash entity.Data type: String\n\n |
| \n\nitems.lineItems.lineItems\n\n | \n\nChild line items of a parent line item. This object has the same format as the **lineItems** parameter.Data type: Object\n\n```\n\"lineItems\": [\n { \n \"attributes\": {Object},\n \"characteristics\": [Array],\n \"lineItems\": [Array],\n \"_state\": {Object},\n \"sys_id\": {Object},\n \"table\": \"String\"\n }\n] \n```\n\n |
| \n\nitems.lineItems.sys\\_id\n\n | \n\nObject containing sys\\_id information about the associated line item record.Data type: Object\n\n```\n\"sys_id\": {\n \"value\": \"String\"\n}\n```\n\n |
| \n\nitems.lineItems.sys\\_id.value\n\n | \n\nSys\\_id of an associated line item record.Data type: String\n\n |
| \n\nitems.lineItems.table\n\n | \n\nName of the table that contains the line item record associated with the lead to cash entity.Data type: String\n\n |
| \n\nName\n\n | \n\nType\n\n | \n\nDescription\n\n |
|---|---|---|
| \n\nsourceJSON\n\n | \n\nObject\n\n | \n\nJSON object of the source lead to cash entity. **Note:** Use the [LeadtoCashCore - createInstance\\(String headerSysIDs, String lineSysIDs, Boolean isTarget, Object additionalParams\\)](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/LeadToCashCoreAPI.md) method to retrieve the source JSON of an entity.\n\n |
| \n\ndirtyJSON\n\n | \n\nObject\n\n | \n\nModified source JSON of the lead to cash entity.\n\n |
| \n\nadditionalParams\n\n | \n\nObject\n\n | \n\nOptional. Additional parameters to use.\n\n |
| \n\nadditionalParams.delta\\_ignore\\_attributes\n\n | \n\nObject\n\n | \n\nTable attributes to ignore during comparison between the source and dirtyJSON. Enables support of reconfiguration use cases.```\n{ \n“ |
| \n\nadditionalParams.delta\\_ignore\\_attributes.<table\\_name>\n\n | \n\nString\n\n | \n\nThe name of the table and its associated attributes to ignore.For example:\n\n```\n{ \n“sn_install_base_sold_product”: [“state”,”unit_price”] \n}\n```\n\n |
| \n\nadditionalParams.loadDisplayValue\n\n | \n\nBoolean\n\n | \n\nOptional. Flag that indicates whether to load the display value for each attribute.Valid values:\n\n- true: Enables the loading of an attribute's display value.\n- false: Doesn't enable the loading of an attribute's display value.\n\nDefault: false\n\n |
| \n\nType\n\n | \n\nDescription\n\n |
|---|---|
| \n\nJSON Object\n\n | \n\nAn object containing details of the entity record with any changes that occurred between the sourceJSON and dirtyJSON.Data type: Object\n\n```\n{\n\"lineItems\": [Array] \n}\n```\n\n |
| \n\nlineItems\n\n | \n\nJSON object that contains the line item details of the entity record. For example, order line items or quote line items. Data type: Array of objects\n\n```\n\"lineItems\": [ \n {\n \"_action\": \"String\",\n \"attributes\": {Object}\n \"characteristics\": [Array]\n \"lineItems\": [Array],\n \"sys_id\": {Object},\n \"table\": \"String\"\n } \n]\n```\n\n |
| \n\nlineItems.\\_action\n\n | \n\nChange action applied to the line item of the source JSON. Possible values:\n\n- add: Information was added to the source JSON.\n- change: Information was updated in the source JSON.\n- disconnect: Information was disconnected from the source JSON.\n- nochange: No change occurred on the source JSON.\n\nData type: String\n\n |
| \n\nlineItems.attributes\n\n | \n\nAttributes of the line item. For example, the attribute's name and value. May contain varying fields based on the entity.Data type: Object\n\n```\n\"attributes\": { \n \" |
| \n\nlineitems.attributes.<attribute\\_name>\n\n | \n\nName of the line item attribute. For example, the name of an account or contact. May contain varying fields of the entity.Data type: Object\n\n```\n\"attributes\": { \n \" |
| \n\nlineitems.attributes.<attribute\\_name>.value\n\n | \n\nValue of the line item attribute. Data type: String\n\n |
| \n\nlineItems.attributes.account\n\n | \n\nInformation about the account associated with the item attribute.Data type: Object\n\n```\n\"account\": { \n \"value\": \"String\" \n}\n```\n\n |
| \n\nlineItems.attributes.account.value\n\n | \n\nSys\\_id of the account associated with the line item attribute.Data type: String\n\n |
| \n\nlineItems.characteristics\n\n | \n\nCharacteristics of the line item. May contain varying fields based on the entity.Data type: Array of Objects\n\n```\n\"characteristics\": [ \n { \n \"attributes\": {Object},\n \"sys_id\": {Object}, \n \"table\": \"String\"\n } \n]\n```\n\n |
| \n\nlineItems.characteristics.attributes\n\n | \n\nAttributes of the header record characteristics. For example, the attribute's name and value. May contain varying fields based on the entity.Data type: Object\n\n```\n\"attributes\": { \n \" |
| \n\nlineitems.characteristics.attributes.<field\\_name>\n\n | \n\nAttribute name of the characteristic record associated with the line item.Data type: Object\n\n```\n\" |
| \n\nlineitems.characteristics.attributes.<field\\_name>.value\n\n | \n\nValue of the attribute belonging to the characteristic record of an entity.Data type: String\n\n |
| \n\nlineItems.characteristics.sys\\_id\n\n | \n\nSys\\_id object of the characteristic record.Data type: Object\n\n```\n\"sys_id\": { \n \"value\": \"String\" \n}\n```\n\n |
| \n\nlineItems.characteristics.sys\\_id.value\n\n | \n\nSys\\_id of the associated characteristic record. The updated table may vary between entities. For example, Order \\[sn\\_ind\\_tmt\\_orm\\_order\\].Data type: String\n\n |
| \n\nlineItems.characteristics.table\n\n | \n\nName of the table containing the characteristic record.Data type: String\n\n |
| \n\nlineItems.lineItems\n\n | \n\nChild line items of a parent line item. This object has the same format as the **lineItems** parameter.Data type: Array of Objects\n\n```\n\"lineItems\": [ \n { \n \"_glide_action\": \"String\",\n \"attributes\": {Object},\n \"characteristics\": [Array],\n \"lineItems\": [Array],\n \"sys_id\": {Object},\n \"table\": \"String\"\n } \n]\n```\n\n |
| \n\nlineItems.sys\\_id\n\n | \n\nSys\\_id of the associated item record.Data type: Object\n\n```\n\"sys_id\": {\n \"value\": \"String\"\n}\n```\n\n |
| \n\nlineItems.sys\\_id.value\n\n | \n\nSys\\_id of an associated item record. The updated table may vary between entities, like Order or Specification. For example, Order \\[sn\\_ind\\_tmt\\_orm\\_order\\]. Data type: String\n\n |
| \n\nlineItems.table\n\n | \n\nName of the table that contains the item record associated with the lead to cash entity. Data type: String\n\n |
| \n\nName\n\n | \n\nType\n\n | \n\nDescription\n\n |
|---|---|---|
| \n\nsourceJSON\n\n | \n\nObject\n\n | \n\nJSON containing details of the source entity.**Note:** Use the [LeadtoCashCore - createInstance\\(String headerSysIDs, String lineSysIDs, Boolean isTarget, Object additionalParams\\)](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/LeadToCashCoreAPI.md) to retrieve the source JSON of an entity.\n\n |
| \n\ntargetJSON\n\n | \n\nObject\n\n | \n\nJSON containing details of the target entity.\n\n |
| \n\nadditionalParams\n\n | \n\nObject\n\n | \n\nOptional. Additional parameters to use.\n\n |
| \n\nadditionalParams.is\\_future\\_state\n\n | \n\nBoolean\n\n | \n\nOptional. Use this to support reconfiguration use cases. Accepted values:\n\n- true: Provides context variable keys instead of dictionary field names. This allows you to provide all the attributes from the target entity instead of mapping attributes from source to target.\n- false: Provides dictionary field names.\n\nDefault: false\n\n |
| \n\nType\n\n | \n\nDescription\n\n |
|---|---|
| \n\nJSON Object\n\n | \n\nChange that occurred and was applied from the source to target entity JSON objects at each of the header of the lead to cash entity.Data type: Object\n\n```\n{\n \"_glide_action\": \"String\",\n \"_records_count: {Object},\n \"_source_object\": {Object},\n \"lineItems\": [Array],\n \"sys_id\": \"String\", \n \"table\": \"String\"\n}\n```\n\n |
| \n\n\\_glide\\_action\n\n | \n\nIndicates the change that occurred at the item level between the source and target JSON.Possible values \\(case-sensitive\\):\n\n- DELETE: Information was removed between the source and target JSON structures.\n- INSERT: Information was added between the source and target JSON structures.\n- NO\\_CHANGE: No change occurred between the source and target JSON structures.\n- UPDATE: Information was modified between the source and JSON structures.\n\nData type: String\n\n |
| \n\n\\_records\\_count\n\n | \n\nDetails of new records inserted for each table.Data type: Object\n\n```\n\"_records_count\": {\n\"tableName\": {Object}\n}\n```\n\n |
| \n\n\\_records\\_count.tableName\n\n | \n\nName of the table in which new records are inserted.Data type: Object\n\n```\n\"tableName\": {\n \"insert\": Number}\n}\n```\n\n |
| \n\n\\_records\\_count.tableName.insert\n\n | \n\nNumber of new records inserted in the table.Data type: Number\n\n |
| \n\n\\_source\\_object\n\n | \n\nSource JSON object to which changes were applied. The object structure may vary between entities.Data type: Object\n\n```\n\"_source_object\": { \n \"sys_id\": \"String\",\n \"table\": \"String\" \n}\n```\n\n |
| \n\n\\_source\\_object.sys\\_id\n\n | \n\nSys\\_id of the source entity record that was updated. Data type: String\n\n |
| \n\n\\_source\\_object.table\n\n | \n\nTable location of the source entity record that was updated. This value may vary between entities.Data type: String\n\n |
| \n\nlineItems.\\_glide\\_action\n\n | \n\nChange action that occurred on the line item.Possible values:\n\n- DELETE: Information was removed between the source and target JSON structures.\n- INSERT: Information was added between the source and target JSON structures.\n- NO\\_CHANGE: No change occurred between the source and target JSON structures.\n- UPDATE: Information was modified between the source and JSON structures.\n\nData type: String\n\n |
| \n\nlineItems.\\_source\\_object\n\n | \n\nSource entity record details to which the \\_glide\\_action was applied. This object may vary between entities.Data type: Object\n\n```\n\"_source_object\": { \n \"sys_id\": \"String\",\n \"table\": \"String\" \n}\n```\n\n |
| \n\nlineItems.\\_source\\_object.sys\\_id\n\n | \n\nSys\\_id of the source entity record that was updated. Data type: String\n\n |
| \n\nlineItems.\\_source\\_object.table\n\n | \n\nTable location of the source entity record that was updated. This value may vary between entities.Data type: String\n\n |
| \n\nlineItems.\\_state\n\n | \n\nState of the entity.Data type: Object\n\n```\n\"_state\": { \n \"value\": \"String\" \n} \n```\n\n |
| \n\nlineItems.\\_state.value\n\n | \n\nThe current state of the entity.Possible values:\n\n- active: The entity object is in an active state.\n- inactive: The entity object isn't in an active state.\n\nData type: String\n\n |
| \n\nlineItems.attributes\n\n | \n\nAttributes of the line item. For example, the attribute's name and value. May contain varying fields based on the entity.Data type: Object\n\n```\n\"attributes\": { \n \" |
| \n\nlineitems.attributes.<attribute\\_name>\n\n | \n\nName of the line item attribute. For example, the name of an account or contact. May contain varying fields of the entity.Data type: Object\n\n```\n\"attributes\": { \n \" |
| \n\nlineitems.attributes.<attribute\\_name>.value\n\n | \n\nValue of the line item attribute. Data type: String\n\n |
| \n\nlineItems.attributes.account\n\n | \n\nInformation about the account associated with the item attribute.Data type: Object\n\n```\n\"account\": { \n \"value\": \"String\" \n}\n```\n\n |
| \n\nlineItems.attributes.account.value\n\n | \n\nSys\\_id of the account associated with the line item attribute.Data type: String\n\n |
| \n\nlineItems.attributes.short\\_description\n\n | \n\nBrief description of the line item attribute.Data type: String\n\n |
| \n\nlineItems.characteristics\n\n | \n\nList of characteristics associated with the line item. Characteristics may vary between entities.Data type: Array of Objects\n\n```\n\"characteristics\": [ \n {\n \"_glide_action: \"String\",\n \"attributes\": {Object},\n \"sys_id\": {Object}, \n \"table\": \"String\"\n } \n]\n```\n\n |
| \n\nlineItems.characteristics.\\_glide\\_action\n\n | \n\nChange action that occurred on the line item.Possible values:\n\n- DELETE: Information was removed between the source and target JSON structures.\n- INSERT: Information was added between the source and target JSON structures.\n- NO\\_CHANGE: No change occurred between the source and target JSON structures.\n- UPDATE: Information was modified between the source and JSON structures.\n\nData type: String\n\n |
| \n\nlineItems.characteristics.attributes\n\n | \n\nOne or more objects that contain information about attributes associated with the characteristic record.For example, this object could contain references to the attributes record's sys\\_id, associated characteristic records, accounts or contacts, characteristic option records, or sold product information.\n\nData type: Object\n\n```\n\"attributes\": {\n \" |
| \n\nlineItems.characteristics.attributes.<attribute\\_type>\n\n | \n\nType of attribute. This value can contain different values based on the records or functionality associated with the characteristic.Data type: Object\n\n```\n\" |
| \n\nlineItems.characteristics.attributes.<attribute\\_type>.value\n\n | \n\nValue of the line item attribute.Data type: String\n\n |
| \n\nlineitems.characteristics.attributes.<field\\_name>\n\n | \n\nAttribute name of the characteristic record associated with the line item.Data type: Object\n\n```\n\" |
| \n\nlineitems.characteristics.attributes.<field\\_name>.value\n\n | \n\nValue of the attribute belonging to the characteristic record of an entity.Data type: String\n\n |
| \n\nlineItems.characteristics.sys\\_id\n\n | \n\nSys\\_id of the associated characteristic record.Data type: Object\n\n```\n\"sys_id\": { \n \"value\": \"String\" \n }\n```\n\n |
| \n\nlineItems.characteristics.sys\\_id.value\n\n | \n\nSys\\_id of the associated characteristic record. The updated table may vary between entities. For example, Order \\[sn\\_ind\\_tmt\\_orm\\_order\\].Data type: String\n\n |
| \n\nlineItems.characteristics.table\n\n | \n\nName of the table containing the characteristic record.Data type: String\n\n |
| \n\nlineItems.lineItems\n\n | \n\nChild line items of a parent line item. This object has the same format as the **lineItems** parameter.Data type: Array of Objects\n\n```\n\"lineItems\": [ \n { \n \"_glide_action\": \"String\",\n \"attributes\": {Object},\n \"characteristics\": [Array],\n \"lineItems\": [Array],\n \"sys_id\": {Object},\n \"table\": \"String\"\n } \n]\n```\n\n |
| \n\nlineItems.sys\\_id\n\n | \n\nSys\\_id of the associated item record.Data type: Object\n\n```\n\"sys_id\": {\n \"value\": \"String\"\n}\n```\n\n |
| \n\nlineItems.sys\\_id.value\n\n | \n\nSys\\_id of an associated item record. The updated table may vary between entities, like Order or Specification. For example, Order \\[sn\\_ind\\_tmt\\_orm\\_order\\]. Data type: String\n\n |
| \n\nlineItems.table\n\n | \n\nName of the table that contains the item record associated with the lead to cash entity. Data type: String\n\n |
| \n\nsys\\_id\n\n | \n\nSys\\_id of the entity.Data type: String\n\n |
| \n\ntable\n\n | \n\nName of the table in which the entity is found.Data type: String\n\n |
| \n\nName\n\n | \n\nType\n\n | \n\nDescription\n\n |
|---|---|---|
| \n\ntargetJSON\n\n | \n\nObject\n\n | \n\nJSON object containing the ‘glide\\_action’ of a target entity to commit. You can pass the output of the [effect\\(\\)](https://raw.githubusercontent.com/ServiceNow/ServiceNowDocs/australia/markdown/australia/api-reference/server-api-reference/LeadToCashCoreAPI.md) method here. **Note:** ‘glide\\_action’ identifies the change action that occurred between the source and target JSON of a lead to cash entity.\n\n |
| \n\nadditionalParams\n\n | \n\nObject\n\n | \n\nOptional. Additional parameters to use.```\n\"additionalParams\": {\n \"returnDeletedGr\": Boolean,\n \"useNumberGeneartor\": Boolean\n}\n```\n\n |
| \n\nadditionalParams.useNumberGenerator\n\n | \n\nBoolean\n\n | \n\nOptional. Flag that indicates if to generate sys\\_numbers in bulk. Applicable values:\n\n- true: Generate the sys\\_numbers in bulk to be utilized during the record insertion process. Reduces the need for additional queries to fetch numbers and decreases insertion time.\n- incorrect: Generate the sys\\_number individually at the time of insertion for each record.\n\nDefault: incorrect\n\n |
| \n\nadditionalParams.returnDeletedGr\n\n | \n\nBoolean\n\n | \n\nOptional. Flag that indicates whether to trigger post processing upon a DELETE operation. Only set **returnDeletedGr** to `true` if your subclass overrides `_postProcess` or `_postHierarchyCommit` and contains logic that should execute after DELETE operations.\n\nValid values:\n\n- true: The deleted GlideRecord is returned after a DELETE operation and assigned to target, which causes **\\_postProcess** and **\\_postHierarchyCommit** to fire.\n- false: DELETE operations don't trigger**\\_postProcess** or **\\_postHierarchyCommit**.\n\nDefault: false\n\n |
| \n\nType\n\n | \n\nDescription\n\n |
|---|---|
| \n\nJSON Object\n\n | \n\nDetails about the target entity record.Data type: Object\n\n```\n{\n \"dataObject\": {Object},\n \"displayMessage\": \"String\",\n \"error\": \"String\",\n \"headerID\": \"String\",\n \"message\": \"String\",\n \"rootLineIDs\": [Array],\n \"status\": \"String\"\n}\n```\n\n**Note:** **headerID** is only present for header entities, **rootLineIDs** are only present for no‑header entities. **dataObject**, **displayMessage**, **error**, **message**, and **status** are always present.\n\n |
| \n\ndataObject\n\n | \n\nJSON object that has detailed data on the commit operations performed at each level. **Note:** As of the March 2026 store release, the **dataObject** field at this time accumulates all root entity types by their typeValue keys \\(for example lineItems, ramp\\), preserving data for all root entities.\n\nData type: Object\n\nStructure when entity has a header:\n\n```\ndataObject: {\n \"sys_id\": \"String\",\n \"table\": \"String\",\n \"attributes\": {Object},\n \"_glide_action\": \"String\",\n \"_source_object\": {Object},\n \"_commitObjectInfo\": {Object},\n \"lineItems\": [Array],\n \"ramp\": [Array],\n \"headerRelatedParty\": [Array],\n \"characteristics\": [Array]\n}\n```\n\n |
| \n\ndataObject.\\_commitObjectInfo\n\n | \n\nCommit status and sys\\_id if the line item change is an ENGAGE action.Data type: Object\n\n```\n\"_commitObjectInfo\": {\n \"status\": \"String\",\n \"sys_id\": \"String\"\n}\n```\n\n |
| \n\ndataObject.ramp\n\n | \n\nRepresents the ramp group\\(s\\) associated with a header or Sold Material.Array of Objects\n\n```\n\"ramp\": { \n \"sys_id\": \"String\", \n \"table\": \"String\", \n \"attributes\": {Object} \n}\n```\n\n |
| \n\ndataObject.ramp.sys\\_id\n\n | \n\nSys\\_id of the ramp. Providing ramp IDs without the parent mapping is considered invalid input for no-header and multiselect patterns.Data type: String\n\n |
| \n\ndataObject.ramp.table\n\n | \n\nTable name of the ramp entity associated with the committed Sold Material or header. For example, `\"sn_install_base_sold_product_ramp\"`.Data type: String\n\n |
| \n\ndataObject.ramp.attribute\n\n | \n\nAttributes of the ramp.Data type: Object\n\n```\n\"attributes\": { \n \"end_date\": String,\n \"parent\": String,\n \"parent_table\": String,\n \"ramp_type\": String,\n \"start_date\": String,\n \"status\": String,\n \"term\": String\n}\n```\n\n |
| \n\ndataObject.ramp.attribute.parent\n\n | \n\nSys\\_id of the ramp's parent attribute.Data type: String\n\n |
| \n\ndataObject.ramp.attribute.parent\\_table\n\n | \n\nTable location of the attribute. For example, `table_name`.Data type: String\n\n |
| \n\ndataObject.ramp.attribute.ramp\\_type\n\n | \n\nType of ramp.Possible values:\n\n- Quarterly\n- Yearly\n- Custom\n\nData type: String\n\n |
| \n\ndataObject.ramp.attribute.term\n\n | \n\nTerm.Data type: String\n\n |
| \n\ndataObject.ramp.attribute.start\\_date\n\n | \n\nStart date of the ramp.Data type: String\n\n |
| \n\ndataObject.ramp.attribute.end\\_date\n\n | \n\nEnd date of the ramp.Data type: String\n\n |
| \n\ndataObject.\\_commitObjectInfo.status\n\n | \n\nStatus of the commit operation performed on the particular entity. Possible values:\n\n- success: The entity commit operation was correct.\n- if...not: The entity commit operation wasn't correct.\n\nData type: String\n\n |
| \n\ndataObject.\\_commitObjectInfo.sys\\_id\n\n | \n\nSys\\_id of the inserted record. The method returns this parameter only if the **dataObject.\\_glide\\_action** is `ENGAGE`. The updated table possibly change between entities. For example, Order \\[sn\\_ind\\_tmt\\_orm\\_order\\].Data type: String\n\n |
| \n\ndataObject.\\_glide\\_action\n\n | \n\nChange action that occurred on the line item. Possible values:\n\n- REMOVE: Information was removed between the source and target JSON structures.\n- ENGAGE: Information was added between the source and target JSON structures.\n- NO\\_CHANGE: No change occurred between the source and target JSON structures.\n- UPDATE: Information was modified between the source and target structures.\n\nData type: String\n\n |
| \n\ndataObject.\\_source\\_object\n\n | \n\nSource JSON object to which changes were applied. The object structure possibly change between entities.Data type: Object\n\n```\n\"_source_object\": {\n \"sys_id\": \"String\", \n \"table\": \"String” \n}\n```\n\n |
| \n\ndataObject.\\_source\\_object.sys\\_id\n\n | \n\nSys\\_id of the source entity record to which the \\_glide\\_action was applied. The updated table possibly change between entities. For example, Order \\[sn\\_ind\\_tmt\\_orm\\_order\\].Data type: String\n\n |
| \n\ndataObject.\\_source\\_object.table\n\n | \n\nName of the table that has the source entity record to which the \\_glide\\_action was applied. This possibly change between entities.Data type: String\n\n |
| \n\ndataObject.lineItems\n\n | \n\nLine item details of the entity record. For example, order line items or give line items.Data type: Array of Objects\n\n```\n\"lineItems\": [ \n{ \n \"_action\": \"String\",\n \"_commitObjectInfo\": {Object},\n \"_glide_action\": \"String\",\n \"_source_object\": {Object},\n \"_state\": \"String\",\n \"attributes\": {Object},\n \"characteristics\": [Array],\n \"lineItems\": [Array],\n \"sys_id\": {Object},\n \"table\": \"String\",\n}\n]\n```\n\n |
| \n\ndataObject.lineItems.\\_action\n\n | \n\nChange action applied to the line item of the source JSON. Possible values:\n\n- add: Information was added to the source JSON.\n- change: Information was updated in the source JSON.\n- disconnect: Information was disconnected from the source JSON.\n- nochange: No change occurred on the source JSON.\n\nData type: String\n\n |
| \n\ndataObject.lineItems.\\_commitObjectInfo\n\n | \n\nReturned if the line item change is an `ENGAGE` action. Has the object’s commit status and sys\\_id.Data type: Object\n\n```\n\"_commitObjectInfo\": { \n \"status\": \"String\", \n \"sys_id\": \"String\" \n}\n```\n\n |
| \n\ndataObject.lineItems.\\_commitObjectInfo.status\n\n | \n\nStatus of the commit operation performed on the particular entity. Possible values:\n\n- success: The entity commit operation was correct.\n- if...not: The entity commit operation wasn't correct.\n\nData type: String\n\n |
| \n\ndataObject.lineItems.\\_commitObjectInfo.sys\\_id\n\n | \n\nSys\\_id of the inserted record. The updated table possibly change between entities. For example, Order \\[sn\\_ind\\_tmt\\_orm\\_order\\].Data type: String\n\n |
| \n\ndataObject.lineItems.\\_glide\\_action\n\n | \n\nChange action that occurred on the line item.Possible values:\n\n- DELETE: Information was removed between the source and target JSON structures.\n- INSERT: Information was added between the source and target JSON structures.\n- NO\\_CHANGE: No change occurred between the source and target JSON structures.\n- UPDATE: Information was modified between the source and JSON structures.\n\nData type: String\n\n |
| \n\ndataObject.lineItems.\\_source\\_object\n\n | \n\nSource entity record details to which the \\_glide\\_action was applied. This object may vary between entities.Data type: Object\n\n```\n\"_source_object\": { \n \"sys_id\": \"String\",\n \"table\": \"String\" \n}\n```\n\n |
| \n\ndataObject.lineItems.\\_source\\_object.sys\\_id\n\n | \n\nSys\\_id of the source entity record to which the \\_glide\\_action was applied. Data type: String\n\n |
| \n\ndataObject.lineItems.\\_source\\_object.table\n\n | \n\nTable name of the source entity record to which the \\_glide\\_action was applied.Data type: String\n\n |
| \n\ndataObject.lineItems.\\_state\n\n | \n\nCondition of the object.Possible values:\n\n- active: The entity object is in an active condition.\n- inactive: The entity object isn't in an active condition.\n\nData type: String\n\n |
| \n\ndataObject.lineItems.attributes\n\n | \n\nAttributes of the line item. For example, the attribute's name and value. May contain varying fields based on the entity.Data type: Object\n\n```\n\"attributes\": { \n \" |
| \n\ndataObject.lineItems.attributes.<attribute\\_name>\n\n | \n\nName of the line item attribute. For example, the name of an account or contact. May contain varying fields of the entity.Data type: Object\n\n```\n\"attributes\": { \n \" |
| \n\ndataObject.lineItems.attributes.<attribute\\_name>.value\n\n | \n\nValue of the line item attribute. Data type: String\n\n |
| \n\ndataObject.lineItems.characteristics\n\n | \n\nList of characteristics associated with the line item. Characteristics may vary between entities.Data type: Array of Objects\n\n```\n\"characteristics\": [ \n {\n \"_glide_action: \"String\",\n \"attributes\": {Object},\n \"sys_id\": {Object}, \n \"table\": \"String\"\n } \n]\n```\n\n |
| \n\ndataObject.lineItems.characteristics.\\_glide\\_action\n\n | \n\nChange action that occurred on the line item.Possible values:\n\n- DELETE: Information was removed between the source and target JSON structures.\n- INSERT: Information was added between the source and target JSON structures.\n- NO\\_CHANGE: No change occurred between the source and target JSON structures.\n- UPDATE: Information was modified between the source and JSON structures.\n\nData type: String\n\n |
| \n\ndataObject.lineItems.characteristics.attributes\n\n | \n\nOne or more objects that contain information about attributes associated with the characteristic record.For example, this object could contain references to the attributes record's sys\\_id, associated characteristic records, accounts or contacts, characteristic option records, or sold product information.\n\nData type: Object\n\n```\n\"attributes\": {\n \" |
| \n\ndataObject.lineItems.characteristics.attributes.<attribute\\_type>\n\n | \n\nName of the quality attribute. Possibly contain varying fields of the entity.Data type: Object\n\n```\n\" |
| \n\ndataObject.lineItems.characteristics.attributes.<attribute\\_type>.<attribute\\_name>\n\n | \n\nName of the quality attribute.Data type: Object\n\n```\n\" |
| \n\ndataObject.lineItems.characteristics.attributes.<attribute\\_type>.<attribute\\_name>.value\n\n | \n\nValue of the line item attribute.Data type: String\n\n |
| \n\ndataObject.lineItems\\[0\\].characteristics.sys\\_id\n\n | \n\nSys\\_id of the associated characteristic record.Data type: Object\n\n```\n\"sys_id\": { \n \"value\": \"String\" \n }\n```\n\n |
| \n\ndataObject.lineItems\\[0\\].characteristics.sys\\_id.value\n\n | \n\nSys\\_id of the associated characteristic record. The updated table may vary between entities. For example, Order \\[sn\\_ind\\_tmt\\_orm\\_order\\].Data type: String\n\n |
| \n\ndataObject.lineItems\\[0\\].characteristics.table\n\n | \n\nName of the table containing the characteristic record.Data type: String\n\n |
| \n\ndataObject.lineItems\\[0\\].lineItems\n\n | \n\nChild line items of a parent line item. This object has the same format as the **lineItems** parameter.Data type: Array of Objects\n\n```\n\"lineItems\": [ \n { \n \"_glide_action\": \"String\",\n \"attributes\": {Object},\n \"characteristics\": [Array],\n \"lineItems\": [Array],\n \"sys_id\": {Object},\n \"table\": \"String\"\n } \n]\n```\n\n |
| \n\ndataObject.lineItems\\[0\\].sys\\_id\n\n | \n\nSys\\_id of the associated item record.Data type: Object\n\n```\n\"sys_id\": {\n \"value\": \"String\"\n}\n```\n\n |
| \n\ndataObject.lineItems\\[0\\].sys\\_id.value\n\n | \n\nSys\\_id of an associated item record. The updated table may vary between entities, like Order or Specification. For example, Order \\[sn\\_ind\\_tmt\\_orm\\_order\\]. Data type: String\n\n |
| \n\ndataObject.lineItems\\[0\\].table\n\n | \n\nName of the table that contains the item record associated with the lead to cash entity. Data type: String\n\n |
| \n\ndataObject.sys\\_id\n\n | \n\nSys\\_id of the associated line item record. The updated table possibly change between entities. For example, Order \\[sn\\_ind\\_tmt\\_orm\\_order\\]. Data type: String\n\n |
| \n\ndataObject.table\n\n | \n\nName of the table that has the record of the lead to cash entity.Data type: String\n\n |
| \n\ndisplayMessage\n\n | \n\nMessage that is displayed to the user in the UI. The display message is identical to the **message** string value.Data type: String\n\n |
| \n\nerror\n\n | \n\nError message that describes the if...not of the commitInstance method. If the request is correct, this parameter returns an empty string.Data type: String\n\n |
| \n\nheaderID\n\n | \n\nRequired only for entities with a header. Sys\\_id of the target entity record created or updated by the commitInstance method. Stored in: The related table depending on the entity type, like sold material, order, etc.\n\nData type: String\n\n |
| \n\nmessage\n\n | \n\nMessage describing the success, error, or partially\\_success scenarios. This message is the same as the **displayMessage** string value and can be used by other apply calls to the API.Data type: String\n\n |
| \n\nrootLineIDs\n\n | \n\nRequired only for no-header entities. Comma-separated list of sys\\_ids of the target entity records inserted, updated, or deleted by the commitInstance method. Stored in: The related table depending on the entity type, like sold material, order, etc.\n\nData type: Array of Strings\n\n |
| \n\nstatus\n\n | \n\nStatus message confirming the success of the commit. Possible values:\n\n- success: The commit was correct.\n- if...not: The root line or header glide operation unserviceable. Retrigger the LeadtoCashCore API flow.\n- partial\\_success: There were failures while processing the entire JSON. Refer to processing logs to troubleshooting specific errors.\n\nData type: String\n\n |