# Justworks

> Read company, member, payroll and time-off data, and manage deductions.

App · 22 actions. Web page: https://docs.lodol.com/docs/integrations/justworks

## Actions

### Cancel deductions

Cancel Deductions.

**Inputs**

- Deduction ids (`deduction_ids`, list, required): Unique identifiers of the deductions to cancel.

**Outputs**

- `data` (object): Justworks response data.

**Example output**

```json
{
  "data": {
    "items": []
  }
}
```

### Create deductions

Create Deductions.

**Inputs**

- Items (`items`, list): Deductions to create.

**Outputs**

- `data` (object): Justworks response data.

**Example output**

```json
{
  "data": {
    "items": []
  }
}
```

### Create time off balances report

Create Time Off Balances Report.

**Inputs**

- As of date (`as_of_date`, date): Date to calculate balances as of.
- Member (`member_id`, text): Prefixed ULID identifier for a member.
- Policy id (`policy_id`, text): Filter the report to a specific policy.

**Outputs**

- `data` (object): Justworks response data.

**Example output**

```json
{
  "data": {
    "report_id": "example"
  }
}
```

### Get company

Get Company.

**Inputs**: None.

**Outputs**

- `data` (object): Justworks response data.

**Example output**

```json
{
  "data": {
    "addresses": [],
    "country_data": {
      "US": {
        "structure": "corporation"
      }
    },
    "created_at": "example",
    "departments": [],
    "display_name": "example",
    "id": "example",
    "legal_name": "example",
    "offices": [],
    "phones": [],
    "tax_id": "example",
    "updated_at": "example"
  }
}
```

### Get company bank account

Get Company Bank Account.

**Inputs**: None.

**Outputs**

- `data` (object): Justworks response data.

**Example output**

```json
{
  "data": {
    "account_number_tail": "example",
    "account_type": "example",
    "bank_name": "example",
    "routing_number": "example"
  }
}
```

### Get company business info

Get Company Business Info.

**Inputs**: None.

**Outputs**

- `data` (object): Justworks response data.

**Example output**

```json
{
  "data": {
    "entity_identifiers": [],
    "officers": []
  }
}
```

### Get member by id

Get Member By ID.

**Inputs**

- Member (`member_id`, text, required): Prefixed ULID identifier for a member.

**Outputs**

- `data` (object): Justworks response data.

**Example output**

```json
{
  "data": {
    "active": false,
    "addresses": [],
    "company_id": "example",
    "created_at": "example",
    "current_employment": {
      "effective_date": "example",
      "job_title": "example",
      "status": "active",
      "type": "unpaid_owner"
    },
    "current_pay": {
      "country_data": {
        "US": {
          "flsa_status": "exempt"
        }
      },
      "effective_date": "example",
      "pay_basis": "annual",
      "pay_currency": "example",
      "pay_rate": 1
    },
    "current_pay_frequency": "monthly",
    "date_added_to_justworks": "example",
    "date_of_birth": "example",
    "department": {
      "id": "example",
      "name": "example"
    },
    "emails": [],
    "employment_history": [],
    "employment_location_type": "office",
    "employment_start_date": "example",
    "employment_termination_date": "example",
    "id": "example",
    "job_title": "example",
    "manager": {
      "full_preferred_name": "example",
      "id": "example"
    },
    "name": {
      "additional_names": "example",
      "family_name": "example",
      "full_preferred_name": "example",
      "given_name": "example",
      "preferred_name": "example"
    },
    "office": {
      "address": {
        "city": "example",
        "country_code": "example",
        "line1": "example",
        "line2": "example",
        "postal_code": "example",
        "type": "home",
        "zone_code": "example"
      },
      "id": "example",
      "name": "example"
    },
    "partner_settings": {},
    "pay_history": [],
    "phones": [],
    "sex_assigned_at_birth": "male",
    "type": "unpaid_owner",
    "updated_at": "example",
    "work_id": "example"
  }
}
```

### Get paystub by id

Get Paystub By ID.

**Inputs**

- Paystub id (`paystub_id`, text, required): Paystub ID

**Outputs**

- `data` (object): Justworks response data.

**Example output**

```json
{
  "data": {
    "currency": "example",
    "earnings": [],
    "employee_deductions": [],
    "employer_contributions": [],
    "gross_pay": 1,
    "member_id": "example",
    "minutes_not_worked": 1,
    "minutes_worked": 1,
    "net_pay": 1,
    "pay_date": "example",
    "pay_group": "example",
    "pay_period_end": "example",
    "pay_period_start": "example",
    "paystub_id": "example"
  }
}
```

### Get tax idby member id

Get Tax ID By Member ID.

**Inputs**

- Member (`member_id`, text, required): Prefixed ULID identifier for a member.

**Outputs**

- `data` (object): Justworks response data.

**Example output**

```json
{
  "data": {
    "US": {
      "ssn": "example"
    }
  }
}
```

### Get time off balances report by id

Get Time Off Balances Report.

**Inputs**

- Report id (`report_id`, text, required): Report ID

**Outputs**

- `data` (object): Justworks response data.

**Example output**

```json
{
  "data": {
    "items": [],
    "message": "example",
    "status": "pending"
  }
}
```

### List company custom fields

List Company Custom Fields.

**Inputs**: None.

**Outputs**

- `data` (object): Justworks response data.

**Example output**

```json
{
  "data": {
    "items": []
  }
}
```

### List custom field values by member id

List Custom Field Values By Member ID.

**Inputs**

- Member (`member_id`, text, required): Prefixed ULID identifier for a member.

**Outputs**

- `data` (object): Justworks response data.

**Example output**

```json
{
  "data": {
    "items": []
  }
}
```

### List deduction types

List Deduction Types.

**Inputs**: None.

**Outputs**

- `data` (object): Justworks response data.

**Example output**

```json
{
  "data": {
    "items": []
  }
}
```

### List deductions

List Deductions.

**Inputs**

- Deduction type (`deduction_type`, text): Deduction Type
- Frequency (`frequency`, text): Frequency
- Description (`description`, text): Description
- Member (`member_id`, text): Prefixed ULID identifier for a member.
- Cursor (`cursor`, text): Opaque pagination cursor.
- Limit (`limit`, number): Limit. From 1 to 100. Default: `100`.

**Outputs**

- `data` (object): Justworks response data.

**Example output**

```json
{
  "data": {
    "items": [],
    "next_cursor": "example"
  }
}
```

### List fees by payroll id

List Fees By Payroll ID.

**Inputs**

- Payroll id (`payroll_id`, text, required): Payroll ID
- Limit (`limit`, number): Limit. From 1 to 100. Default: `100`.
- Cursor (`cursor`, text): Opaque pagination cursor.

**Outputs**

- `data` (object): Justworks response data.

**Example output**

```json
{
  "data": {
    "items": [],
    "next_cursor": "example"
  }
}
```

### List members

List Members.

**Inputs**

- Cursor (`cursor`, text): Prefixed ULID identifier for a member.
- Limit (`limit`, number): Limit. From 1 to 100. Default: `100`.
- Status (`status`, text): Status. One of: `active`, `terminated`.
- Updated at (`updated_at`, date and time): Date format: YYYY-MM-DD
- Updated at gt (`updated_at_gt`, date and time): Date format: YYYY-MM-DD
- Updated at gte (`updated_at_gte`, date and time): Date format: YYYY-MM-DD
- Updated at lt (`updated_at_lt`, date and time): Date format: YYYY-MM-DD
- Updated at lte (`updated_at_lte`, date and time): Date format: YYYY-MM-DD
- Updated at ne (`updated_at_ne`, date and time): Date format: YYYY-MM-DD

**Outputs**

- `data` (object): Justworks response data.

**Example output**

```json
{
  "data": {
    "items": [],
    "next_cursor": "example"
  }
}
```

### List payrolls

List Payrolls.

**Inputs**

- Start date (`start_date`, date, required): Date in YYYY-MM-DD format.
- End date (`end_date`, date, required): Date in YYYY-MM-DD format.
- Limit (`limit`, number): Limit. From 1 to 100. Default: `100`.
- Cursor (`cursor`, text): Opaque pagination cursor.

**Outputs**

- `data` (object): Justworks response data.

**Example output**

```json
{
  "data": {
    "items": [],
    "next_cursor": "example"
  }
}
```

### List paystubs by payroll id

List Paystubs By Payroll ID.

**Inputs**

- Payroll id (`payroll_id`, text, required): Payroll ID
- Limit (`limit`, number): Limit. From 1 to 100. Default: `100`.
- Cursor (`cursor`, text): Opaque pagination cursor.

**Outputs**

- `data` (object): Justworks response data.

**Example output**

```json
{
  "data": {
    "items": [],
    "next_cursor": "example"
  }
}
```

### List subscriptions

List Subscriptions.

**Inputs**

- Include expired (`include_expired`, true/false): Whether to include expired subscriptions in the response. Default: `false`.

**Outputs**

- `data` (object): Justworks response data.

**Example output**

```json
{
  "data": {
    "items": []
  }
}
```

### List time off policies

List Time Off Policies.

**Inputs**

- Status (`status`, text): Status. One of: `active`, `inactive`.
- Limit (`limit`, number): Limit. From 1 to 100. Default: `100`.
- Cursor (`cursor`, text): Opaque pagination cursor.

**Outputs**

- `data` (object): Justworks response data.

**Example output**

```json
{
  "data": {
    "items": [],
    "next_cursor": "example"
  }
}
```

### List time off requests

List Time Off Requests.

**Inputs**

- Start date (`start_date`, date, required): Date in YYYY-MM-DD format.
- End date (`end_date`, date, required): Date in YYYY-MM-DD format.
- Member (`member_id`, text): Prefixed ULID identifier for a member.
- Policy id (`policy_id`, text): Policy ID
- Status (`status`, text): Status. One of: `requested`, `approved`, `declined`, `cancelled`, `deleted`, `manual`.
- Limit (`limit`, number): Limit. From 1 to 100. Default: `100`.
- Cursor (`cursor`, text): Opaque pagination cursor.

**Outputs**

- `data` (object): Justworks response data.

**Example output**

```json
{
  "data": {
    "items": [],
    "next_cursor": "example"
  }
}
```

### Update deductions

Update Deductions.

**Inputs**

- Items (`items`, list): Deductions to update.

**Outputs**

- `data` (object): Justworks response data.

**Example output**

```json
{
  "data": {
    "items": []
  }
}
```
