Justworks

App · 22 actions

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

Actions

ActionWhat it does
Cancel deductionsCancel Deductions.
Create deductionsCreate Deductions.
Create time off balances reportCreate Time Off Balances Report.
Get companyGet Company.
Get company bank accountGet Company Bank Account.
Get company business infoGet Company Business Info.
Get member by idGet Member By ID.
Get paystub by idGet Paystub By ID.
Get tax idby member idGet Tax ID By Member ID.
Get time off balances report by idGet Time Off Balances Report.
List company custom fieldsList Company Custom Fields.
List custom field values by member idList Custom Field Values By Member ID.
List deduction typesList Deduction Types.
List deductionsList Deductions.
List fees by payroll idList Fees By Payroll ID.
List membersList Members.
List payrollsList Payrolls.
List paystubs by payroll idList Paystubs By Payroll ID.
List subscriptionsList Subscriptions.
List time off policiesList Time Off Policies.
List time off requestsList Time Off Requests.
Update deductionsUpdate Deductions.

Cancel deductions

Cancel Deductions.

Inputs

Deduction idsdeduction_idslistRequired
Unique identifiers of the deductions to cancel.

Outputs

dataobject
Justworks response data.
Example output
{
  "data": {
    "items": []
  }
}

Create deductions

Create Deductions.

Inputs

Itemsitemslist
Deductions to create.

Outputs

dataobject
Justworks response data.
Example output
{
  "data": {
    "items": []
  }
}

Create time off balances report

Create Time Off Balances Report.

Inputs

As of dateas_of_datedate
Date to calculate balances as of.
Membermember_idtext
Prefixed ULID identifier for a member.
Policy idpolicy_idtext
Filter the report to a specific policy.

Outputs

dataobject
Justworks response data.
Example output
{
  "data": {
    "report_id": "example"
  }
}

Get company

Get Company.

Inputs

None.

Outputs

dataobject
Justworks response data.
Example output
{
  "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

dataobject
Justworks response data.
Example output
{
  "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

dataobject
Justworks response data.
Example output
{
  "data": {
    "entity_identifiers": [],
    "officers": []
  }
}

Get member by id

Get Member By ID.

Inputs

Membermember_idtextRequired
Prefixed ULID identifier for a member.

Outputs

dataobject
Justworks response data.
Example output
{
  "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 idpaystub_idtextRequired
Paystub ID

Outputs

dataobject
Justworks response data.
Example output
{
  "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

Membermember_idtextRequired
Prefixed ULID identifier for a member.

Outputs

dataobject
Justworks response data.
Example output
{
  "data": {
    "US": {
      "ssn": "example"
    }
  }
}

Get time off balances report by id

Get Time Off Balances Report.

Inputs

Report idreport_idtextRequired
Report ID

Outputs

dataobject
Justworks response data.
Example output
{
  "data": {
    "items": [],
    "message": "example",
    "status": "pending"
  }
}

List company custom fields

List Company Custom Fields.

Inputs

None.

Outputs

dataobject
Justworks response data.
Example output
{
  "data": {
    "items": []
  }
}

List custom field values by member id

List Custom Field Values By Member ID.

Inputs

Membermember_idtextRequired
Prefixed ULID identifier for a member.

Outputs

dataobject
Justworks response data.
Example output
{
  "data": {
    "items": []
  }
}

List deduction types

List Deduction Types.

Inputs

None.

Outputs

dataobject
Justworks response data.
Example output
{
  "data": {
    "items": []
  }
}

List deductions

List Deductions.

Inputs

Deduction typededuction_typetext
Deduction Type
Frequencyfrequencytext
Frequency
Descriptiondescriptiontext
Description
Membermember_idtext
Prefixed ULID identifier for a member.
Cursorcursortext
Opaque pagination cursor.
Limitlimitnumber
LimitFrom 1 to 100. Default: 100.

Outputs

dataobject
Justworks response data.
Example output
{
  "data": {
    "items": [],
    "next_cursor": "example"
  }
}

List fees by payroll id

List Fees By Payroll ID.

Inputs

Payroll idpayroll_idtextRequired
Payroll ID
Limitlimitnumber
LimitFrom 1 to 100. Default: 100.
Cursorcursortext
Opaque pagination cursor.

Outputs

dataobject
Justworks response data.
Example output
{
  "data": {
    "items": [],
    "next_cursor": "example"
  }
}

List members

List Members.

Inputs

Cursorcursortext
Prefixed ULID identifier for a member.
Limitlimitnumber
LimitFrom 1 to 100. Default: 100.
Statusstatustext
StatusOne of: active, terminated.
Updated atupdated_atdate and time
Date format: YYYY-MM-DD
Updated at gtupdated_at_gtdate and time
Date format: YYYY-MM-DD
Updated at gteupdated_at_gtedate and time
Date format: YYYY-MM-DD
Updated at ltupdated_at_ltdate and time
Date format: YYYY-MM-DD
Updated at lteupdated_at_ltedate and time
Date format: YYYY-MM-DD
Updated at neupdated_at_nedate and time
Date format: YYYY-MM-DD

Outputs

dataobject
Justworks response data.
Example output
{
  "data": {
    "items": [],
    "next_cursor": "example"
  }
}

List payrolls

List Payrolls.

Inputs

Start datestart_datedateRequired
Date in YYYY-MM-DD format.
End dateend_datedateRequired
Date in YYYY-MM-DD format.
Limitlimitnumber
LimitFrom 1 to 100. Default: 100.
Cursorcursortext
Opaque pagination cursor.

Outputs

dataobject
Justworks response data.
Example output
{
  "data": {
    "items": [],
    "next_cursor": "example"
  }
}

List paystubs by payroll id

List Paystubs By Payroll ID.

Inputs

Payroll idpayroll_idtextRequired
Payroll ID
Limitlimitnumber
LimitFrom 1 to 100. Default: 100.
Cursorcursortext
Opaque pagination cursor.

Outputs

dataobject
Justworks response data.
Example output
{
  "data": {
    "items": [],
    "next_cursor": "example"
  }
}

List subscriptions

List Subscriptions.

Inputs

Include expiredinclude_expiredtrue/false
Whether to include expired subscriptions in the response.Default: false.

Outputs

dataobject
Justworks response data.
Example output
{
  "data": {
    "items": []
  }
}

List time off policies

List Time Off Policies.

Inputs

Statusstatustext
StatusOne of: active, inactive.
Limitlimitnumber
LimitFrom 1 to 100. Default: 100.
Cursorcursortext
Opaque pagination cursor.

Outputs

dataobject
Justworks response data.
Example output
{
  "data": {
    "items": [],
    "next_cursor": "example"
  }
}

List time off requests

List Time Off Requests.

Inputs

Start datestart_datedateRequired
Date in YYYY-MM-DD format.
End dateend_datedateRequired
Date in YYYY-MM-DD format.
Membermember_idtext
Prefixed ULID identifier for a member.
Policy idpolicy_idtext
Policy ID
Statusstatustext
StatusOne of: requested, approved, declined, cancelled, deleted, manual.
Limitlimitnumber
LimitFrom 1 to 100. Default: 100.
Cursorcursortext
Opaque pagination cursor.

Outputs

dataobject
Justworks response data.
Example output
{
  "data": {
    "items": [],
    "next_cursor": "example"
  }
}

Update deductions

Update Deductions.

Inputs

Itemsitemslist
Deductions to update.

Outputs

dataobject
Justworks response data.
Example output
{
  "data": {
    "items": []
  }
}

On this page