Rippling: contract 2026-10-28
What changed after Rippling contract 2026-10-28, and the packages that pin it.
Contract 2026-10-28 is a retired Rippling contract. Alter still runs it for installed SDKs, the current SDK’s kept methods and pending approvals that pin it. Its full operation reference is not published: the API reference documents the current contract, 2026-11-07. See all contracts.
Packages
Section titled “Packages”The last release that pins this contract is version 0.4.3: @alter-ai/rippling 0.4.3 on npm and alter-sdk-rippling 0.4.3 on PyPI. Each package page documents that release.
Specifications
Section titled “Specifications”The provider’s native API description of this contract, as Alter published it: rippling.base-api.2026-10-28.openapi.json, rippling.company-api.2026-10-28.openapi.json, rippling.developer-portal.2026-10-28.openapi.json, rippling.employee-api.2026-10-28.openapi.json, rippling.global-payroll-api.2026-10-28.openapi.json, rippling.job-board-api-v2.2026-10-28.openapi.json, rippling.payroll-api.2026-10-28.openapi.json, rippling.recruiting-api.2026-10-28.openapi.json, rippling.reports-api.2026-10-28.openapi.json, rippling.rest-api.2026-10-28.openapi.json, rippling.t-and-a-api.2026-10-28.openapi.json, rippling.v1-archive-api.2026-10-28.openapi.json.
Methods the current SDK keeps
Section titled “Methods the current SDK keeps”The current packages keep 6 deprecated methods whose operations a later contract dropped. Each still calls this contract, so code written against an earlier package keeps working after an upgrade; the API reference documents each one, marked deprecated.
| Operation | TypeScript | Python |
|---|---|---|
rippling.rest_api.get_bill_payments | restApi.getBillPayments | rest_api.get_bill_payments |
rippling.rest_api.get_spend_categories | restApi.getSpendCategories | rest_api.get_spend_categories |
rippling.rest_api.get_spend_vendors | restApi.getSpendVendors | rest_api.get_spend_vendors |
rippling.rest_api.list_bill_payments | restApi.listBillPayments | rest_api.list_bill_payments |
rippling.rest_api.list_spend_categories | restApi.listSpendCategories | rest_api.list_spend_categories |
rippling.rest_api.list_spend_vendors | restApi.listSpendVendors | rest_api.list_spend_vendors |
Changes in contract 2026-11-07
Section titled “Changes in contract 2026-11-07”This contract has 480 operations. Contract 2026-11-07 added 17, removed 6 and changed 44.
Operation links open the current contract’s reference (2026-11-07).
| Operation | TypeScript | Python |
|---|---|---|
| rippling.rest_api.capabilities_custom_object_list_view | restApi.capabilitiesCustomObjectListView | rest_api.capabilities_custom_object_list_view |
| rippling.rest_api.create_custom_object_list_view | restApi.createCustomObjectListView | rest_api.create_custom_object_list_view |
| rippling.rest_api.create_package_version_from_manifest | restApi.createPackageVersionFromManifest | rest_api.create_package_version_from_manifest |
| rippling.rest_api.default_custom_object_list_view | restApi.defaultCustomObjectListView | rest_api.default_custom_object_list_view |
| rippling.rest_api.delete_functions | restApi.deleteFunctions | rest_api.delete_functions |
| rippling.rest_api.destroy_custom_object_list_view | restApi.destroyCustomObjectListView | rest_api.destroy_custom_object_list_view |
| rippling.rest_api.extract_package_components | restApi.extractPackageComponents | rest_api.extract_package_components |
| rippling.rest_api.get_bills | restApi.getBills | rest_api.get_bills |
| rippling.rest_api.get_finance_categories | restApi.getFinanceCategories | rest_api.get_finance_categories |
| rippling.rest_api.get_finance_vendors | restApi.getFinanceVendors | rest_api.get_finance_vendors |
| rippling.rest_api.get_package_version_manifest | restApi.getPackageVersionManifest | rest_api.get_package_version_manifest |
| rippling.rest_api.list_bills | restApi.listBills | rest_api.list_bills |
| rippling.rest_api.list_finance_categories | restApi.listFinanceCategories | rest_api.list_finance_categories |
| rippling.rest_api.list_finance_vendors | restApi.listFinanceVendors | rest_api.list_finance_vendors |
| rippling.rest_api.list_package_component_types | restApi.listPackageComponentTypes | rest_api.list_package_component_types |
| rippling.rest_api.list_package_components | restApi.listPackageComponents | rest_api.list_package_components |
| rippling.rest_api.partial_update_custom_object_list_view | restApi.partialUpdateCustomObjectListView | rest_api.partial_update_custom_object_list_view |
Removed
Section titled “Removed”| Operation | TypeScript | Python |
|---|---|---|
| rippling.rest_api.get_bill_payments | restApi.getBillPayments | rest_api.get_bill_payments |
| rippling.rest_api.get_spend_categories | restApi.getSpendCategories | rest_api.get_spend_categories |
| rippling.rest_api.get_spend_vendors | restApi.getSpendVendors | rest_api.get_spend_vendors |
| rippling.rest_api.list_bill_payments | restApi.listBillPayments | rest_api.list_bill_payments |
| rippling.rest_api.list_spend_categories | restApi.listSpendCategories | rest_api.list_spend_categories |
| rippling.rest_api.list_spend_vendors | restApi.listSpendVendors | rest_api.list_spend_vendors |
Changed
Section titled “Changed”| Operation | TypeScript | Python | What changed |
|---|---|---|---|
| rippling.rest_api.append_agent_session_message | restApi.appendAgentSessionMessage | rest_api.append_agent_session_message | response |
| rippling.rest_api.create_agent_session | restApi.createAgentSession | rest_api.create_agent_session | response |
| rippling.rest_api.create_draft_transitions | restApi.createDraftTransitions | rest_api.create_draft_transitions | request, response |
| rippling.rest_api.create_employee_documents | restApi.createEmployeeDocuments | rest_api.create_employee_documents | request, response |
| rippling.rest_api.create_functions | restApi.createFunctions | rest_api.create_functions | request, response |
| rippling.rest_api.create_hires | restApi.createHires | rest_api.create_hires | request |
| rippling.rest_api.create_next_package_versions | restApi.createNextPackageVersions | rest_api.create_next_package_versions | response |
| rippling.rest_api.create_package_versions | restApi.createPackageVersions | rest_api.create_package_versions | response |
| rippling.rest_api.create_sandboxes | restApi.createSandboxes | rest_api.create_sandboxes | request, response |
| rippling.rest_api.create_sites | restApi.createSites | rest_api.create_sites | provider entitlements |
| rippling.rest_api.delete_sites | restApi.deleteSites | rest_api.delete_sites | provider entitlements |
| rippling.rest_api.file_operations_sites | restApi.fileOperationsSites | rest_api.file_operations_sites | provider entitlements |
| rippling.rest_api.files_sites | restApi.filesSites | rest_api.files_sites | provider entitlements |
| rippling.rest_api.get_activity_log | restApi.getActivityLog | rest_api.get_activity_log | provider entitlements |
| rippling.rest_api.get_agent_session | restApi.getAgentSession | rest_api.get_agent_session | response |
| rippling.rest_api.get_card_transactions | restApi.getCardTransactions | rest_api.get_card_transactions | provider entitlements, request, response |
| rippling.rest_api.get_custom_object_list_view | restApi.getCustomObjectListView | rest_api.get_custom_object_list_view | endpoint, request, response |
| rippling.rest_api.get_devices | restApi.getDevices | rest_api.get_devices | response |
| rippling.rest_api.get_draft_transitions | restApi.getDraftTransitions | rest_api.get_draft_transitions | response |
| rippling.rest_api.get_functions | restApi.getFunctions | rest_api.get_functions | response |
| rippling.rest_api.get_package_installs | restApi.getPackageInstalls | rest_api.get_package_installs | response |
| rippling.rest_api.get_package_managed_installs | restApi.getPackageManagedInstalls | rest_api.get_package_managed_installs | response |
| rippling.rest_api.get_package_versions | restApi.getPackageVersions | rest_api.get_package_versions | response |
| rippling.rest_api.get_reimbursements | restApi.getReimbursements | rest_api.get_reimbursements | provider entitlements, request, response |
| rippling.rest_api.get_sandboxes | restApi.getSandboxes | rest_api.get_sandboxes | response |
| rippling.rest_api.get_sites | restApi.getSites | rest_api.get_sites | provider entitlements |
| rippling.rest_api.install_package_installs | restApi.installPackageInstalls | rest_api.install_package_installs | request, response |
| rippling.rest_api.install_package_managed_installs | restApi.installPackageManagedInstalls | rest_api.install_package_managed_installs | request, response |
| rippling.rest_api.list_activity_log | restApi.listActivityLog | rest_api.list_activity_log | provider entitlements |
| rippling.rest_api.list_agent_sessions | restApi.listAgentSessions | rest_api.list_agent_sessions | response |
| rippling.rest_api.list_by_query_custom_objects_custom_object_api_name_records | restApi.listByQueryCustomObjectsCustomObjectApiNameRecords | rest_api.list_by_query_custom_objects_custom_object_api_name_records | request |
| rippling.rest_api.list_card_transactions | restApi.listCardTransactions | rest_api.list_card_transactions | provider entitlements, request, response |
| rippling.rest_api.list_custom_object_list_views | restApi.listCustomObjectListViews | rest_api.list_custom_object_list_views | response |
| rippling.rest_api.list_devices | restApi.listDevices | rest_api.list_devices | response |
| rippling.rest_api.list_functions | restApi.listFunctions | rest_api.list_functions | response |
| rippling.rest_api.list_package_versions | restApi.listPackageVersions | rest_api.list_package_versions | response |
| rippling.rest_api.list_reimbursements | restApi.listReimbursements | rest_api.list_reimbursements | provider entitlements, request, response |
| rippling.rest_api.list_sandboxes | restApi.listSandboxes | rest_api.list_sandboxes | response |
| rippling.rest_api.list_sites | restApi.listSites | rest_api.list_sites | provider entitlements |
| rippling.rest_api.publish_package_versions | restApi.publishPackageVersions | rest_api.publish_package_versions | response |
| rippling.rest_api.update_functions | restApi.updateFunctions | rest_api.update_functions | request, response |
| rippling.rest_api.update_package_versions | restApi.updatePackageVersions | rest_api.update_package_versions | request, response |
| rippling.rest_api.update_sites | restApi.updateSites | rest_api.update_sites | provider entitlements |
| rippling.rest_api.upload_batches_presign_sites | restApi.uploadBatchesPresignSites | rest_api.upload_batches_presign_sites | provider entitlements |
Breaking changes in the 2026-11-07 packages
Section titled “Breaking changes in the 2026-11-07 packages”Rippling changed these operations upstream, and the current packages follow the provider: code written against the 0.4.3 packages may need a change on upgrading. Each was reviewed when the contract was adopted.
| Python method | Kind | What changed | Why |
|---|---|---|---|
rest_api.create_draft_transitions | Input | body.items[].changes.employment_info.annual_salary_equivalent: type number -> objectbody.items[].changes.employment_info.equity_value: type number -> objectbody.items[].changes.employment_info.on_target_commission: type number -> objectbody.items[].changes.employment_info.relocation_reimbursement: type number -> objectbody.items[].changes.employment_info.salary_per_unit: type number -> objectbody.items[].changes.employment_info.target_annual_bonus: type number -> object | Rippling now takes each compensation amount as a currency object (`value`, `currency_type`) instead of a bare number. |
rest_api.create_sandboxes | Input | body.type: enum imposed | Rippling documents `developer` as the only supported sandbox type. |
rest_api.get_custom_object_list_view | Input | path.id: no longer acceptedpath.view_api_name: newly required | Rippling now addresses a list view by its `api_name`; the view’s `id` is a read-only internal identifier with a different value, so an `id` sent as the name would retrieve the wrong view or none. |
rest_api.update_package_versions | Input | body: additional properties no longer accepted | Rippling now documents `description` and `post_install_function` as the only fields a package-version update takes (at least one of them); `description` is no longer required. |
rest_api.create_draft_transitions | Response | items[].changes.employment_info.annual_salary_equivalent: type number/string -> objectitems[].changes.employment_info.equity_value: type number/string -> objectitems[].changes.employment_info.on_target_commission: type number/string -> objectitems[].changes.employment_info.relocation_reimbursement: type number/string -> objectitems[].changes.employment_info.salary_per_unit: type number/string -> objectitems[].changes.employment_info.target_annual_bonus: type number/string -> object | Rippling’s 2026-11-07 reference documents another type for the changed fields; the SDK’s response type follows the provider, so code typed against the earlier response may need to handle it. |
rest_api.create_sandboxes | Response | config_override: no longer returned | Rippling’s 2026-11-07 reference no longer documents the removed response fields; the SDK’s response type follows the provider, so code typed against the earlier response may need to handle it. |
rest_api.get_card_transactions | Response | attachments[]: type string -> objectreceipt: type string -> object | Rippling’s 2026-11-07 reference documents another type for the changed fields; the SDK’s response type follows the provider, so code typed against the earlier response may need to handle it. |
rest_api.get_custom_object_list_view | Response | columns[].width: no longer returned | Rippling’s 2026-11-07 reference no longer documents the removed response fields; the SDK’s response type follows the provider, so code typed against the earlier response may need to handle it. |
rest_api.get_draft_transitions | Response | items[].changes.employment_info.annual_salary_equivalent: type number/string -> objectitems[].changes.employment_info.equity_value: type number/string -> objectitems[].changes.employment_info.on_target_commission: type number/string -> objectitems[].changes.employment_info.relocation_reimbursement: type number/string -> objectitems[].changes.employment_info.salary_per_unit: type number/string -> objectitems[].changes.employment_info.target_annual_bonus: type number/string -> object | Rippling’s 2026-11-07 reference documents another type for the changed fields; the SDK’s response type follows the provider, so code typed against the earlier response may need to handle it. |
rest_api.get_reimbursements | Response | attachments[]: type string -> objectreceipt: type string -> object | Rippling’s 2026-11-07 reference documents another type for the changed fields; the SDK’s response type follows the provider, so code typed against the earlier response may need to handle it. |
rest_api.get_sandboxes | Response | config_override: no longer returned | Rippling’s 2026-11-07 reference no longer documents the removed response fields; the SDK’s response type follows the provider, so code typed against the earlier response may need to handle it. |
rest_api.list_card_transactions | Response | results[].attachments[]: type string -> objectresults[].receipt: type string -> object | Rippling’s 2026-11-07 reference documents another type for the changed fields; the SDK’s response type follows the provider, so code typed against the earlier response may need to handle it. |
rest_api.list_custom_object_list_views | Response | results[].columns[].width: no longer returned | Rippling’s 2026-11-07 reference no longer documents the removed response fields; the SDK’s response type follows the provider, so code typed against the earlier response may need to handle it. |
rest_api.list_reimbursements | Response | results[].attachments[]: type string -> objectresults[].receipt: type string -> object | Rippling’s 2026-11-07 reference documents another type for the changed fields; the SDK’s response type follows the provider, so code typed against the earlier response may need to handle it. |
rest_api.list_sandboxes | Response | results[].config_override: no longer returned | Rippling’s 2026-11-07 reference no longer documents the removed response fields; the SDK’s response type follows the provider, so code typed against the earlier response may need to handle it. |
rest_api.create_sites | Request | entitlements: added API_Tier_1entitlements: removed Sites_Platform_API | Rippling’s 2026-11-07 reference names another entitlement for this operation; the contract’s entitlement list follows the provider, as the changelog lists. |
rest_api.delete_sites | Request | entitlements: added API_Tier_1entitlements: removed Sites_Platform_API | Rippling’s 2026-11-07 reference names another entitlement for this operation; the contract’s entitlement list follows the provider, as the changelog lists. |
rest_api.file_operations_sites | Request | entitlements: added API_Tier_1entitlements: removed Sites_Platform_API | Rippling’s 2026-11-07 reference names another entitlement for this operation; the contract’s entitlement list follows the provider, as the changelog lists. |
rest_api.files_sites | Request | entitlements: added API_Tier_1entitlements: removed Sites_Platform_API | Rippling’s 2026-11-07 reference names another entitlement for this operation; the contract’s entitlement list follows the provider, as the changelog lists. |
rest_api.get_activity_log | Request | entitlements: added API_Tier_1 | Rippling’s 2026-11-07 reference names another entitlement for this operation; the contract’s entitlement list follows the provider, as the changelog lists. |
rest_api.get_card_transactions | Request | entitlements: added Spend_Management_Platform_APIentitlements: removed Internal_Testing | Rippling’s 2026-11-07 reference names another entitlement for this operation; the contract’s entitlement list follows the provider, as the changelog lists. |
rest_api.get_custom_object_list_view | Request | path: "/custom-objects/{custom_object_api_name}/list-views/{id}/" -> "/custom-objects/{custom_object_api_name}/list-views/{view_api_name}/" | Rippling’s 2026-11-07 reference addresses a list view by its `view_api_name` instead of its read-only internal `id` (the matching input change is recorded under reviewed_input_changes and changelogged). |
rest_api.get_reimbursements | Request | entitlements: added Spend_Management_Platform_APIentitlements: removed Internal_Testing | Rippling’s 2026-11-07 reference names another entitlement for this operation; the contract’s entitlement list follows the provider, as the changelog lists. |
rest_api.get_sites | Request | entitlements: added API_Tier_1entitlements: removed Sites_Platform_API | Rippling’s 2026-11-07 reference names another entitlement for this operation; the contract’s entitlement list follows the provider, as the changelog lists. |
rest_api.list_activity_log | Request | entitlements: added API_Tier_1 | Rippling’s 2026-11-07 reference names another entitlement for this operation; the contract’s entitlement list follows the provider, as the changelog lists. |
rest_api.list_card_transactions | Request | entitlements: added Spend_Management_Platform_APIentitlements: removed Internal_Testing | Rippling’s 2026-11-07 reference names another entitlement for this operation; the contract’s entitlement list follows the provider, as the changelog lists. |
rest_api.list_reimbursements | Request | entitlements: added Spend_Management_Platform_APIentitlements: removed Internal_Testing | Rippling’s 2026-11-07 reference names another entitlement for this operation; the contract’s entitlement list follows the provider, as the changelog lists. |
rest_api.list_sites | Request | entitlements: added API_Tier_1entitlements: removed Sites_Platform_API | Rippling’s 2026-11-07 reference names another entitlement for this operation; the contract’s entitlement list follows the provider, as the changelog lists. |
rest_api.update_sites | Request | entitlements: added API_Tier_1entitlements: removed Sites_Platform_API | Rippling’s 2026-11-07 reference names another entitlement for this operation; the contract’s entitlement list follows the provider, as the changelog lists. |
rest_api.upload_batches_presign_sites | Request | entitlements: added API_Tier_1entitlements: removed Sites_Platform_API | Rippling’s 2026-11-07 reference names another entitlement for this operation; the contract’s entitlement list follows the provider, as the changelog lists. |