Skip to content

feat: add three report custom columns to expense tables#90937

Open
KJ21-ENG wants to merge 8 commits into
Expensify:mainfrom
KJ21-ENG:KJ21-ENG/90508-three-custom-columns
Open

feat: add three report custom columns to expense tables#90937
KJ21-ENG wants to merge 8 commits into
Expensify:mainfrom
KJ21-ENG:KJ21-ENG/90508-three-custom-columns

Conversation

@KJ21-ENG

@KJ21-ENG KJ21-ENG commented May 18, 2026

Copy link
Copy Markdown
Contributor

Explanation of Change

Adds Custom Field 1, Custom Field 2, and International reimbursement IDs as configurable report custom columns for expense search, expense report search, and report details tables.

The new columns render from the report fields named in the issue only: report.submitterUserID, report.submitterPayrollID, and report.orderDealNumbers. No policy.employeeList fallback is used.

Fixed Issues

$ #90508
PROPOSAL: #90508 (comment)

Tests

  1. Open the app on Web with a wide layout.
  2. Go to Search and open an expense table view.
  3. Open Display > Edit columns.
  4. Verify Custom Field 1, Custom Field 2, and International reimbursement IDs are available.
  5. Select the three columns and save.
  6. Verify the selected columns appear in the table and display report values when present.
  7. Verify International reimbursement IDs render the provided report value when present.
  8. Repeat the picker/render check for expense report results.
  9. Open an actual expense report in wide layout and open the report details Columns picker.
  10. Verify the same three columns are available there and render in the report details table when selected.
  11. Verify that no errors appear in the JS console.
  • Verify that no errors appear in the JS console

Offline tests

N/A. This PR only adds display/sort support for existing report fields and does not add a new network write path.

QA Steps

Same as Tests.

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android: Native
    • Android: mWeb Chrome
    • iOS: Native
    • iOS: mWeb Safari
    • MacOS: Chrome / Safari
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I used JaimeGPT to get English > Spanish translation. I then posted it in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.ts or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG))
  • If new assets were added or existing ones were modified, I verified that:
    • The assets are optimized and compressed (for SVG files, run npm run compress-svg)
    • The assets load correctly across all supported platforms.
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
    • I verified that all the inputs inside a form are aligned with each other.
    • I added Design label and/or tagged @Expensify/design so the design team can review the changes.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • I added unit tests for any new feature or bug fix in this PR to help automatically prevent regressions in this user flow.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.

Screenshots/Videos

Android: Native

Native uses narrow layout and the column picker is intentionally not exposed there.

Android: mWeb Chrome

mWeb uses narrow layout and the column picker is intentionally not exposed there.

iOS: Native

Native uses narrow layout and the column picker is intentionally not exposed there.

iOS: mWeb Safari

mWeb uses narrow layout and the column picker is intentionally not exposed there.

MacOS: Chrome / Safari
ezyZip.35.mp4

@melvin-bot

melvin-bot Bot commented May 18, 2026

Copy link
Copy Markdown

Hey, I noticed you changed src/languages/en.ts in a PR from a fork. For security reasons, translations are not generated automatically for PRs from forks.

If you want to automatically generate translations for other locales, an Expensify employee will have to:

  1. Look at the code and make sure there are no malicious changes.
  2. Run the Generate static translations GitHub workflow. If you have write access and the K2 extension, you can simply click: [this button]

Alternatively, if you are an external contributor, you can run the translation script locally with your own OpenAI API key. To learn more, try running:

npx ts-node ./scripts/generateTranslations.ts --help

Typically, you'd want to translate only what you changed by running npx ts-node ./scripts/generateTranslations.ts --compare-ref main

@codecov

codecov Bot commented May 18, 2026

Copy link
Copy Markdown

Codecov Report

✅ Changes either increased or maintained existing code coverage, great job!

Files with missing lines Coverage Δ
src/CONST/index.ts 93.84% <ø> (ø)
src/components/Search/SearchTableHeader.tsx 50.57% <ø> (ø)
...ents/TransactionItemRow/TransactionItemRowWide.tsx 96.46% <100.00%> (+0.23%) ⬆️
src/libs/DebugUtils.ts 68.63% <100.00%> (+0.19%) ⬆️
...pages/settings/Report/ReportDetailsColumnsPage.tsx 0.00% <ø> (ø)
src/selectors/Report.ts 61.22% <ø> (ø)
src/styles/utils/index.ts 52.94% <100.00%> (+0.17%) ⬆️
src/types/utils/whitelistedReportKeys.ts 100.00% <ø> (ø)
...stReportView/MoneyRequestReportTransactionList.tsx 0.58% <0.00%> (+0.02%) ⬆️
src/libs/actions/Search.ts 35.25% <71.42%> (+0.39%) ⬆️
... and 3 more
... and 35 files with indirect coverage changes

@KJ21-ENG KJ21-ENG force-pushed the KJ21-ENG/90508-three-custom-columns branch from 8c290e3 to 228c41b Compare May 18, 2026 09:18
@KJ21-ENG KJ21-ENG marked this pull request as ready for review May 18, 2026 11:38
@KJ21-ENG KJ21-ENG requested review from a team as code owners May 18, 2026 11:38
@melvin-bot melvin-bot Bot requested review from flaviadefaria and shubham1206agra and removed request for a team May 18, 2026 11:38
@melvin-bot

melvin-bot Bot commented May 18, 2026

Copy link
Copy Markdown

@shubham1206agra Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

Comment thread src/components/TransactionItemRow/TransactionItemRowWide.tsx Outdated
Comment thread src/libs/SearchUIUtils.ts Outdated
Comment thread src/types/onyx/Report.ts Outdated
@flaviadefaria

Copy link
Copy Markdown
Contributor

Verify Custom Field 1, Custom Field 2, and International reimbursement IDs are available.

My understanding is that we were adding all the missing columns from this template and not only the referenced ones:

Reference: Web-Expensify/lib/Integrations/defaultExportTemplates/detailed_export.ftl (expensify_detailed_export.txt) for context on available columns.

@twisterdotcom am I right or did I misunderstand the issue's OP?

@flaviadefaria

Copy link
Copy Markdown
Contributor

Oh, ignore me. Now that I saw the issue title, I see I misunderstood it!

flaviadefaria
flaviadefaria previously approved these changes May 18, 2026

@flaviadefaria flaviadefaria left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From a product standpoint, the fix looks good to me.

@KJ21-ENG KJ21-ENG force-pushed the KJ21-ENG/90508-three-custom-columns branch from 228c41b to 2494d03 Compare May 18, 2026 14:45
…e-custom-columns

# Conflicts:
#	src/libs/SearchUIUtils.ts
@twisterdotcom

Copy link
Copy Markdown
Contributor

Let me try asking Melvin this first before I bring in Franc/Carlos. @MelvinBot How does the IS allow freemarker to print report.submitterPayrollID when submitterPayrollID isn't natively stored in the report object?

@MelvinBot

Copy link
Copy Markdown
Contributor

submitterPayrollID is not a native report field — it's "Custom Field 2" from the workspace's People/Members list, stored as employeePayrollID on the PolicyEmployee record. The IS denormalizes it onto the report object when building the FreeMarker data model for export: it looks up the report submitter in the policy's employee list and copies their employeePayrollID value onto the report hash as submitterPayrollID, so ${report.submitterPayrollID} resolves in templates.

The same data is also accessible via the formula system as {report:submit:from:customfield2} or {report:submit:from:payrollid}, which resolves at runtime by looking up the submitter's email in policy.employeeList and reading employeePayrollID.

Supporting code references
  • Field mapping: CUSTOM_FIELD_KEYS: {customField1: 'employeeUserID', customField2: 'employeePayrollID'} in src/CONST/index.ts
  • Source of truth: employeePayrollID is defined on PolicyEmployee (src/types/onyx/PolicyEmployee.ts:14-16) — set per workspace member via People/Members settings
  • Denormalized copy: submitterPayrollID appears on the Report type (src/types/onyx/Report.ts:104-105) as "Custom field 2 value for the report submitter"
  • Formula resolution: src/libs/Formula.ts:934-944 — the payrollid/customfield2 case looks up policy.employeeList[email]?.employeePayrollID

@KJ21-ENG

Copy link
Copy Markdown
Contributor Author

@shubham1206agra Kind ping here. Thanks

1 similar comment
@KJ21-ENG

Copy link
Copy Markdown
Contributor Author

@shubham1206agra Kind ping here. Thanks

@shubham1206agra

Copy link
Copy Markdown
Contributor

@twisterdotcom needs to pull an engineer here to get the fields working.

@KJ21-ENG The table should hide the columns if the value is missing for all rows. Please work on that

KJ21-ENG added 2 commits May 26, 2026 15:15
…e-custom-columns

# Conflicts:
#	src/libs/SearchUIUtils.ts
…e-custom-columns

# Conflicts:
#	src/libs/SearchUIUtils.ts
@KJ21-ENG

Copy link
Copy Markdown
Contributor Author

@twisterdotcom Kind Ping Here. Thanks.

@KJ21-ENG

Copy link
Copy Markdown
Contributor Author

@twisterdotcom needs to pull an engineer here to get the fields working.

@twisterdotcom Kind Ping Here. Thanks.

@roryabraham

Copy link
Copy Markdown
Contributor

/codex review

@twisterdotcom

Copy link
Copy Markdown
Contributor

Hello, sorry for the delay. What do we need me for here? We need to do some backend work to make the custom field 2 value available?

@KJ21-ENG

Copy link
Copy Markdown
Contributor Author

@twisterdotcom Yes, exactly.

@twisterdotcom

Copy link
Copy Markdown
Contributor

Posting in the Backend Contributor channel now: https://expensify.slack.com/archives/C086VHWPPUM/p1780050090461409

@KJ21-ENG

KJ21-ENG commented Jun 1, 2026

Copy link
Copy Markdown
Contributor Author

Posting in the Backend Contributor channel now: https://expensify.slack.com/archives/C086VHWPPUM/p1780050090461409

@twisterdotcom Did we get any response here?

@twisterdotcom

Copy link
Copy Markdown
Contributor

@KioCoan KioCoan self-assigned this Jun 2, 2026
@KJ21-ENG

KJ21-ENG commented Jun 2, 2026

Copy link
Copy Markdown
Contributor Author

@twisterdotcom Thanks!

@KJ21-ENG

KJ21-ENG commented Jun 3, 2026

Copy link
Copy Markdown
Contributor Author

@KioCoan Any update on this ? Thanks!

@KioCoan

KioCoan commented Jun 3, 2026

Copy link
Copy Markdown
Contributor

@KJ21-ENG working on it. Should have a BE PR soon.

@KJ21-ENG

KJ21-ENG commented Jun 3, 2026

Copy link
Copy Markdown
Contributor Author

@KioCoan Ping me once done so I can test FE chanegs. Thanks!

@KJ21-ENG

KJ21-ENG commented Jun 5, 2026

Copy link
Copy Markdown
Contributor Author

@KJ21-ENG working on it. Should have a BE PR soon.

@KioCoan Any update on this ? Thanks!

@KioCoan

KioCoan commented Jun 5, 2026

Copy link
Copy Markdown
Contributor

@KJ21-ENG a few people are OOO this week, so the auto assigned reviewer change a couple times.

I requested the timing for the updated queries and we should be progressing soon.

@KJ21-ENG

KJ21-ENG commented Jun 5, 2026

Copy link
Copy Markdown
Contributor Author

@KJ21-ENG a few people are OOO this week, so the auto assigned reviewer change a couple times.

I requested the timing for the updated queries and we should be progressing soon.

@KioCoan Okay, No problem. Thanks!

@KJ21-ENG

Copy link
Copy Markdown
Contributor Author

@KioCoan Any update on this ? Thanks!

@KioCoan

KioCoan commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

I was able to get the updated queries timings, just waiting for the final review.

@KJ21-ENG

Copy link
Copy Markdown
Contributor Author

I was able to get the updated queries timings, just waiting for the final review.

Oh Great, Thanks!

@KioCoan

KioCoan commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

BE PR merged, it will be available in the next staging deploy.

@KioCoan

KioCoan commented Jun 12, 2026

Copy link
Copy Markdown
Contributor

@KJ21-ENG BE changes are deployed. You should be good to go.

@KJ21-ENG

Copy link
Copy Markdown
Contributor Author

@KJ21-ENG BE changes are deployed. You should be good to go.

Oh great, I will wrap up the rest of the things on my side and let @shubham1206agra know.

@shubham1206agra

Copy link
Copy Markdown
Contributor

@KJ21-ENG Conflicts

@KJ21-ENG

Copy link
Copy Markdown
Contributor Author

@KJ21-ENG Conflicts

Yes, I will resolve them

KJ21-ENG added 3 commits June 12, 2026 15:04
…e-custom-columns

# Conflicts:
#	src/components/MoneyRequestReportView/MoneyRequestReportTransactionList.tsx
#	src/libs/ReportUtils.ts
#	src/libs/SearchUIUtils.ts
@KJ21-ENG

Copy link
Copy Markdown
Contributor Author

@shubham1206agra Kind ping here. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants