Member Taxes

Create MemberTax

Creates a new MemberTax

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

header Parameters
vbasoftware-database
required
string

Target database

Request Body schema:
required
memberTax_Key
required
integer <int32>

Unique identier for each Tax configuration on this Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.

annual_Withholding_Allowance
number or null <double>

Member's state annual withholding allowance as listed on the Member's tax documents.

auxiliary
number or null <double>

Member's auxilary amounts as listed on the Member's tax documents.

deductions_Amt
number or null <double>

Member's deductions amount as listed on the Member's tax documents.

dependant_Withholding_Amt
number or null <double>

Member's dependant withholding amount as listed on the Member's tax documents.

effective_From
string or null <date-time>

Date when the Member's tax record becomes/became effective.

effective_Thru
string or null <date-time>

Date when the Member's tax record expires/expired.

entry_Date
string <date-time>

Date when the record was first added to the system.

entry_User
string or null <= 20 characters

User that first added the record to the system.

exemptions
required
integer <int32>

Member's exemptions as listed on the Member's tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.

exemptions_State
integer or null <int32>

State of the Member's exemptions as listed on the Member's tax documents.

extra_Withholding_Amt
number or null <double>

Member's extra withholding amount as listed on the Member's tax documents.

federal_Tax_Exempt
required
boolean

Member's federal exemption status as listed on the Member's tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.

filing_Status
integer or null <int32>

Member's filing status as listed on the Member's tax documents.

filing_Status_State
integer or null <int32>

Member's filing status for state taxes as listed on the Member's tax documents.

flat_Tax
number or null <double>

Member's federal flat tax amount as listed on the Member's tax documents.

flat_Tax_State
number or null <double>

Member's state flat tax amount as listed on the Member's tax documents.

gross_Salary
number or null <double>

Member's gross salary as listed on the Member's tax documents.

hours_Worked
number or null <double>

Number of hours the Member worked at the specified frequency as listed on the Member's tax documents.

hours_Worked_Frequency
string or null <= 1 characters

Frequency at which the Member worked the specified number of hours as listed on the Member's tax documents.

local_Tax_Code
string or null <= 128 characters

Member's local tax code as listed on the Member's tax documents.

medicare_Tax_Exempt
required
boolean

Member's medicare exemption status as listed on the Member's tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.

member_Seq
string or null <= 2 characters

References Members.Member_Seq value on the parent record.

miscellaneous
number or null <double>

Member's miscellaneous amounts as listed on the Member's tax documents.

net_Salary
number or null <double>

Member's net salary as listed on the Member's tax documents.

other_Income_Amt
number or null <double>

Member's other income amount as listed on the Member's tax documents.

percentage_Election
number or null <double>

Member's election percentage at the federal level as listed on the Member's tax documents.

socSec_Tax_Exempt
required
boolean

Member's social security exemption status as listed on the Member's tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.

state_Percentage_Election
required
boolean

Member's election percentage at the state level as listed on the Member's tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.

state_Tax_Exempt
required
boolean

Member's tax exemption status as listed on the Member's tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.

state_Withholding
number or null <double>

Holds a numeric value listed as withholding, used in conjunction with Tax Control.

subscriber_ID
string or null <= 9 characters

References Members.Subscriber_ID value on the parent record.

tax_Exempt
required
boolean

Member's exemption status as listed on the Member's tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.

tips
number or null <double>

Member's amount of tips as listed on the Member's tax documents.

update_Date
string <date-time>

Date when the record was last updated in the system.

update_User
string or null <= 20 characters

User that last updated the record in the system.

w4_2020
required
boolean

Specifies that the associated W4 is from 2020. Note: This field is marked as NOT NULL in the database and therefore required by the API.

w4_Box_C
required
boolean

Specifies whether Box C was checked according to the Member's tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.

Responses
200

Success

401

Unauthorized

post/subscribers/{subscriberID}/members/{memberSeq}/taxes
Request samples
{
  • "memberTax_Key": 0,
  • "annual_Withholding_Allowance": 0.1,
  • "auxiliary": 0.1,
  • "deductions_Amt": 0.1,
  • "dependant_Withholding_Amt": 0.1,
  • "effective_From": "2019-08-24T14:15:22Z",
  • "effective_Thru": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "exemptions": 0,
  • "exemptions_State": 0,
  • "extra_Withholding_Amt": 0.1,
  • "federal_Tax_Exempt": true,
  • "filing_Status": 0,
  • "filing_Status_State": 0,
  • "flat_Tax": 0.1,
  • "flat_Tax_State": 0.1,
  • "gross_Salary": 0.1,
  • "hours_Worked": 0.1,
  • "hours_Worked_Frequency": "s",
  • "local_Tax_Code": "string",
  • "medicare_Tax_Exempt": true,
  • "member_Seq": "st",
  • "miscellaneous": 0.1,
  • "net_Salary": 0.1,
  • "other_Income_Amt": 0.1,
  • "percentage_Election": 0.1,
  • "socSec_Tax_Exempt": true,
  • "state_Percentage_Election": true,
  • "state_Tax_Exempt": true,
  • "state_Withholding": 0.1,
  • "subscriber_ID": "string",
  • "tax_Exempt": true,
  • "tips": 0.1,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "w4_2020": true,
  • "w4_Box_C": true
}
Response samples
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}

List MemberTax

Lists all MemberTax for the given subscriberID and memberSeq and memberTaxKey

SecurityapiKeyAuth and bearerAuth
Request
path Parameters
subscriberID
required
string

Subscriber ID

memberSeq
required
string

Member Seq

query Parameters
page
integer <int32>
Default: 1

Page

pageSize
integer <int32>
Default: 100

Page Size

sortBy
string

Comma separated string to sort by. Each sort field can be followed by :asc or :desc to specify sort direction, ascending is default. E.g., 'Property1:desc,Property2:asc,Property3:asc' sorts Property1 in descending order, Property2 in ascending, and Property3 in ascending.

header Parameters
vbasoftware-database
required
string

Target database

Responses
200

Success

401

Unauthorized

get/subscribers/{subscriberID}/members/{memberSeq}/taxes
Request samples 
Response samples 
No sample
Get MemberTax
Gets MemberTax


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberTaxKey
required
integer <int32> 
MemberTax Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
200
Success


401
Unauthorized


get/subscribers/{subscriberID}/members/{memberSeq}/taxes/{memberTaxKey}
Request samples 
Response samples 
No sample
Update MemberTax
Updates a specific MemberTax.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberTaxKey
required
integer <int32> 
MemberTax Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
memberTax_Key
required
integer <int32> 
Unique identier for each Tax configuration on this Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
annual_Withholding_Allowance
number or null <double> 
Member's state annual withholding allowance as listed on the Member's tax documents.


 
auxiliary
number or null <double> 
Member's auxilary amounts as listed on the Member's tax documents.


 
deductions_Amt
number or null <double> 
Member's deductions amount as listed on the Member's tax documents.


 
dependant_Withholding_Amt
number or null <double> 
Member's dependant withholding amount as listed on the Member's tax documents.


 
effective_From
string or null <date-time> 
Date when the Member's tax record becomes/became effective.


 
effective_Thru
string or null <date-time> 
Date when the Member's tax record expires/expired.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
exemptions
required
integer <int32> 
Member's exemptions as listed on the Member's tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
exemptions_State
integer or null <int32> 
State of the Member's exemptions as listed on the Member's tax documents.


 
extra_Withholding_Amt
number or null <double> 
Member's extra withholding amount as listed on the Member's tax documents.


 
federal_Tax_Exempt
required
boolean
Member's federal exemption status as listed on the Member's tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
filing_Status
integer or null <int32> 
Member's filing status as listed on the Member's tax documents.


 
filing_Status_State
integer or null <int32> 
Member's filing status for state taxes as listed on the Member's tax documents.


 
flat_Tax
number or null <double> 
Member's federal flat tax amount as listed on the Member's tax documents.


 
flat_Tax_State
number or null <double> 
Member's state flat tax amount as listed on the Member's tax documents.


 
gross_Salary
number or null <double> 
Member's gross salary as listed on the Member's tax documents.


 
hours_Worked
number or null <double> 
Number of hours the Member worked at the specified frequency as listed on the Member's tax documents.


 
hours_Worked_Frequency
string or null  <= 1 characters 
Frequency at which the Member worked the specified number of hours as listed on the Member's tax documents.


 
local_Tax_Code
string or null  <= 128 characters 
Member's local tax code as listed on the Member's tax documents.


 
medicare_Tax_Exempt
required
boolean
Member's medicare exemption status as listed on the Member's tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
member_Seq
string or null  <= 2 characters 
References Members.Member_Seq value on the parent record.


 
miscellaneous
number or null <double> 
Member's miscellaneous amounts as listed on the Member's tax documents.


 
net_Salary
number or null <double> 
Member's net salary as listed on the Member's tax documents.


 
other_Income_Amt
number or null <double> 
Member's other income amount as listed on the Member's tax documents.


 
percentage_Election
number or null <double> 
Member's election percentage at the federal level as listed on the Member's tax documents.


 
socSec_Tax_Exempt
required
boolean
Member's social security exemption status as listed on the Member's tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
state_Percentage_Election
required
boolean
Member's election percentage at the state level as listed on the Member's tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
state_Tax_Exempt
required
boolean
Member's tax exemption status as listed on the Member's tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
state_Withholding
number or null <double> 
Holds a numeric value listed as withholding, used in conjunction with Tax Control.


 
subscriber_ID
string or null  <= 9 characters 
References Members.Subscriber_ID value on the parent record.


 
tax_Exempt
required
boolean
Member's exemption status as listed on the Member's tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
tips
number or null <double> 
Member's amount of tips as listed on the Member's tax documents.


 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system.


 
w4_2020
required
boolean
Specifies that the associated W4 is from 2020. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
w4_Box_C
required
boolean
Specifies whether Box C was checked according to the Member's tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
200
Success


401
Unauthorized


put/subscribers/{subscriberID}/members/{memberSeq}/taxes/{memberTaxKey}
Request samples 
{
  • "memberTax_Key": 0,
  • "annual_Withholding_Allowance": 0.1,
  • "auxiliary": 0.1,
  • "deductions_Amt": 0.1,
  • "dependant_Withholding_Amt": 0.1,
  • "effective_From": "2019-08-24T14:15:22Z",
  • "effective_Thru": "2019-08-24T14:15:22Z",
  • "entry_Date": "2019-08-24T14:15:22Z",
  • "entry_User": "string",
  • "exemptions": 0,
  • "exemptions_State": 0,
  • "extra_Withholding_Amt": 0.1,
  • "federal_Tax_Exempt": true,
  • "filing_Status": 0,
  • "filing_Status_State": 0,
  • "flat_Tax": 0.1,
  • "flat_Tax_State": 0.1,
  • "gross_Salary": 0.1,
  • "hours_Worked": 0.1,
  • "hours_Worked_Frequency": "s",
  • "local_Tax_Code": "string",
  • "medicare_Tax_Exempt": true,
  • "member_Seq": "st",
  • "miscellaneous": 0.1,
  • "net_Salary": 0.1,
  • "other_Income_Amt": 0.1,
  • "percentage_Election": 0.1,
  • "socSec_Tax_Exempt": true,
  • "state_Percentage_Election": true,
  • "state_Tax_Exempt": true,
  • "state_Withholding": 0.1,
  • "subscriber_ID": "string",
  • "tax_Exempt": true,
  • "tips": 0.1,
  • "update_Date": "2019-08-24T14:15:22Z",
  • "update_User": "string",
  • "w4_2020": true,
  • "w4_Box_C": true
}
Response samples 
{
  • "data": {
    },
  • "error": {
    },
  • "debug": {
    }
}
Delete MemberTax
Deletes an MemberTax


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
memberTaxKey
required
integer <int32> 
MemberTax Key


 
header Parameters
vbasoftware-database
required
string
Target database


 
Responses 
204
Success


401
Unauthorized


delete/subscribers/{subscriberID}/members/{memberSeq}/taxes/{memberTaxKey}
Request samples 
Create or Update Batch MemberTax
Create or Update multiple MemberTax at once.  If the entity exists, it will be updated.  If the entity does not exist, it will be created.


SecurityapiKeyAuth and bearerAuth 
Request 
path Parameters
subscriberID
required
string
Subscriber ID


 
memberSeq
required
string
Member Seq


 
header Parameters
vbasoftware-database
required
string
Target database


 
Request Body schema: 
required
 Array 
memberTax_Key
required
integer <int32> 
Unique identier for each Tax configuration on this Member. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
annual_Withholding_Allowance
number or null <double> 
Member's state annual withholding allowance as listed on the Member's tax documents.


 
auxiliary
number or null <double> 
Member's auxilary amounts as listed on the Member's tax documents.


 
deductions_Amt
number or null <double> 
Member's deductions amount as listed on the Member's tax documents.


 
dependant_Withholding_Amt
number or null <double> 
Member's dependant withholding amount as listed on the Member's tax documents.


 
effective_From
string or null <date-time> 
Date when the Member's tax record becomes/became effective.


 
effective_Thru
string or null <date-time> 
Date when the Member's tax record expires/expired.


 
entry_Date
string <date-time> 
Date when the record was first added to the system.


 
entry_User
string or null  <= 20 characters 
User that first added the record to the system.


 
exemptions
required
integer <int32> 
Member's exemptions as listed on the Member's tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
exemptions_State
integer or null <int32> 
State of the Member's exemptions as listed on the Member's tax documents.


 
extra_Withholding_Amt
number or null <double> 
Member's extra withholding amount as listed on the Member's tax documents.


 
federal_Tax_Exempt
required
boolean
Member's federal exemption status as listed on the Member's tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
filing_Status
integer or null <int32> 
Member's filing status as listed on the Member's tax documents.


 
filing_Status_State
integer or null <int32> 
Member's filing status for state taxes as listed on the Member's tax documents.


 
flat_Tax
number or null <double> 
Member's federal flat tax amount as listed on the Member's tax documents.


 
flat_Tax_State
number or null <double> 
Member's state flat tax amount as listed on the Member's tax documents.


 
gross_Salary
number or null <double> 
Member's gross salary as listed on the Member's tax documents.


 
hours_Worked
number or null <double> 
Number of hours the Member worked at the specified frequency as listed on the Member's tax documents.


 
hours_Worked_Frequency
string or null  <= 1 characters 
Frequency at which the Member worked the specified number of hours as listed on the Member's tax documents.


 
local_Tax_Code
string or null  <= 128 characters 
Member's local tax code as listed on the Member's tax documents.


 
medicare_Tax_Exempt
required
boolean
Member's medicare exemption status as listed on the Member's tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
member_Seq
string or null  <= 2 characters 
References Members.Member_Seq value on the parent record.


 
miscellaneous
number or null <double> 
Member's miscellaneous amounts as listed on the Member's tax documents.


 
net_Salary
number or null <double> 
Member's net salary as listed on the Member's tax documents.


 
other_Income_Amt
number or null <double> 
Member's other income amount as listed on the Member's tax documents.


 
percentage_Election
number or null <double> 
Member's election percentage at the federal level as listed on the Member's tax documents.


 
socSec_Tax_Exempt
required
boolean
Member's social security exemption status as listed on the Member's tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
state_Percentage_Election
required
boolean
Member's election percentage at the state level as listed on the Member's tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
state_Tax_Exempt
required
boolean
Member's tax exemption status as listed on the Member's tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
state_Withholding
number or null <double> 
Holds a numeric value listed as withholding, used in conjunction with Tax Control.


 
subscriber_ID
string or null  <= 9 characters 
References Members.Subscriber_ID value on the parent record.


 
tax_Exempt
required
boolean
Member's exemption status as listed on the Member's tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
tips
number or null <double> 
Member's amount of tips as listed on the Member's tax documents.


 
update_Date
string <date-time> 
Date when the record was last updated in the system.


 
update_User
string or null  <= 20 characters 
User that last updated the record in the system.


 
w4_2020
required
boolean
Specifies that the associated W4 is from 2020. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
w4_Box_C
required
boolean
Specifies whether Box C was checked according to the Member's tax documents. Note: This field is marked as NOT NULL in the database and therefore required by the API.


 
Responses 
207
Success


401
Unauthorized


put/subscribers/{subscriberID}/members/{memberSeq}/taxes-batch
Request samples 
[
  • {
    }
]
Response samples 
{
  • "data": [
    ],
  • "error": {
    },
  • "debug": {
    }
}