Obolus ACTION
Calculate Net Salary
Use this only for detailed net salary and payroll calculation for one country and one or two people. Inputs and outputs are country-polymorphic: the same field name can map to different tax, social security, or payroll concepts depending on the selected country and tax system. For comparing salary, tax, or net income across multiple countries, use Compare Salary Across Countries instead. See the documentation
- Action
- Read only
- API key
- SDK
- MCP
IMPLEMENTATION
Call this tool
Connect a user's Obolus account once, then configure and run Calculate Net Salary from your backend or agent.
import { PipedreamClient } from "@pipedream/sdk"
const pd = new PipedreamClient({
projectId: process.env.PIPEDREAM_PROJECT_ID!,
clientId: process.env.PIPEDREAM_CLIENT_ID!,
clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
projectEnvironment: "production",
})
const result = await pd.actions.run({
id: "obolus-berechne",
externalUserId: "{external_user_id}", // any stable ID for this user in your system
configuredProps: {
obolus: { authProvisionId: "apn_xxxxxxx" },
country: "Country",
taxYear: 10,
},
})
console.log(result)curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
-H "Content-Type: application/json" \
-H "X-PD-Environment: production" \
-H "Authorization: Bearer {access_token}" \
-d '{
"external_user_id": "{external_user_id}",
"id": "obolus-berechne",
"configured_props": {
"obolus": { "authProvisionId": "apn_xxxxxxx" },
"country": "Country",
"taxYear": 10
}
}'// accessToken: mint a short-lived token with the Connect SDK — see the MCP guide
const transport = new StreamableHTTPClientTransport(
new URL("https://remote.mcp.pipedream.net/v3"),
{
requestInit: {
headers: {
Authorization: `Bearer ${accessToken}`,
"x-pd-project-id": "{project_id}",
"x-pd-environment": "production",
"x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
"x-pd-app-slug": "obolus",
},
},
},
)
const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)
const { tools } = await mcp.listTools()
// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
name: "obolus-berechne",
arguments: {
country: "Country",
taxYear: 10,
},
})SCHEMA
Inputs
Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.
| Property | Type | Description |
|---|---|---|
country Country | string | Country code, e.g. DE. In Calculate Net Salary this selects the country-specific tax and payroll system, so identically named inputs and outputs can have different meanings by country. Required |
taxYear Tax Year | integer | Country-specific tax year for this detailed payroll calculation, e.g. 2026. Required |
currency Currency | string | Currency code in upper-case ISO style for the salary input and payroll output. Required |
payrollPeriod Payroll Period | integer | Top-level LZZ value. 1=year, 2=month, 3=week, 4=day. Direct salary inputs are annual gross amounts; this action converts them to the selected payroll period before calling Obolus. Period handling is interpreted by the selected country's payroll rules. Required |
grossAnnual Person 1 Annual Gross Salary | string | Person 1 annual gross salary in major units, e.g. 60000. Use Compare Salary Across Countries instead when the task is to compare this salary across multiple countries. Required |
taxClass Person 1 Tax Class | integer | Country-specific tax class, filing status, or equivalent payroll category. The numeric meaning depends on the selected country. Required |
birthYear Person 1 Birth Year | integer | Birth year of the first person. Required |
includeSecondPerson Include Person 2 | boolean | Enable a second person and switch Modus to 2 for detailed household payroll in one selected country. Optional |
showAdvancedInputs Show Advanced Inputs | boolean | Reveal additional Obolus OpenAPI fields for advanced and country-specific payroll scenarios. These fields are not globally portable; their meaning can change by country and tax system. Optional |
REFERENCE
Tool details
Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.
- Registry key
- obolus-berechne
- Version
- 0.0.2
- App
- Obolus
- Authentication
- API key
- Read-only
- Yes
- Destructive
- No
- Open world
- Yes
- Source
- View on GitHub ↗