v1

latestOpenAPI 3.0.12026-07-26222700728.0 KB
Tax Profile

Save tax profile

Save the authenticated user's tax profile configuration

post/v6/taxes/setup

Request body

countryCodestring

ISO 3166-1 alpha-3 country code

statestring

Two-character state/province abbreviation for which tax needs to be calculated

annualW2Incomeinteger

Annual W-2 income total, in cents

numExemptionsinteger

Number of state personal exemptions the tax filer qualifies for

tipIncomeinteger

Year-to-date W-2 income from tips, in cents

overtimeIncomeinteger

Year-to-date W-2 income from overtime, in cents

isSetupCompleteboolean

Whether the user's tax profile is complete

Example request

{
  "countryCode": "USA",
  "state": "DC",
  "filingStatus": {
    "federal": "SINGLE",
    "state": "SINGLE"
  },
  "annualW2Income": 1000000,
  "withholding": {
    "useWithholding": true,
    "federalWithholding": 100051,
    "stateWithholding": 100051
  },
  "numExemptions": 1,
  "tipIncome": 500000,
  "overtimeIncome": 300000,
  "homeOffice": {
    "useHomeOfficeDeduction": true,
    "homeOfficeArea": 250.5
  },
  "mileage": {
    "estimate": 1000,
    "vehicleBusinessPercent": "49.9"
  },
  "expenses": {
    "estimate": 55176
  },
  "income": {
    "estimate": 55176
  }
}

Response

Success

result'SUCCESS' | 'FAILURE'

The result of the action performed.

Example response

{
  "data": {
    "countryCode": "USA",
    "state": "DC",
    "filingStatus": {
      "federal": "SINGLE",
      "state": "SINGLE"
    },
    "annualW2Income": 1000000,
    "withholding": {
      "useWithholding": true,
      "federalWithholding": 100051,
      "stateWithholding": 100051
    },
    "numExemptions": 1,
    "tipIncome": 500000,
    "overtimeIncome": 300000,
    "homeOffice": {
      "useHomeOfficeDeduction": true,
      "homeOfficeArea": 250.5
    },
    "mileage": {
      "estimate": 1000,
      "vehicleBusinessPercent": "49.9"
    },
    "expenses": {
      "estimate": 55176
    },
    "income": {
      "estimate": 55176
    }
  }
}