# Incomes

## get_my_incomes

`TOOL get_my_incomes`

Get income records for the current authenticated user

Authentication: no security requirement declared for this operation.

Request body: application/json (required)

Type: object

- `relations` (optional)
  Type: array
  
  Relations to include (e.g., ["employee", "organizationContact", "tags"])
  
  Items:
    Type: string

- `findInput` (optional)
  Type: object
  
  Find input parameters

- `filterDate` (optional)
  Type: object
  
  Date filter parameters

## Examples

### JSON-RPC

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

### TypeScript

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

### Python

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


## get_income_count

`TOOL get_income_count`

Get income count using available filters

Authentication: no security requirement declared for this operation.

Parameters:

- `employeeId` (argument, string, uuid, optional) - Filter by employee ID
  Type: string, uuid
  
  Filter by employee ID
  
  pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"

- `organizationId` (argument, string, uuid, optional) - Filter by organization ID
  Type: string, uuid
  
  Filter by organization ID
  
  pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"

- `tenantId` (argument, string, uuid, optional) - Filter by tenant ID
  Type: string, uuid
  
  Filter by tenant ID
  
  pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"

- `currency` (argument, string, optional) - Filter by currency
  Type: string
  
  Filter by currency
  
  enum: ["USD","EUR","GBP","JPY","CAD","AUD","CHF","CNY"]

- `amount` (argument, number, optional) - Filter by amount
  Type: number
  
  Filter by amount

- `valueDate` (argument, string, optional) - Filter by value date (ISO format)
  Type: string
  
  Filter by value date (ISO format)

## Examples

### JSON-RPC

```json
{
  "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"
      }
  }
}
```

### TypeScript

```typescript
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"
  }
});
```

### Python

```python
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"
})
```


## get_incomes_pagination

`TOOL get_incomes_pagination`

Get paginated list of incomes

Authentication: no security requirement declared for this operation.

Request body: application/json (required)

Type: object

- `page` (optional)
  Type: number
  
  Page number for pagination
  
  default: 1

- `limit` (optional)
  Type: number
  
  Number of items per page
  
  default: 10

- `relations` (optional)
  Type: array
  
  Relations to include
  
  Items:
    Type: string

- `where` (optional)
  Type: object
  
  Where conditions

## Examples

### JSON-RPC

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

### TypeScript

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

### Python

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


## get_incomes

`TOOL get_incomes`

Get list of incomes with filtering options

Authentication: no security requirement declared for this operation.

Request body: application/json (required)

Type: object

- `relations` (optional)
  Type: array
  
  Relations to include (e.g., ["employee", "organizationContact", "tags"])
  
  Items:
    Type: string

- `findInput` (optional)
  Type: object
  
  Find input parameters

- `filterDate` (optional)
  Type: object
  
  Date filter parameters

## Examples

### JSON-RPC

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

### TypeScript

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

### Python

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


## get_income

`TOOL get_income`

Get a specific income by ID

Authentication: no security requirement declared for this operation.

Parameters:

- `id` (argument, string, uuid, required) - The income ID
  Type: string, uuid
  
  The income ID
  
  pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"

## Examples

### JSON-RPC

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

### TypeScript

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

### Python

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


## create_income

`TOOL create_income`

Create a new income record

Authentication: no security requirement declared for this operation.

Request body: application/json (required)

Type: object

- `income_data` (required)
  Type: object
  
  The data for creating the income
  
  - `amount` (required)
    Type: number
    
    The amount (required)
  
  - `currency` (required)
    Type: string
    
    The currency (required)
  
  Additional properties: 
    Type: unknown

## Examples

### JSON-RPC

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

### TypeScript

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

### Python

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


## update_income

`TOOL update_income`

Update an existing income record

Authentication: no security requirement declared for this operation.

Parameters:

- `id` (argument, string, uuid, required) - The income ID
  Type: string, uuid
  
  The income ID
  
  pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"

- `income_data` (argument, object, required) - The data for updating the income
  Type: object
  
  The data for updating the income
  
  Additional properties: 
    Type: unknown

## Examples

### JSON-RPC

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

### TypeScript

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

### Python

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


## delete_income

`TOOL delete_income`

Delete an income record

Authentication: no security requirement declared for this operation.

Parameters:

- `id` (argument, string, uuid, required) - The income ID
  Type: string, uuid
  
  The income ID
  
  pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"

- `employeeId` (argument, string, uuid, optional) - Employee ID (required by controller)
  Type: string, uuid
  
  Employee ID (required by controller)
  
  pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"

## Examples

### JSON-RPC

```json
{
  "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"
      }
  }
}
```

### TypeScript

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

### Python

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