Skip to content

[No QA] Add Playroll integration help page#90394

Draft
MelvinBot wants to merge 2 commits into
mainfrom
claude-addPlayrollHelpPage
Draft

[No QA] Add Playroll integration help page#90394
MelvinBot wants to merge 2 commits into
mainfrom
claude-addPlayrollHelpPage

Conversation

@MelvinBot
Copy link
Copy Markdown
Contributor

Explanation of Change

Adds a new help page for the Playroll HR/EOR integration under Expensify Classic connections. The page documents the full setup process including prerequisites, enabling Public Receipt Visibility, setting Receipt Required Amount to $0, connecting via Partner credentials in Playroll, and mapping expense categories. This is a one-way integration (Expensify → Playroll) for syncing approved expenses.

Fixed Issues

$ https://github.com/Expensify/Expensify/issues/636336

Tests

// TODO: The human co-author must fill out the tests you ran before marking this PR as "ready for review"
// Please describe what tests you performed that validates your changed worked.

  • Verify that no errors appear in the JS console

Offline tests

N/A — docs-only change

QA Steps

// TODO: The human co-author must fill out the QA tests you ran before marking this PR as "ready for review".
// Please describe what QA needs to do to validate your changes and what areas do they need to test for regressions.

  • 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

N/A — docs-only change

Android: mWeb Chrome

N/A — docs-only change

iOS: Native

N/A — docs-only change

iOS: mWeb Safari

N/A — docs-only change

MacOS: Chrome / Safari

N/A — docs-only change

New help page documenting the setup process for the Playroll
HR/EOR expense sync integration with Expensify Classic.

Co-authored-by: Nick Tooker <NickTooker@users.noreply.github.com>
@MelvinBot MelvinBot requested a review from a team May 13, 2026 00:35
@NickTooker
Copy link
Copy Markdown

How TO: Expensify → Playroll Expense Integration Setup
Purpose:
 This integration allows approved expenses in Expensify to automatically sync into Playroll for processing.
Important:

This is a one-way integration (Expensify → Playroll only)
Changes made after syncing will not sync back
Only approved expenses sync
Expenses without receipts will not sync
Prerequisites:

User must be a Workspace Admin or Workspace Owner in Expensify
User must have Playroll integration permissions
User must be logged into the same Expensify account that owns/administers the workspace
User must be able to access Expensify Classic
Setup Steps:

  1. Switch to Expensify Classic

Log into Expensify
Click account logo
Select “Troubleshoot”
Click “Switch to Expensify Classic”
2. Enable Public Receipt Visibility

Go to Settings → Workspaces
Select the workspace
Go to Rules
Enable “Public Receipt Visibility”
Important:
 If this is not enabled, expenses will not sync to Playroll.
3. Set Receipt Required Amount to 0

In Rules section
Locate “Receipt Required Amount”
Set value to 0
Save changes
Reason:
 Expenses without receipts do not sync to Playroll.
4. Confirm Workspace Permissions
 The user configuring the integration must be:

Workspace Admin OR
Workspace Owner
5. Connect Expensify to Playroll
 In Playroll:

Go to Dashboard
Click Tools → Integrations
Select Expensify
Open Configuration tab
Click Connect
You will need:

Partner User ID
Partner User Secret
To get credentials:

While logged into Expensify, click “Find our Partner ID”
Copy Partner User ID and Partner User Secret
Paste into Playroll
Click Submit
Successful setup will show:
 “Active / Connected”
6. Map Expense Categories

Open Expensify integration page
Go to Expense Categories
Click “Map Categories”
Match Expensify categories to Playroll categories
Save mappings
Examples:

Expensify “Car” → Playroll “Car Rental”
Expensify “Equipment” → Playroll “Equipment”
Important:
 Employee email addresses in Expensify must match Personal Emails in Playroll.
Completion Checklist:

Public Receipt Visibility enabled
Receipt Required Amount set to 0
Correct workspace permissions confirmed
Expensify connected to Playroll
Expense categories mapped and saved

Co-authored-by: Nick Tooker <NickTooker@users.noreply.github.com>
@MelvinBot
Copy link
Copy Markdown
Contributor Author

Fixed the failing spellcheck: added "Playroll" to the cspell dictionary (cspell.json).

@github-actions github-actions Bot changed the title Add Playroll integration help page [No QA] Add Playroll integration help page May 13, 2026
@OSBotify
Copy link
Copy Markdown
Contributor

OSBotify commented May 13, 2026

A preview of your ExpensifyHelp changes have been deployed to https://936bbd0f.helpdot.pages.dev ⚡️

Updated articles:

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.

3 participants