@zeniai/client-epic-state 5.2.3 → 5.2.4

package/lib/entity/invoicing/invoicingCommonPayload.d.ts

@@ -228,6 +228,33 @@ export declare function invoicingOptionCodes(options: InvoicingNamedOption[]): s
  * frontend release, so consumers must branch on what the map returns rather
  * than on a hardcoded list.
  */
+/**
+ * Field-help groups on `GET /1.0/config`'s `field_help`. Closed union because
+ * the client decides which group a screen belongs to — a screen names its group
+ * in code, so an unknown one is a client bug rather than backend data.
+ */
+export declare const ALL_INVOICING_FIELD_HELP_GROUPS: readonly ["catalog", "credit_note", "customer", "data_import", "discount", "dunning", "invoice", "payment", "settings", "subscription"];
+export type InvoicingFieldHelpGroup = (typeof ALL_INVOICING_FIELD_HELP_GROUPS)[number];
+export interface InvoicingFieldHelpEntryWire {
+    code?: string;
+    description?: string;
+}
+export type InvoicingFieldHelpWire = Partial<Record<string, InvoicingFieldHelpEntryWire[]>>;
+/** Help copy for one group, keyed by field code for O(1) lookup per row. */
+export type InvoicingFieldHelpByCode = Record<string, string>;
+/**
+ * Help copy per group. `Partial` because a group the backend has not populated
+ * — or an environment whose backend predates `field_help` — must render no icon
+ * rather than an empty tooltip.
+ */
+export type InvoicingFieldHelp = Partial<Record<InvoicingFieldHelpGroup, InvoicingFieldHelpByCode>>;
+/**
+ * Flattens each group's entry array into a `code -> description` map. Done once
+ * when config loads so a row render is a key lookup rather than an array scan.
+ * Entries without a code or with blank copy are dropped, so a lookup miss and
+ * "backend sent an empty string" are the same thing to the UI: no icon.
+ */
+export declare function toInvoicingFieldHelp(fieldHelp: InvoicingFieldHelpWire): InvoicingFieldHelp;
 export type InvoicingNamedOptionsByKeyWire = Record<string, InvoicingNamedOptionWire[]>;
 export type InvoicingNamedOptionsByKey = Record<string, InvoicingNamedOption[]>;
 export declare function toInvoicingNamedOptionsByKey(optionsByKey: InvoicingNamedOptionsByKeyWire): InvoicingNamedOptionsByKey;

package/lib/entity/invoicing/invoicingCommonPayload.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.INVOICING_QBO_CUSTOMER_MATCHING_MODES = exports.INVOICING_DISCOUNT_LIFECYCLE_ACTIONS = exports.INVOICING_CATALOG_PRODUCT_LIFECYCLE_ACTIONS = exports.INVOICING_CATALOG_ITEM_LIFECYCLE_ACTIONS = exports.INVOICING_SUBSCRIPTION_LIFECYCLE_ACTIONS = exports.INVOICING_DUNNING_ACTIONS = void 0;
+exports.ALL_INVOICING_FIELD_HELP_GROUPS = exports.INVOICING_QBO_CUSTOMER_MATCHING_MODES = exports.INVOICING_DISCOUNT_LIFECYCLE_ACTIONS = exports.INVOICING_CATALOG_PRODUCT_LIFECYCLE_ACTIONS = exports.INVOICING_CATALOG_ITEM_LIFECYCLE_ACTIONS = exports.INVOICING_SUBSCRIPTION_LIFECYCLE_ACTIONS = exports.INVOICING_DUNNING_ACTIONS = void 0;
 exports.toInvoicingDunningAction = toInvoicingDunningAction;
 exports.toInvoicingSubscriptionLifecycleAction = toInvoicingSubscriptionLifecycleAction;
 exports.toInvoicingSubscriptionLifecycleActionOption = toInvoicingSubscriptionLifecycleActionOption;
@@ -17,6 +17,7 @@ exports.toInvoicingQboAccountMappingKindOption = toInvoicingQboAccountMappingKin
 exports.toInvoicingNamedOption = toInvoicingNamedOption;
 exports.toInvoicingFormOption = toInvoicingFormOption;
 exports.invoicingOptionCodes = invoicingOptionCodes;
+exports.toInvoicingFieldHelp = toInvoicingFieldHelp;
 exports.toInvoicingNamedOptionsByKey = toInvoicingNamedOptionsByKey;
 exports.toInvoicingSubscriptionEditFieldOption = toInvoicingSubscriptionEditFieldOption;
 exports.toAuditLogEntityRouteOption = toAuditLogEntityRouteOption;
@@ -219,6 +220,56 @@ function toInvoicingFormOption(option) {
 function invoicingOptionCodes(options) {
     return options.map((option) => option.code);
 }
+/**
+ * A config-driven map from some key (a pricing model, a status, …) to the
+ * options allowed for it. Lets the backend widen an allowed set without a
+ * frontend release, so consumers must branch on what the map returns rather
+ * than on a hardcoded list.
+ */
+/**
+ * Field-help groups on `GET /1.0/config`'s `field_help`. Closed union because
+ * the client decides which group a screen belongs to — a screen names its group
+ * in code, so an unknown one is a client bug rather than backend data.
+ */
+exports.ALL_INVOICING_FIELD_HELP_GROUPS = [
+    'catalog',
+    'credit_note',
+    'customer',
+    'data_import',
+    'discount',
+    'dunning',
+    'invoice',
+    'payment',
+    'settings',
+    'subscription',
+];
+const isInvoicingFieldHelpGroup = (group) => exports.ALL_INVOICING_FIELD_HELP_GROUPS.includes(group);
+/**
+ * Flattens each group's entry array into a `code -> description` map. Done once
+ * when config loads so a row render is a key lookup rather than an array scan.
+ * Entries without a code or with blank copy are dropped, so a lookup miss and
+ * "backend sent an empty string" are the same thing to the UI: no icon.
+ */
+function toInvoicingFieldHelp(fieldHelp) {
+    const byGroup = {};
+    Object.entries(fieldHelp).forEach(([group, entries]) => {
+        if (!isInvoicingFieldHelpGroup(group) || !Array.isArray(entries)) {
+            return;
+        }
+        const byCode = {};
+        entries.forEach((entry) => {
+            const code = entry?.code?.trim() ?? '';
+            const description = entry?.description?.trim() ?? '';
+            if (code !== '' && description !== '') {
+                byCode[code] = description;
+            }
+        });
+        if (Object.keys(byCode).length > 0) {
+            byGroup[group] = byCode;
+        }
+    });
+    return byGroup;
+}
 function toInvoicingNamedOptionsByKey(optionsByKey) {
     return Object.fromEntries(Object.entries(optionsByKey).map(([key, options]) => [
         key,

package/lib/esm/entity/invoicing/invoicingCommonPayload.js

@@ -195,6 +195,56 @@ export function toInvoicingFormOption(option) {
 export function invoicingOptionCodes(options) {
     return options.map((option) => option.code);
 }
+/**
+ * A config-driven map from some key (a pricing model, a status, …) to the
+ * options allowed for it. Lets the backend widen an allowed set without a
+ * frontend release, so consumers must branch on what the map returns rather
+ * than on a hardcoded list.
+ */
+/**
+ * Field-help groups on `GET /1.0/config`'s `field_help`. Closed union because
+ * the client decides which group a screen belongs to — a screen names its group
+ * in code, so an unknown one is a client bug rather than backend data.
+ */
+export const ALL_INVOICING_FIELD_HELP_GROUPS = [
+    'catalog',
+    'credit_note',
+    'customer',
+    'data_import',
+    'discount',
+    'dunning',
+    'invoice',
+    'payment',
+    'settings',
+    'subscription',
+];
+const isInvoicingFieldHelpGroup = (group) => ALL_INVOICING_FIELD_HELP_GROUPS.includes(group);
+/**
+ * Flattens each group's entry array into a `code -> description` map. Done once
+ * when config loads so a row render is a key lookup rather than an array scan.
+ * Entries without a code or with blank copy are dropped, so a lookup miss and
+ * "backend sent an empty string" are the same thing to the UI: no icon.
+ */
+export function toInvoicingFieldHelp(fieldHelp) {
+    const byGroup = {};
+    Object.entries(fieldHelp).forEach(([group, entries]) => {
+        if (!isInvoicingFieldHelpGroup(group) || !Array.isArray(entries)) {
+            return;
+        }
+        const byCode = {};
+        entries.forEach((entry) => {
+            const code = entry?.code?.trim() ?? '';
+            const description = entry?.description?.trim() ?? '';
+            if (code !== '' && description !== '') {
+                byCode[code] = description;
+            }
+        });
+        if (Object.keys(byCode).length > 0) {
+            byGroup[group] = byCode;
+        }
+    });
+    return byGroup;
+}
 export function toInvoicingNamedOptionsByKey(optionsByKey) {
     return Object.fromEntries(Object.entries(optionsByKey).map(([key, options]) => [
         key,

package/lib/esm/index.js

@@ -763,7 +763,7 @@ export { initializeInvoicingCustomerAddress, resetEditInvoicingCustomerDetailVie
 export { INVOICING_CUSTOMER_BILLING_ADDRESS_TYPE, entityToInvoicingCustomerFormLocalData, initialInvoicingCustomerFormLocalData, } from './view/invoicing/editInvoicingCustomerDetailView/invoicingCustomerFormConfig';
 export { getInvoicingCustomerFormView } from './view/invoicing/editInvoicingCustomerDetailView/editInvoicingCustomerDetailViewSelector';
 export { fetchInvoicingSubscriptionFormPage, initializeInvoicingSubscriptionAddress, resetEditInvoicingSubscriptionDetailView, submitInvoicingSubscriptionForm, updateInvoicingSubscriptionFormDraft, } from './view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewReducer';
-export { INVOICING_SUBSCRIPTION_BILLING_FREQUENCY_VALUES, INVOICING_SUBSCRIPTION_SHIPPING_ADDRESS_TYPE, entityToInvoicingSubscriptionFormLocalData, initialInvoicingSubscriptionFormLocalData, invoicingSubscriptionTodayIso, toInvoicingSubscriptionQuantity, } from './view/invoicing/editInvoicingSubscriptionDetailView/invoicingSubscriptionFormConfig';
+export { INVOICING_SUBSCRIPTION_SHIPPING_ADDRESS_TYPE, entityToInvoicingSubscriptionFormLocalData, initialInvoicingSubscriptionFormLocalData, invoicingSubscriptionTodayIso, toInvoicingSubscriptionQuantity, } from './view/invoicing/editInvoicingSubscriptionDetailView/invoicingSubscriptionFormConfig';
 export { getEditInvoicingSubscriptionDetailViewState, getInvoicingSubscriptionFormView, } from './view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewSelector';
 export { archiveInvoicingCatalogSubFamily, createInvoicingCatalogSubFamily, resetEditInvoicingCatalogItemDetailView, saveInvoicingCatalogItem, submitInvoicingCatalogItemForm, updateInvoicingCatalogItemFormDraft, } from './view/invoicing/editInvoicingCatalogItemDetailView/editInvoicingCatalogItemDetailViewReducer';
 export { catalogDetailEditValuesToSavePayload, createSubFamilyFormToPayload, planToCatalogDetailEditValues, productToCreateSubFamilyFormValues, } from './view/invoicing/editInvoicingCatalogItemDetailView/catalogDetailEditPayload';

package/lib/esm/view/invoicing/auditView/auditViewPayload.js

@@ -39,6 +39,16 @@ function formatActor(actor, sourceLabel) {
     }
     return name;
 }
+/**
+ * The backend's human-readable action text, or `undefined` when it carries none.
+ * Blank copy collapses to `undefined` so the UI's `humanizeToken` fallback runs
+ * instead of rendering an empty Action cell, and surrounding whitespace is
+ * trimmed so the stored value is what should be displayed verbatim.
+ */
+function invoicingAuditActionLabel(actionLabel) {
+    const trimmed = actionLabel?.trim() ?? '';
+    return trimmed !== '' ? trimmed : undefined;
+}
 export function mapAuditLogEntry(entry) {
     const sourceLabel = entry.source_label ?? '';
     return {
@@ -49,6 +59,7 @@ export function mapAuditLogEntry(entry) {
         source: entry.source,
         sourceLabel: sourceLabel || undefined,
         action: entry.action,
+        actionLabel: invoicingAuditActionLabel(entry.action_label),
         entityId: entry.entity_id,
         entityType: entry.entity_type,
         customerId: entry.customer_id ?? undefined,

package/lib/esm/view/invoicing/createInvoice/createInvoiceSelector.js

@@ -1,5 +1,6 @@
 import { getAddressByAddressId } from '../../../entity/address/addressSelector';
 import { getInvoicingCatalogListView, getInvoicingCatalogPrices, } from '../invoicingCatalogListView/invoicingCatalogListViewSelector';
+import { invoicingFieldHelpForGroup } from '../invoicingConfigView/invoicingConfigViewSelector';
 import { getInvoicingCustomerListView } from '../invoicingCustomerListView/invoicingCustomerListViewSelector';
 import { getInvoicingSettings } from '../settingsView/settingsViewSelector';
 /**
@@ -32,6 +33,7 @@ export const getCreateInvoiceFormView = (state) => {
     const createInvoiceState = state.invoicingCreateInvoiceState;
     const catalogListView = getInvoicingCatalogListView(state);
     return {
+        fieldHelp: invoicingFieldHelpForGroup(state, 'invoice'),
         customers: getInvoicingCustomerListView(state).customers.map((customer) => ({
             billingAddress: customer.billingAddressId != null
                 ? getAddressByAddressId(state.addressState, customer.billingAddressId)

package/lib/esm/view/invoicing/editInvoicingCatalogItemDetailView/editInvoicingCatalogItemDetailViewSelector.js

@@ -1,6 +1,6 @@
 import { createSelector } from '@reduxjs/toolkit';
 import { getInvoicingPlanById, getInvoicingPlansByIds, } from '../../../entity/invoicing/plan/planSelector';
-import { getInvoicingConfigView } from '../invoicingConfigView/invoicingConfigViewSelector';
+import { getInvoicingConfigView, invoicingFieldHelpForGroup, } from '../invoicingConfigView/invoicingConfigViewSelector';
 import { INVOICING_CATALOG_APPLICABILITY_VALUES, INVOICING_CATALOG_PRICING_MODEL_VALUES, INVOICING_CATALOG_PRORATION_VALUES, INVOICING_CATALOG_TIER_TYPE_VALUES, entityToInvoicingCatalogItemFormLocalData, } from './invoicingCatalogItemFormConfig';
 export const getEditInvoicingCatalogItemDetailViewState = (state) => ({
     fetchState: state.editInvoicingCatalogItemDetailViewState.fetchState,
@@ -50,6 +50,7 @@ export const getInvoicingCatalogItemFormView = (state, id) => {
         : allApplicableItemOptions;
     const { billingPeriodUnitOptions, catalogItemTypeOptions, catalogTierTypeOptionsByPricingModel, catalogTrialEndActionOptions, catalogTrialUnitOptions, } = getInvoicingConfigView(state);
     return {
+        fieldHelp: invoicingFieldHelpForGroup(state, 'catalog'),
         applicabilityValues: INVOICING_CATALOG_APPLICABILITY_VALUES,
         applicableItemOptions,
         localData,

package/lib/esm/view/invoicing/editInvoicingCouponDetailView/editInvoicingCouponDetailViewSelector.js

@@ -1,6 +1,6 @@
 import { getInvoicingCouponById } from '../../../entity/invoicing/coupon/couponSelector';
 import { toInvoicingFormOption, } from '../../../entity/invoicing/invoicingCommonPayload';
-import { getInvoicingConfigView } from '../invoicingConfigView/invoicingConfigViewSelector';
+import { getInvoicingConfigView, invoicingFieldHelpForGroup, } from '../invoicingConfigView/invoicingConfigViewSelector';
 import { entityToInvoicingCouponFormLocalData, } from './editInvoicingCouponDetailViewState';
 /**
  * Bundled view for the discount create/edit form: the save fetch state/error,
@@ -37,6 +37,7 @@ export const getInvoicingCouponFormView = (state, couponId) => {
         : newCouponDraft;
     const { billingPeriodUnitOptions, discountApplyOnOptions, discountDurationTypeOptions, discountTypeOptions, } = getInvoicingConfigView(state);
     return {
+        fieldHelp: invoicingFieldHelpForGroup(state, 'discount'),
         ...base,
         applyOnOptions: discountApplyOnOptions.map(toInvoicingFormOption),
         discountTypeOptions: discountTypeOptions.map(toInvoicingFormOption),

package/lib/esm/view/invoicing/editInvoicingCustomerDetailView/editInvoicingCustomerDetailViewSelector.js

@@ -1,6 +1,6 @@
 import { getInvoicingCustomerById } from '../../../entity/invoicing/invoicingCustomer/invoicingCustomerSelector';
 import { getFormattedAddress } from '../../addressView/addressViewSelector';
-import { getInvoicingConfigView } from '../invoicingConfigView/invoicingConfigViewSelector';
+import { getInvoicingConfigView, invoicingFieldHelpForGroup, } from '../invoicingConfigView/invoicingConfigViewSelector';
 import { INVOICING_CUSTOMER_BILLING_ADDRESS_TYPE, entityToInvoicingCustomerFormLocalData, } from './invoicingCustomerFormConfig';
 /**
  * Bundled view for the customer create/edit form. Exposes the draft `localData`
@@ -29,6 +29,7 @@ export const getInvoicingCustomerFormView = (state, invoicingCustomerID) => {
         : undefined;
     const { customerTypeOptions, netTermDayOptions, taxabilityOptions } = getInvoicingConfigView(state);
     return {
+        fieldHelp: invoicingFieldHelpForGroup(state, 'customer'),
         customerTypeOptions,
         localData,
         mode,

package/lib/esm/view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewPayload.js

@@ -1,5 +1,5 @@
 import { toAddressUpdatableInfoPayload } from '../../addressView/addressViewPayload';
-import { billingFrequencyToPeriod, invoicingSubscriptionTodayIso, toInvoicingSubscriptionBillingCycles, toInvoicingSubscriptionQuantity, } from './invoicingSubscriptionFormConfig';
+import { invoicingSubscriptionTodayIso, toInvoicingSubscriptionBillingCycles, toInvoicingSubscriptionQuantity, } from './invoicingSubscriptionFormConfig';
 /**
  * Build the create/update subscription request body from the form draft. The
  * shipping address is sent as an object (captured via the shared Address
@@ -8,9 +8,14 @@ import { billingFrequencyToPeriod, invoicingSubscriptionTodayIso, toInvoicingSub
  * `remaining_billing_cycles` is omitted when the user left the field empty, so
  * the backend applies the plan's own `billing_cycles` (or renews forever when
  * the plan sets no limit) rather than being pinned to a value the form invented.
+ *
+ * `billing_period` / `billing_period_unit` are deliberately absent. Billing
+ * cadence is a property of the selected price point, not of the subscription,
+ * and the backend derives it from that price point when the fields are omitted.
+ * Sending them made every price point whose cadence the form could not express
+ * — a daily plan, for instance — fail with a 422.
  */
 export const localDataToSaveInvoicingSubscriptionPayload = (localData, shippingAddress) => {
-    const frequency = billingFrequencyToPeriod(localData.billingFrequency);
     const items = [
         {
             item_price_code: localData.planPriceCode,
@@ -35,8 +40,6 @@ export const localDataToSaveInvoicingSubscriptionPayload = (localData, shippingA
     const remainingBillingCycles = toInvoicingSubscriptionBillingCycles(localData.remainingBillingCycles);
     return {
         auto_collection: localData.autoCollection ? 'on' : 'off',
-        billing_period: frequency.period,
-        billing_period_unit: frequency.unit,
         currency_code: localData.preferredCurrencyCode,
         customer_id: localData.customerId,
         started_at: startedAt !== '' ? startedAt : invoicingSubscriptionTodayIso(),

package/lib/esm/view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewSelector.js

@@ -2,9 +2,9 @@ import { getInvoicingSubscriptionById } from '../../../entity/invoicing/invoicin
 import { getFormattedAddress } from '../../addressView/addressViewSelector';
 import { getInvoicingCouponListItems } from '../couponView/couponViewSelector';
 import { getInvoicingCatalogListView, getInvoicingCatalogPrices, } from '../invoicingCatalogListView/invoicingCatalogListViewSelector';
-import { getInvoicingConfigView } from '../invoicingConfigView/invoicingConfigViewSelector';
+import { getInvoicingConfigView, invoicingFieldHelpForGroup, } from '../invoicingConfigView/invoicingConfigViewSelector';
 import { getInvoicingCustomerListView } from '../invoicingCustomerListView/invoicingCustomerListViewSelector';
-import { INVOICING_SUBSCRIPTION_BILLING_FREQUENCY_VALUES, INVOICING_SUBSCRIPTION_SHIPPING_ADDRESS_TYPE, entityToInvoicingSubscriptionFormLocalData, } from './invoicingSubscriptionFormConfig';
+import { INVOICING_SUBSCRIPTION_SHIPPING_ADDRESS_TYPE, entityToInvoicingSubscriptionFormLocalData, } from './invoicingSubscriptionFormConfig';
 export const getEditInvoicingSubscriptionDetailViewState = (state, invoicingSubscriptionID) => {
     const { error, fetchState, savedSubscriptionId } = state.editInvoicingSubscriptionDetailViewState;
     const { subscriptionCommercialEditAllowedFromStatuses, subscriptionLifecycleActionOptions, subscriptionMetadataEditAllowedFromStatuses, } = getInvoicingConfigView(state);
@@ -42,9 +42,7 @@ export const getInvoicingSubscriptionFormView = (state, invoicingSubscriptionID)
     const planPrices = getInvoicingCatalogPrices(catalogListView.plans);
     const addonAndChargePrices = getInvoicingCatalogPrices(catalogListView.products);
     return {
-        billingFrequencyValues: [
-            ...INVOICING_SUBSCRIPTION_BILLING_FREQUENCY_VALUES,
-        ],
+        fieldHelp: invoicingFieldHelpForGroup(state, 'subscription'),
         coupons: getInvoicingCouponListItems(state),
         customers: getInvoicingCustomerListView(state).customers,
         localData,

package/lib/esm/view/invoicing/editInvoicingSubscriptionDetailView/invoicingSubscriptionFormConfig.js

@@ -1,35 +1,6 @@
 import { dateNow } from '../../../zeniDayJS';
 /** `AddressType` key used when the subscription form opens the shared Address screen. */
 export const INVOICING_SUBSCRIPTION_SHIPPING_ADDRESS_TYPE = 'invoicing_subscription_shipping_address';
-/**
- * Canonical billing-frequency value set for the subscription form. CES owns the
- * values (and their period/unit mapping); web-components maps each value to a
- * localized label (same split as the customer form's value sets).
- */
-export const INVOICING_SUBSCRIPTION_BILLING_FREQUENCY_VALUES = [
-    'weekly',
-    'monthly',
-    'quarterly',
-    'half_yearly',
-    'yearly',
-];
-const BILLING_FREQUENCY_TO_PERIOD = {
-    weekly: { period: 1, unit: 'week' },
-    monthly: { period: 1, unit: 'month' },
-    quarterly: { period: 3, unit: 'month' },
-    half_yearly: { period: 6, unit: 'month' },
-    yearly: { period: 1, unit: 'year' },
-};
-/** Map a billing-frequency value to its API `billing_period` / `billing_period_unit`. */
-export const billingFrequencyToPeriod = (value) => BILLING_FREQUENCY_TO_PERIOD[value] ?? BILLING_FREQUENCY_TO_PERIOD.monthly;
-/** Map an existing subscription's period/unit back to a billing-frequency value. */
-export const periodToBillingFrequency = (period, unit) => {
-    const match = INVOICING_SUBSCRIPTION_BILLING_FREQUENCY_VALUES.find((value) => {
-        const mapped = BILLING_FREQUENCY_TO_PERIOD[value];
-        return mapped.period === period && mapped.unit === unit;
-    });
-    return match ?? 'monthly';
-};
 const subscriptionItemPriceCodes = (subscription, itemType) => subscription?.subscriptionItems
     ?.filter((item) => item.itemType === itemType)
     .map((item) => item.itemPriceCode)
@@ -80,7 +51,6 @@ export const initialInvoicingSubscriptionFormLocalData = {
     addonPriceCodes: [],
     addonQuantities: {},
     autoCollection: true,
-    billingFrequency: 'monthly',
     chargePriceCodes: [],
     chargeQuantities: {},
     couponId: '',
@@ -103,7 +73,6 @@ export const entityToInvoicingSubscriptionFormLocalData = (subscription) => {
         addonPriceCodes: subscriptionItemPriceCodes(subscription, 'addon'),
         addonQuantities: subscriptionItemQuantities(subscription, 'addon'),
         autoCollection: (subscription.autoCollection ?? 'on') === 'on',
-        billingFrequency: periodToBillingFrequency(subscription.billingPeriod, subscription.billingPeriodUnit),
         chargePriceCodes: subscriptionItemPriceCodes(subscription, 'charge'),
         chargeQuantities: subscriptionItemQuantities(subscription, 'charge'),
         couponId: subscription.coupons?.[0]?.couponCode ??

package/lib/esm/view/invoicing/invoiceDetail/invoiceDetailSelector.js

@@ -2,10 +2,12 @@ import recordGet from 'lodash/get';
 import { getAddressByAddressId } from '../../../entity/address/addressSelector';
 import { getInvoiceById } from '../../../entity/invoicing/invoice/invoiceSelector';
 import { getInvoicingInvoiceActionState } from '../invoiceAction/invoiceActionSelector';
+import { invoicingFieldHelpForGroup } from '../invoicingConfigView/invoicingConfigViewSelector';
 export const getInvoiceDetail = (state, invoiceId) => {
     const detail = recordGet(state.invoicingInvoiceDetailState.detailById, invoiceId, undefined);
     const invoice = getInvoiceById(state.invoicingInvoiceState, invoiceId);
     return {
+        fieldHelp: invoicingFieldHelpForGroup(state, 'invoice'),
         invoice,
         billingAddress: invoice?.billingAddressId != null
             ? getAddressByAddressId(state.addressState, invoice.billingAddressId)

package/lib/esm/view/invoicing/invoicingCatalogItemDetailView/invoicingCatalogItemDetailViewSelector.js

@@ -1,9 +1,10 @@
 import { getInvoicingPlanById } from '../../../entity/invoicing/plan/planSelector';
-import { getInvoicingConfigView } from '../invoicingConfigView/invoicingConfigViewSelector';
+import { getInvoicingConfigView, invoicingFieldHelpForGroup, } from '../invoicingConfigView/invoicingConfigViewSelector';
 export const getInvoicingCatalogItemDetail = (state, _kind, id) => {
     const { error, fetchState } = state.invoicingCatalogItemDetailViewState;
     const { billingPeriodUnitOptions, catalogItemLifecycleActionOptions, catalogItemTypeOptions, catalogProductLifecycleActionOptions, catalogTierTypeOptionsByPricingModel, catalogTrialEndActionOptions, catalogTrialUnitOptions, fetchState: configFetchState, } = getInvoicingConfigView(state);
     return {
+        fieldHelp: invoicingFieldHelpForGroup(state, 'catalog'),
         catalogItemLifecycleActionOptions,
         catalogProductLifecycleActionOptions,
         catalogTierTypeOptionsByPricingModel,

package/lib/esm/view/invoicing/invoicingConfigView/invoicingConfigViewReducer.js

@@ -1,5 +1,5 @@
 import { createSlice } from '@reduxjs/toolkit';
-import { toAuditLogEntityRouteOption, toInvoicingCatalogItemLifecycleActionOption, toInvoicingCatalogProductLifecycleActionOption, toInvoicingDiscountLifecycleActionOption, toInvoicingDunningAction, toInvoicingNamedOption, toInvoicingNamedOptionsByKey, toInvoicingQboAccountMappingKindOption, toInvoicingSubscriptionEditFieldOption, toInvoicingSubscriptionLifecycleActionOption, } from '../../../entity/invoicing/invoicingCommonPayload';
+import { toAuditLogEntityRouteOption, toInvoicingCatalogItemLifecycleActionOption, toInvoicingCatalogProductLifecycleActionOption, toInvoicingDiscountLifecycleActionOption, toInvoicingDunningAction, toInvoicingFieldHelp, toInvoicingNamedOption, toInvoicingNamedOptionsByKey, toInvoicingQboAccountMappingKindOption, toInvoicingSubscriptionEditFieldOption, toInvoicingSubscriptionLifecycleActionOption, } from '../../../entity/invoicing/invoicingCommonPayload';
 import { clearAll } from '../../../rootActions';
 export const initialState = {
     fetchState: 'Not-Started',
@@ -15,6 +15,7 @@ export const initialState = {
     catalogTrialUnitOptions: [],
     customerTypeOptions: [],
     dateFormatOptions: [],
+    fieldHelp: {},
     discountApplyOnOptions: [],
     discountDurationTypeOptions: [],
     discountTypeOptions: [],
@@ -75,6 +76,9 @@ export function mapInvoicingConfigPayloadToState(payload) {
         })),
         autoCollectionOptions: (payload.auto_collection_options ?? []).map(toInvoicingNamedOption),
         billingPeriodUnitOptions: (payload.billing_period_unit_options ?? []).map(toInvoicingNamedOption),
+        fieldHelp: payload.field_help != null
+            ? toInvoicingFieldHelp(payload.field_help)
+            : {},
         catalogTierTypeOptionsByPricingModel: payload.catalog_tier_type_options_by_pricing_model != null
             ? toInvoicingNamedOptionsByKey(payload.catalog_tier_type_options_by_pricing_model)
             : undefined,

package/lib/esm/view/invoicing/invoicingConfigView/invoicingConfigViewSelector.js

@@ -17,3 +17,10 @@ export const getInvoicingOnboardingGateView = (state) => {
         status: deriveInvoicingOnboardingStatus(state.invoicingConfigViewState.isInvoicingTosAccepted, state.invoicingConfigViewState.isInvoicingEnabled),
     };
 };
+/**
+ * One group's help copy, keyed by field code. Composed by the page-level view
+ * selectors rather than exported to the UI: a screen receives the slice for its
+ * own group, so no screen needs the config shape. Empty when the backend has
+ * not populated the group, which the UI reads as "render no icon".
+ */
+export const invoicingFieldHelpForGroup = (state, group) => state.invoicingConfigViewState.fieldHelp[group] ?? {};

package/lib/esm/view/invoicing/invoicingCouponDetailView/invoicingCouponDetailViewSelector.js

@@ -1,8 +1,10 @@
 import recordGet from 'lodash/get';
 import { getInvoicingCouponById } from '../../../entity/invoicing/coupon/couponSelector';
+import { invoicingFieldHelpForGroup } from '../invoicingConfigView/invoicingConfigViewSelector';
 export const getInvoicingCouponDetail = (state, id) => {
     const detail = recordGet(state.invoicingCouponDetailViewState.detailById, id, undefined);
     return {
+        fieldHelp: invoicingFieldHelpForGroup(state, 'discount'),
         coupon: getInvoicingCouponById(state.invoicingCouponState, id),
         fetchState: detail?.fetchState ?? 'Not-Started',
         error: detail?.error,

package/lib/esm/view/invoicing/invoicingCreditNoteDetailView/invoicingCreditNoteDetailViewSelector.js

@@ -1,8 +1,10 @@
 import { getInvoicingCreditNoteById as getInvoicingCreditNoteByIdFromState } from '../../../entity/invoicing/creditNote/creditNoteSelector';
+import { invoicingFieldHelpForGroup } from '../invoicingConfigView/invoicingConfigViewSelector';
 export const getInvoicingCreditNoteById = (state, id) => getInvoicingCreditNoteByIdFromState(state.invoicingCreditNoteState, id);
 export const getInvoicingCreditNoteDetail = (state, invoicingCreditNoteID) => {
     const { error, fetchState } = state.invoicingCreditNoteDetailViewState;
     return {
+        fieldHelp: invoicingFieldHelpForGroup(state, 'credit_note'),
         creditNote: getInvoicingCreditNoteById(state, invoicingCreditNoteID),
         fetchState,
         error,

package/lib/esm/view/invoicing/invoicingCustomerDetailView/invoicingCustomerDetailViewSelector.js

@@ -2,6 +2,7 @@ import recordGet from 'lodash/get';
 import { getInvoicesByIds } from '../../../entity/invoicing/invoice/invoiceSelector';
 import { getInvoicingCustomerById, invoicingCustomerPaymentMethods, } from '../../../entity/invoicing/invoicingCustomer/invoicingCustomerSelector';
 import { getInvoicingPaymentLinkSendState, getInvoicingPaymentMethodSaveState, getInvoicingPlaidLinkToken, getInvoicingSentPaymentLinkEmail, getInvoicingSentPaymentLinkMagicUrl, getInvoicingSetupIntent, getInvoicingSetupIntentFetchState, } from '../customerPaymentMethod/customerPaymentMethodSelector';
+import { invoicingFieldHelpForGroup } from '../invoicingConfigView/invoicingConfigViewSelector';
 import { isStripeConnectedFromSettings } from '../settingsView/invoicingSettingsHelpers';
 import { getInvoicingSettings } from '../settingsView/settingsViewSelector';
 export const getInvoicingCustomerDetail = (state, invoicingCustomerID) => {
@@ -10,6 +11,7 @@ export const getInvoicingCustomerDetail = (state, invoicingCustomerID) => {
     const settings = getInvoicingSettings(state);
     const invoicingCustomer = getInvoicingCustomerById(invoicingCustomerState, invoicingCustomerID);
     return {
+        fieldHelp: invoicingFieldHelpForGroup(state, 'customer'),
         invoicingCustomer,
         invoices: getInvoicesByIds(state.invoicingInvoiceState, state.invoicingInvoiceListState.invoiceByTab[state.invoicingInvoiceListState.activeTab]?.invoiceIds ?? []),
         paymentMethods: invoicingCustomerPaymentMethods(invoicingCustomer),

package/lib/esm/view/invoicing/invoicingDunningCaseDetailView/invoicingDunningCaseDetailViewSelector.js

@@ -1,5 +1,6 @@
 import { getInvoicingDunningCaseById as getInvoicingDunningCaseByIdFromState } from '../../../entity/invoicing/dunningCase/dunningCaseSelector';
 import { getInvoicingDunningActionState } from '../dunningAction/dunningActionSelector';
+import { invoicingFieldHelpForGroup } from '../invoicingConfigView/invoicingConfigViewSelector';
 const EMAIL_PREVIEW_NOT_STARTED = {
     error: undefined,
     fetchState: 'Not-Started',
@@ -9,6 +10,7 @@ export const getInvoicingDunningCaseById = (state, id) => getInvoicingDunningCas
 export const getInvoicingDunningCaseDetail = (state, invoicingDunningCaseID) => {
     const { emailPreview, error, fetchState, id } = state.invoicingDunningCaseDetailViewState;
     return {
+        fieldHelp: invoicingFieldHelpForGroup(state, 'dunning'),
         actionState: getInvoicingDunningActionState(invoicingDunningCaseID)(state),
         dunningCase: getInvoicingDunningCaseById(state, invoicingDunningCaseID),
         emailPreview: id === invoicingDunningCaseID ? emailPreview : EMAIL_PREVIEW_NOT_STARTED,

package/lib/esm/view/invoicing/invoicingSubscriptionDetailView/invoicingSubscriptionDetailViewSelector.js

@@ -1,9 +1,11 @@
 import { getInvoicingSubscriptionById as getInvoicingSubscriptionByIdFromState } from '../../../entity/invoicing/invoicingSubscription/invoicingSubscriptionSelector';
+import { invoicingFieldHelpForGroup } from '../invoicingConfigView/invoicingConfigViewSelector';
 import { getInvoicingSubscriptionActionState } from '../subscriptionAction/subscriptionActionSelector';
 export const getInvoicingSubscriptionById = (state, id) => getInvoicingSubscriptionByIdFromState(state.invoicingSubscriptionState, id);
 export const getInvoicingSubscriptionDetail = (state, invoicingSubscriptionID) => {
     const { error, fetchState } = state.invoicingSubscriptionDetailViewState;
     return {
+        fieldHelp: invoicingFieldHelpForGroup(state, 'subscription'),
         actionState: getInvoicingSubscriptionActionState(invoicingSubscriptionID)(state),
         subscription: getInvoicingSubscriptionById(state, invoicingSubscriptionID),
         fetchState,

package/lib/esm/view/invoicing/issueCreditNote/issueCreditNoteSelector.js

@@ -1,5 +1,5 @@
 import { getInvoiceDetail } from '../invoiceDetail/invoiceDetailSelector';
-import { getInvoicingConfigView } from '../invoicingConfigView/invoicingConfigViewSelector';
+import { getInvoicingConfigView, invoicingFieldHelpForGroup, } from '../invoicingConfigView/invoicingConfigViewSelector';
 import { initialIssueCreditNoteFormLocalData } from './issueCreditNoteFormConfig';
 /**
  * The draft is a single global slice, so a draft seeded for a previously opened
@@ -13,6 +13,7 @@ export const getIssueCreditNoteView = (state, invoiceId) => {
     const isDraftForInvoice = draft.invoiceId === invoiceId;
     const { creditNoteReasonCodeOptions, creditNoteTypeOptions } = getInvoicingConfigView(state);
     return {
+        fieldHelp: invoicingFieldHelpForGroup(state, 'credit_note'),
         invoice: invoiceView.invoice,
         isPageReady: invoiceView.fetchState === 'Completed' &&
             isDraftForInvoice &&

package/lib/esm/view/invoicing/recordPayment/recordPaymentSelector.js

@@ -1,6 +1,6 @@
 import { invoicingOptionCodes, } from '../../../entity/invoicing/invoicingCommonPayload';
 import { getInvoiceListView } from '../invoiceList/invoiceListSelector';
-import { getInvoicingConfigView } from '../invoicingConfigView/invoicingConfigViewSelector';
+import { getInvoicingConfigView, invoicingFieldHelpForGroup, } from '../invoicingConfigView/invoicingConfigViewSelector';
 /**
  * Single bundled view for the record-payment submit lifecycle — carries the
  * submit fetch state/error and the ids produced on success.
@@ -19,6 +19,7 @@ export const getRecordPaymentFormView = (state) => {
     const { contextInvoiceId, error, fetchState, newPaymentDraft } = state.invoicingRecordPaymentState;
     const { manualPaymentMethodOptions, paymentGatewayOptions } = getInvoicingConfigView(state);
     return {
+        fieldHelp: invoicingFieldHelpForGroup(state, 'payment'),
         contextInvoiceId,
         gatewayOptions: paymentGatewayOptions,
         localData: newPaymentDraft,

package/lib/index.d.ts

@@ -1110,7 +1110,7 @@ export type { InvoicingCustomerFormView } from './view/invoicing/editInvoicingCu
 export { fetchInvoicingSubscriptionFormPage, initializeInvoicingSubscriptionAddress, resetEditInvoicingSubscriptionDetailView, submitInvoicingSubscriptionForm, updateInvoicingSubscriptionFormDraft, } from './view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewReducer';
 export type { SubmitInvoicingSubscriptionFormPayload, UpdateInvoicingSubscriptionFormDraftPayload, } from './view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewReducer';
 export type { InvoicingSubscriptionFormLocalData } from './view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewState';
-export { INVOICING_SUBSCRIPTION_BILLING_FREQUENCY_VALUES, INVOICING_SUBSCRIPTION_SHIPPING_ADDRESS_TYPE, entityToInvoicingSubscriptionFormLocalData, initialInvoicingSubscriptionFormLocalData, invoicingSubscriptionTodayIso, toInvoicingSubscriptionQuantity, } from './view/invoicing/editInvoicingSubscriptionDetailView/invoicingSubscriptionFormConfig';
+export { INVOICING_SUBSCRIPTION_SHIPPING_ADDRESS_TYPE, entityToInvoicingSubscriptionFormLocalData, initialInvoicingSubscriptionFormLocalData, invoicingSubscriptionTodayIso, toInvoicingSubscriptionQuantity, } from './view/invoicing/editInvoicingSubscriptionDetailView/invoicingSubscriptionFormConfig';
 export { getEditInvoicingSubscriptionDetailViewState, getInvoicingSubscriptionFormView, } from './view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewSelector';
 export type { EditInvoicingSubscriptionDetailView, InvoicingSubscriptionFormView, } from './view/invoicing/editInvoicingSubscriptionDetailView/editInvoicingSubscriptionDetailViewSelector';
 export { archiveInvoicingCatalogSubFamily, createInvoicingCatalogSubFamily, resetEditInvoicingCatalogItemDetailView, saveInvoicingCatalogItem, submitInvoicingCatalogItemForm, updateInvoicingCatalogItemFormDraft, } from './view/invoicing/editInvoicingCatalogItemDetailView/editInvoicingCatalogItemDetailViewReducer';
@@ -1245,7 +1245,7 @@ export { getInvoicingQboView } from './view/invoicing/invoicingQboView/invoicing
 export type { InvoicingQboView } from './view/invoicing/invoicingQboView/invoicingQboViewSelector';
 export type { InvoicingQboAccountOption, InvoicingQboConnection, InvoicingQboFailedTask, InvoicingQboSyncHealth, } from './view/invoicing/invoicingQboView/invoicingQboViewPayload';
 export { INVOICING_QBO_CUSTOMER_MATCHING_MODES, getInvoicingQboAccountMappingId, toInvoicingNamedOptionsByKey, toInvoicingQboCustomerMatchingMode, withInvoicingQboAccountMappingId, } from './entity/invoicing/invoicingCommonPayload';
-export type { InvoicingNamedOption, InvoicingNamedOptionsByKey, InvoicingQboAccountMappingKindOption, InvoicingQboAccountMappingsPayload, InvoicingQboCustomerMatchingMode, InvoicingQboSettingsPayload, } from './entity/invoicing/invoicingCommonPayload';
+export type { InvoicingNamedOption, InvoicingFieldHelp, InvoicingFieldHelpByCode, InvoicingFieldHelpGroup, InvoicingNamedOptionsByKey, InvoicingQboAccountMappingKindOption, InvoicingQboAccountMappingsPayload, InvoicingQboCustomerMatchingMode, InvoicingQboSettingsPayload, } from './entity/invoicing/invoicingCommonPayload';
 export { acceptInvoicingTerms, enableInvoicing, fetchInvoicingConfig, resetInvoicingConfigActionStates, updateInvoicingConfig, } from './view/invoicing/invoicingConfigView/invoicingConfigViewReducer';
 export { getInvoicingConfigView } from './view/invoicing/invoicingConfigView/invoicingConfigViewSelector';
 export { getInvoicingOnboardingGateView } from './view/invoicing/invoicingConfigView/invoicingConfigViewSelector';