Skip to main content

Uploading and Managing the Eligibility File

Updated

 

📄 What is the Eligibility File?

The **Eligibility File** ensures that only approved employees can donate via payroll. It acts as a secure gatekeeper to prevent ineligible users from accessing payroll giving. Best practice is to automate the upload via **SFTP (Secure File Transfer Protocol)**. However, you can also upload the file manually via CSV. ---

⚙️ Automating Uploads via SFTP

To configure automated uploads:

  1. Go to Settings > Eligibility File
  2. Enter your company’s SFTP configuration details
  3. If needed, contact support@goodcompany.org for assistance

---

📤 Manual Upload

To manually upload your file:

  1. Prepare your .csv file (see format below)
  2. Click the Choose File button
  3. Ensure the correct mapping is selected
  4. Click Upload

---

📌 Mandatory Columns

The Eligibility File **must** include the following headers:

  • EmployeeID
  • FirstName
  • LastName
  • Email
  • BusinessUnitId
  • PayCycleId
  • OfficeStateCode

These fields are case-sensitive and required. ---

🔄 Field Mapping

We offer a simple mapping tool to align your internal data fields with our required ones. Your current mappings might look like this:

GoodCompany Field Your Field
EmployeeId EmployeeId
Email Email
FirstName FirstName
LastName LastName
BusinessUnitId BusinessUnit
OfficeStateCode State
PayCycleId PaycycleId

To update your mapping, go to Settings Eligibility File. ---

❗ Important Rules & Validation

  • ✔ File must be .csv format
  • ✔ OfficeStateCode must use abbreviations (e.g. VIC not Victoria)
  • ✔ No blank rows, columns, or cells. Use unknown (no quotes) where data is unavailable
  • ✔ EmployeeId must be a unique, immutable identifier
  • ✔ PayCycleId must match your company’s payroll setup. If not using payroll, use unknown
  • ✔ All values must match the equivalent values in SSO claims exactly
  • ✔ Submit a separate file for each country. For example:
    • Eligibility_AU.csv for Australia
    • Eligibility_NZ.csv for New Zealand
  • ✔ Eligibility is based on country of salary, not location

---

📬 Need Help?

If you need help with SFTP setup, file formatting, or mapping, contact us at [support@goodcompany.org](mailto:support@goodcompany.org). We’re happy to guide you through the process.