Skip to content

:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.

feat(warehouse-sources): add rippling variable compensation payouts table (#119528)

Tom Owers6c4775b19b00
diff --git a/products/warehouse_sources/backend/temporal/data_imports/sources/COVERAGE_GAPS_APPENDIX.md b/products/warehouse_sources/backend/temporal/data_imports/sources/COVERAGE_GAPS_APPENDIX.md
index 8c31b94b3a56..3d1b5d8c204e 100644
--- a/products/warehouse_sources/backend/temporal/data_imports/sources/COVERAGE_GAPS_APPENDIX.md
+++ b/products/warehouse_sources/backend/temporal/data_imports/sources/COVERAGE_GAPS_APPENDIX.md
@@ -10277,6 +10277,7 @@ Diffed against: <https://developer.rippling.com/sitemap.xml>
- [ ] `list-legal-entities and list-company-legal-entities` — lookup resolving the legal entity on workers and payroll, required for multi-entity reporting (medium)
- [ ] `list-job-codes and list-job-assignments` — lookup resolving the job code stamped on time entries and shift assignments (medium)
- [ ] `list-time-cards` — approved timesheet totals per period, the aggregate view of time entries (medium)
+- [x] `list-variable-compensation-payouts` — per-worker variable compensation payouts (bonuses, commissions, one-off pay) with status and scheduled dates (medium)
Note: Rippling exposes three distinct API surfaces (base-api, company-api, rest-api). The PostHog tables match the modern rest-api (Rippling Platform API), so the diff was taken against the ~230 rest-api reference pages in the sitemap; the base-api/company-api surfaces are older equivalents and were not counted as gaps.
diff --git a/products/warehouse_sources/backend/temporal/data_imports/sources/rippling/canonical_descriptions.py b/products/warehouse_sources/backend/temporal/data_imports/sources/rippling/canonical_descriptions.py
index f6d66252a128..b586d35f753e 100644
--- a/products/warehouse_sources/backend/temporal/data_imports/sources/rippling/canonical_descriptions.py
+++ b/products/warehouse_sources/backend/temporal/data_imports/sources/rippling/canonical_descriptions.py
@@ -127,6 +127,28 @@ CANONICAL_DESCRIPTIONS: CanonicalDescriptions = {
effective_date="Date the compensation took effect.",
),
},
+ "variable_compensation_payouts": {
+ "description": "A variable compensation payout (bonus, commission or other one-off pay) scheduled for a worker.",
+ "docs_url": "https://developer.rippling.com/documentation/rest-api/reference/list-variable-compensation-payouts",
+ "columns": _columns(
+ payee_id="ID of the worker who receives the payout.",
+ client="Client system that created the payout (e.g. VC_PLAN_CYCLE, MANUAL_PAYOUT).",
+ external_id="External identifier, unique per company and client.",
+ currency_type="Three-letter currency code of the payout.",
+ value="Payout amount as a decimal string.",
+ pay_classification="Payroll earning code resolved from the payout type.",
+ payout_type="Key of the company payout type used for the payout.",
+ scheduled_date="Date the payout is scheduled for.",
+ effective_start_date="Start date of the covered pay period.",
+ effective_end_date="End date of the covered pay period.",
+ description="Optional payout description.",
+ status="Current payout status (e.g. SCHEDULED, PAID, CANCELLED).",
+ cancel_reason="Reason given when the payout was cancelled.",
+ source_label_id="ID of the source label attached to the payout.",
+ group_label_id="ID of the group label attached to the payout.",
+ paystub_id="ID of the paystub once the payout has synced to payroll.",
+ ),
+ },
"time_entries": {
"description": "A time entry recording when a worker clocked in and out, with breaks, shifts and pay segments.",
"docs_url": "https://developer.rippling.com/documentation/rest-api/reference/list-time-entries",
diff --git a/products/warehouse_sources/backend/temporal/data_imports/sources/rippling/settings.py b/products/warehouse_sources/backend/temporal/data_imports/sources/rippling/settings.py
index 65d32b592b6b..79ee5542218b 100644
--- a/products/warehouse_sources/backend/temporal/data_imports/sources/rippling/settings.py
+++ b/products/warehouse_sources/backend/temporal/data_imports/sources/rippling/settings.py
@@ -92,6 +92,14 @@ RIPPLING_ENDPOINTS: dict[str, RipplingEndpointConfig] = {
path="/compensations",
partition_key="created_at",
),
+ # Variable compensation payouts accept no OData filter and no order_by, so full refresh only.
+ "variable_compensation_payouts": RipplingEndpointConfig(
+ name="variable_compensation_payouts",
+ path="/variable-compensation-payouts",
+ incremental_fields=[],
+ partition_key="created_at",
+ order_by=None,
+ ),
# Time entries filter on updated_at but not on created_at.
"time_entries": RipplingEndpointConfig(
name="time_entries",
diff --git a/products/warehouse_sources/backend/temporal/data_imports/sources/rippling/tests/test_rippling.py b/products/warehouse_sources/backend/temporal/data_imports/sources/rippling/tests/test_rippling.py
index e831415edbbc..b8f5cfadb57c 100644
--- a/products/warehouse_sources/backend/temporal/data_imports/sources/rippling/tests/test_rippling.py
+++ b/products/warehouse_sources/backend/temporal/data_imports/sources/rippling/tests/test_rippling.py
@@ -60,6 +60,9 @@ class TestBuildParams:
("leave_requests", True, "updated_at", None, "created_at"),
("payroll_runs", True, None, None, "check_date"),
("payroll_runs", False, None, None, "check_date"),
+ # The payouts list rejects OData filters and accepts no order_by.
+ ("variable_compensation_payouts", True, "updated_at", None, None),
+ ("variable_compensation_payouts", False, None, None, None),
],
)
def test_request_params(
@@ -73,7 +76,7 @@ class TestBuildParams:
)
assert params.get("filter") == expected_filter
- assert params["order_by"] == expected_order_by
+ assert params.get("order_by") == expected_order_by
assert params["limit"] == PAGE_SIZE