Incomes

get_my_incomes

Get income records for the current authenticated user

get_my_incomes

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_my_incomes",
    "arguments": {
        "relations": [
          "string"
        ],
        "findInput": {},
        "filterDate": {}
      }
  }
}

const result = await client.callTool({
  "name": "get_my_incomes",
  "arguments": {
    "relations": [
      "string"
    ],
    "findInput": {},
    "filterDate": {}
  }
});

result = await session.call_tool("get_my_incomes", arguments={
  "relations": [
    "string"
  ],
  "findInput": {},
  "filterDate": {}
})

Request Body

{
  "relations": [
    "string"
  ],
  "findInput": {},
  "filterDate": {}
}

Body

application/json

relationsArray<string>

Relations to include (e.g., ["employee", "organizationContact", "tags"])

findInputobject

Find input parameters

filterDateobject

Date filter parameters

get_income_count

Get income count using available filters

get_income_count

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_income_count",
    "arguments": {
        "employeeId": "550e8400-e29b-41d4-a716-446655440000",
        "organizationId": "550e8400-e29b-41d4-a716-446655440000",
        "tenantId": "550e8400-e29b-41d4-a716-446655440000",
        "currency": "USD",
        "amount": 0,
        "valueDate": "string"
      }
  }
}

const result = await client.callTool({
  "name": "get_income_count",
  "arguments": {
    "employeeId": "550e8400-e29b-41d4-a716-446655440000",
    "organizationId": "550e8400-e29b-41d4-a716-446655440000",
    "tenantId": "550e8400-e29b-41d4-a716-446655440000",
    "currency": "USD",
    "amount": 0,
    "valueDate": "string"
  }
});

result = await session.call_tool("get_income_count", arguments={
  "employeeId": "550e8400-e29b-41d4-a716-446655440000",
  "organizationId": "550e8400-e29b-41d4-a716-446655440000",
  "tenantId": "550e8400-e29b-41d4-a716-446655440000",
  "currency": "USD",
  "amount": 0,
  "valueDate": "string"
})

Parameters

employeeIdstring<uuid>

Filter by employee ID

organizationIdstring<uuid>

Filter by organization ID

tenantIdstring<uuid>

Filter by tenant ID

currencystringUSDEURGBPJPYCADAUDCHFCNY

Filter by currency

amountnumber

Filter by amount

valueDatestring

Filter by value date (ISO format)

get_incomes_pagination

Get paginated list of incomes

get_incomes_pagination

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_incomes_pagination",
    "arguments": {
        "page": 1,
        "limit": 10,
        "relations": [
          "string"
        ],
        "where": {}
      }
  }
}

const result = await client.callTool({
  "name": "get_incomes_pagination",
  "arguments": {
    "page": 1,
    "limit": 10,
    "relations": [
      "string"
    ],
    "where": {}
  }
});

result = await session.call_tool("get_incomes_pagination", arguments={
  "page": 1,
  "limit": 10,
  "relations": [
    "string"
  ],
  "where": {}
})

Request Body

{
  "page": 1,
  "limit": 10,
  "relations": [
    "string"
  ],
  "where": {}
}

Body

application/json

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

relationsArray<string>

Relations to include

whereobject

Where conditions

get_incomes

Get list of incomes with filtering options

get_incomes

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_incomes",
    "arguments": {
        "relations": [
          "string"
        ],
        "findInput": {},
        "filterDate": {}
      }
  }
}

const result = await client.callTool({
  "name": "get_incomes",
  "arguments": {
    "relations": [
      "string"
    ],
    "findInput": {},
    "filterDate": {}
  }
});

result = await session.call_tool("get_incomes", arguments={
  "relations": [
    "string"
  ],
  "findInput": {},
  "filterDate": {}
})

Request Body

{
  "relations": [
    "string"
  ],
  "findInput": {},
  "filterDate": {}
}

Body

application/json

relationsArray<string>

Relations to include (e.g., ["employee", "organizationContact", "tags"])

findInputobject

Find input parameters

filterDateobject

Date filter parameters

get_income

Get a specific income by ID

get_income

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_income",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "get_income",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("get_income", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

idstring<uuid>required

The income ID

create_income

Create a new income record

create_income

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_income",
    "arguments": {
        "income_data": {
          "amount": 0,
          "currency": "string"
        }
      }
  }
}

const result = await client.callTool({
  "name": "create_income",
  "arguments": {
    "income_data": {
      "amount": 0,
      "currency": "string"
    }
  }
});

result = await session.call_tool("create_income", arguments={
  "income_data": {
    "amount": 0,
    "currency": "string"
  }
})

Request Body

{
  "income_data": {
    "amount": 0,
    "currency": "string"
  }
}

Body

application/json

income_dataobjectrequired

The data for creating the income

Show child attributes

amountnumberrequired

The amount (required)

currencystringrequired

The currency (required)

[key: string]any

update_income

Update an existing income record

update_income

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_income",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "income_data": {}
      }
  }
}

const result = await client.callTool({
  "name": "update_income",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "income_data": {}
  }
});

result = await session.call_tool("update_income", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "income_data": {}
})

Parameters

idstring<uuid>required

The income ID

income_dataobjectrequired

The data for updating the income

delete_income

Delete an income record

delete_income

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "delete_income",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "employeeId": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "delete_income",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "employeeId": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("delete_income", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "employeeId": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

idstring<uuid>required

The income ID

employeeIdstring<uuid>

Employee ID (required by controller)

Stack Overflow Website Demo