---
sourceDocument: Brazil Sales Customer Relationship Management
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/order-management

 Release :

    - brazil

ft:locale :

    - en-US

ft:publication_title :

    - Brazil Sales Customer Relationship Management

ft:clusterId :

    - omgmt

bundleId :

    - omgmt

workflow :

    - Customer and Industry


---

# Pricing payload field mapping

# Pricing payload field mapping {#ariaid-title1}

Release version: Brazil  
Updated October 29, 2026  
![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes to read  
Pricing payload fields that ServiceNow Quote Experience sends to the pricing service, with the ServiceNow Quote Experience field each one maps to. Use this reference to check header, line item, and entity metadata values in the payload.

## Reading the mapping {#r_pricing_payload_field_mapping__section_conventions}

Values in code format in the TXM field column are ServiceNow Quote Experience field names. Values in plain text are literal values or descriptions sent to Pricing instead of a field. Fields marked Not sent, or Not productizing, aren't sent to Pricing at this time.

## Header fields {#r_pricing_payload_field_mapping__section_header_fields}

{#r_pricing_payload_field_mapping__table_z23_43r_clc__entry__4}

| Pricing payload field | Pricing field type | TXM field | Required |
|-|-|-|-|
| `header.source_system` | Text | sn_l2c_quote_exp | Yes |
| `header.sys_class_name` | Text |   | No |
| `header.requesting_record_id` | Reference | `txn.id` | Yes |
| `header.currency` | Text | `txn.pricing.currencyCode` | Yes |
| `header.transaction_date` | Date | `txn.quoteDate` | No. Sent automatically through a context variable mapping. The line-level transaction_date already covers it. |
| `header.pricelist` |   | `txn.pricebook.id` |   |
| `header.costbook` | Reference | `txn.costbook`. Not sent by default. Implementers can create the mapping to include it. | Optional |
| `header.account` | Reference | `txn.account.id` | Yes |
[Table 1. Header payload fields]

{#r_pricing_payload_field_mapping__table_z23_43r_clc}

## Line item fields {#r_pricing_payload_field_mapping__section_line_item_fields}

{#r_pricing_payload_field_mapping__table_af3_43r_clc__entry__4}

| Pricing payload field | Pricing field type | TXM field | Required |
|-|-|-|-|
| `header.lineItems.account` | Reference | Derived internally from the header account when the line value is blank. To keep the line value in sync, run the `txn.populateLineDefaults` rule group before the Reprice action. | Yes |
| `header.lineItems.currency` |   | Derived internally from the header currency. Always set at least the header currency for pricing to work. | No |
| `header.lineItems.line_type` | Text | `txn.line.lineType` | Yes |
| `header.lineItems.action` | Text | `txn.line.lineAction` | Yes |
| `header.lineItems.pricelist` | Reference | Derived internally from the header pricelist when the line value is blank. To keep the line value in sync, run the `txn.populateLineDefaults` rule group before the Reprice action. | Yes |
| `header.lineItems.product_offering` | Reference | `txn.line.product.partnerId` | Yes |
| `header.lineItems.quantity` | Decimal | `txn.line.quantity` | Yes |
| `header.lineItems.selected` | Boolean | Not applicable | Not applicable |
| `header.lineItems.shipping_city` | Text | Not Productizing | Optional |
| `header.lineItems.shipping_country` | Text | Not Productizing | Optional |
| `header.lineItems.shipping_state` | Text | Not Productizing | Optional |
| `header.lineItems.term_month` | Decimal | `txn.line.term` | Optional |
| `header.lineItems[].top_product_offer` | Reference | Derived internally. Line's top line's txn.line.product.partnerId | No |
| `header.lineItems[].top_line_id` | Text | Derived internally. Line's top line's txn.line.id. For a top-level or standalone line, this is the same as line_id. | Yes |
| `header.lineItems.parent_product_offer` | Reference | Derived internally. Line's parent line's txn.line.product.partnerId | No |
| `header.lineItems[].parent_line_id` | Text | Derived internally. Line's parent line's txn.line.id. For a top-level or standalone line, this is blank. | Yes |
| `header.lineItems.unit_of_measure` | Reference | `txn.line.product.uom` | Yes |
| `header.lineItems.transaction_date` | Date | `txn.quoteDate` | Yes |
| `header.lineItems.line_id` | Text | `txn.line.id` | Yes |
| `header.lineItems.characteristics` | Array\[Characteristic\] | `txn.line.product.characteristics`. Sent only when this field has a non-blank value. | Optional |
| `header.lineItems.characteristics.characteristic` | Reference | Sent as part of each Characteristic object in the characteristics array | Optional |
| `header.lineItems.characteristics.characteristic_option` | Reference | Sent as part of each Characteristic object in the characteristics array | Optional |
| `header.lineItems.characteristics.characteristic_option_value` |   | Sent as part of each Characteristic object in the characteristics array | Optional |
| `header.lineItems.line_ramp` |   | Not sent. Not productizing at the moment. | Optional |
| `header.lineItems.ramp_type` |   | Not sent. Not productizing at the moment. | Optional |
| `header.lineItems.ramp_api` |   | Not sent. Not productizing at the moment. | Optional |
| `header.lineItems.source_sold_product` |   | `txn.line.source.splitFromSoldProduct` | Optional |
| `header.lineItems.delta_price_treatment` |   | `txn.line.pricing.delta.priceTreatment` | Optional |
| `header.lineItems.renewed_from_contract_line` |   | `txn.line.source.contract.line` | Optional |
| `header.lineItems.renewed_from_entitlement` |   | `txn.line.source.entitlement` | Optional |
| `header.lineItems.consolidated_from_contract_lines` |   | `txn.line.source.consolidation.lines` | Optional |
| `header.lineItems.pricingAdjustments.adjustment_type` | Text | `txn.line.pricing.discount.adjustmentType` | Optional |
| `header.lineItems.pricingAdjustments.adjustment_value` | Decimal | `txn.line.pricing.discount.value` | Optional |
| `header.lineItems.pricingAdjustments.name` | Text | `txn.line.pricing.discount.description` | Optional |
[Table 2. Line item payload fields]

{#r_pricing_payload_field_mapping__table_af3_43r_clc}

## Entity metadata and settings {#r_pricing_payload_field_mapping__section_entity_fields}

{#r_pricing_payload_field_mapping__table_bf3_43r_clc__entry__4}

| Pricing payload field | Pricing field type | TXM field | Required |
|-|-|-|-|
| `entity_meta_data.entity_id` | Text | sn_l2c_quote | Yes |
| `entity_meta_data.scope` | Text | quote_experience | No |
| `entity_meta_data.config_top_line_identifier` | Number | Not needed | No |
| `entity_meta_data.header_sys_class_name` | Text | Not needed | No |
| `entity_meta_data.header_sys_id` | Reference | `txn.id` | No |
| `entity_meta_data.line_sys_class_name` | Text | Not needed | No |
| `entity_meta_data.price_line_id` | Array\[Number\] | Not sent | No |
| `entity_meta_data.settings.pricing_elements` | Text | PRICE,NET_PRICE,HEADER_ROLLUPS,LINE_ROLLUPS,COST,ADJUSTMENTS,DELTA | Yes |
| `entity_meta_data.settings.execution_mode` | Text | sync | Yes |
| `entity_meta_data.settings.disable_validation` | Boolean | Sent with the hard-coded value true | No |
[Table 3. Entity metadata and settings payload fields]

{#r_pricing_payload_field_mapping__table_bf3_43r_clc}

