GET api/TaxAssistances

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of TaxAssistance
NameDescriptionTypeAdditional information
AuthorizationID

string

Required

String length: inclusive between 0 and 20

Initiation

date

None.

MoveMiles

decimal number

None.

TempLivingBegin

date

None.

TempLivingEnd

date

None.

Effective

date

None.

Cancelled

date

None.

MoveType

string

String length: inclusive between 0 and 20

MoveReason

string

String length: inclusive between 0 and 20

YearendTaxPolicy

string

String length: inclusive between 0 and 35

TaxPolicyID

integer

None.

MoveComplete

date

None.

ExceptionPolicy

string

String length: inclusive between 0 and 25

FilingStatus

integer

None.

FederalWages

decimal number

None.

OtherWages

decimal number

None.

RetirementWages

decimal number

None.

MedicareWages

decimal number

None.

LocalWages

decimal number

None.

PayrollWages

decimal number

None.

FromStWages

decimal number

None.

ToStWages

decimal number

None.

ToState

string

String length: inclusive between 0 and 5

FromState

string

String length: inclusive between 0 and 5

WorkState

string

String length: inclusive between 0 and 5

FederalExemptions

integer

None.

FederalDependents

integer

None.

Children

integer

None.

TaxYear

integer

None.

ItemizeType

integer

None.

ItemizeAmount

decimal number

None.

localCode1

string

String length: inclusive between 0 and 15

localCode2

string

String length: inclusive between 0 and 15

localCode3

string

String length: inclusive between 0 and 15

localCode4

string

String length: inclusive between 0 and 15

localCode5

string

String length: inclusive between 0 and 15

ToStateEffective

date

None.

Taxable

decimal number

None.

Excludable

decimal number

None.

OtherNonGup

decimal number

None.

FicaOnly

decimal number

None.

EmployeePayments

decimal number

None.

VendorPayments

decimal number

None.

VendorExcludable

decimal number

None.

HHGVendor

string

String length: inclusive between 0 and 50

ThirdPartyVendor

string

String length: inclusive between 0 and 50

HomeFindingVendor

string

String length: inclusive between 0 and 50

MiscVendor

string

String length: inclusive between 0 and 50

UserField1

string

String length: inclusive between 0 and 50

UserField2

string

String length: inclusive between 0 and 50

UserField3

string

String length: inclusive between 0 and 50

UserField4

string

String length: inclusive between 0 and 50

UserField5

string

String length: inclusive between 0 and 50

UserField6

string

String length: inclusive between 0 and 50

UserField7

string

String length: inclusive between 0 and 50

UserField8

string

String length: inclusive between 0 and 50

UserField9

string

String length: inclusive between 0 and 50

UserField10

string

String length: inclusive between 0 and 50

UserField11

string

String length: inclusive between 0 and 50

UserField12

string

String length: inclusive between 0 and 50

UserField13

string

String length: inclusive between 0 and 50

UserField14

string

String length: inclusive between 0 and 50

UserField15

string

String length: inclusive between 0 and 50

UserField16

string

String length: inclusive between 0 and 50

UserField17

string

String length: inclusive between 0 and 50

UserField18

string

String length: inclusive between 0 and 50

UserField19

string

String length: inclusive between 0 and 50

UserField20

string

String length: inclusive between 0 and 50

NonUsPayroll

string

String length: inclusive between 0 and 5

TotBudget1

decimal number

None.

TotBudget2

decimal number

None.

TotBudget3

decimal number

None.

TotBudget4

decimal number

None.

TotBudget5

decimal number

None.

TotBudget6

decimal number

None.

TotBudget7

decimal number

None.

TotBudget8

decimal number

None.

TotBudget9

decimal number

None.

TotBudget10

decimal number

None.

TotBudget11

decimal number

None.

TotBudget12

decimal number

None.

TotBudget13

decimal number

None.

TotBudget14

decimal number

None.

TotBudget15

decimal number

None.

TotBudget16

decimal number

None.

TotBudget17

decimal number

None.

TotBudget18

decimal number

None.

TotBudget19

decimal number

None.

TotBudget20

decimal number

None.

GrandTotBudget

decimal number

None.

TotOrigBud

decimal number

None.

TotAdjustBud

decimal number

None.

TotFinalBud

decimal number

None.

TotBudget21

decimal number

None.

TotBudget22

decimal number

None.

TotBudget23

decimal number

None.

TotBudget24

decimal number

None.

TotBudget25

decimal number

None.

TotBudget26

decimal number

None.

TotBudget27

decimal number

None.

TotBudget28

decimal number

None.

TotBudget29

decimal number

None.

TotBudget30

decimal number

None.

TotBudget31

decimal number

None.

TotBudget32

decimal number

None.

TotBudget33

decimal number

None.

TotBudget34

decimal number

None.

TotBudget35

decimal number

None.

TotBudget36

decimal number

None.

TotBudget37

decimal number

None.

TotBudget38

decimal number

None.

TotBudget39

decimal number

None.

TotBudget40

decimal number

None.

AltPolicyDateBeg

date

None.

AltPolicyDateEnd

date

None.

AltPolicyID

integer

None.

AltPolicyDesc

string

String length: inclusive between 0 and 50

AltYearEndPolicyID

integer

None.

AltYearEndPolicyDesc

string

String length: inclusive between 0 and 50

RitAppliedDate

date

None.

RitOverrideState

decimal number

None.

HBUseCredit

integer

None.

HBTypeBuyer

integer

None.

HBPurchasePrice

decimal number

None.

HBPurchaseDate

date

None.

HBFamilyIncome

decimal number

None.

PayrollHoldUntil

date

None.

ShortTermAssignment

string

String length: inclusive between 0 and 1

FedOverrideRate

decimal number

None.

StateOverrideRate

decimal number

None.

LocalWages2

decimal number

None.

LocalWages3

decimal number

None.

LocalWages4

decimal number

None.

LocalWages5

decimal number

None.

AltFederalWages

decimal number

None.

PayrollLocalCode1

string

String length: inclusive between 0 and 50

PayrollLocalCode2

string

String length: inclusive between 0 and 50

PayrollLocalCode3

string

String length: inclusive between 0 and 50

PayrollLocalCode4

string

String length: inclusive between 0 and 50

PayrollLocalCode5

string

String length: inclusive between 0 and 50

PayPeriodProcessingGroup

string

String length: inclusive between 0 and 100

ShorttermAssignmentChanged

string

String length: inclusive between 0 and 1

CanEiWages

decimal number

None.

CanEiRespreadWages

decimal number

None.

ID

integer

None.

TaxProfileSubmitDate

date

None.

STAssignmentChanged

date

None.

Item

Object

None.

Response Formats

application/json, text/json

Sample:
[
  null,
  {
    "AuthorizationID": "sample string 1",
    "Initiation": "2025-05-09T17:52:28.3757487+00:00",
    "MoveMiles": 1.1,
    "TempLivingBegin": "2025-05-09T17:52:28.3757487+00:00",
    "TempLivingEnd": "2025-05-09T17:52:28.3757487+00:00",
    "Effective": "2025-05-09T17:52:28.3757487+00:00",
    "Cancelled": "2025-05-09T17:52:28.3757487+00:00",
    "MoveType": "sample string 2",
    "MoveReason": "sample string 3",
    "YearendTaxPolicy": "sample string 4",
    "TaxPolicyID": 1,
    "MoveComplete": "2025-05-09T17:52:28.3757487+00:00",
    "ExceptionPolicy": "sample string 5",
    "FilingStatus": 1,
    "FederalWages": 1.0,
    "OtherWages": 1.0,
    "RetirementWages": 1.0,
    "MedicareWages": 1.0,
    "LocalWages": 1.0,
    "PayrollWages": 1.0,
    "FromStWages": 1.0,
    "ToStWages": 1.0,
    "ToState": "sample string 6",
    "FromState": "sample string 7",
    "WorkState": "sample string 8",
    "FederalExemptions": 1,
    "FederalDependents": 1,
    "Children": 1,
    "TaxYear": 1,
    "ItemizeType": 1,
    "ItemizeAmount": 1.0,
    "localCode1": "sample string 9",
    "localCode2": "sample string 10",
    "localCode3": "sample string 11",
    "localCode4": "sample string 12",
    "localCode5": "sample string 13",
    "ToStateEffective": "2025-05-09T17:52:28.3757487+00:00",
    "Taxable": 1.0,
    "Excludable": 1.0,
    "OtherNonGup": 1.0,
    "FicaOnly": 1.0,
    "EmployeePayments": 1.0,
    "VendorPayments": 1.0,
    "VendorExcludable": 1.0,
    "HHGVendor": "sample string 14",
    "ThirdPartyVendor": "sample string 15",
    "HomeFindingVendor": "sample string 16",
    "MiscVendor": "sample string 17",
    "UserField1": "sample string 18",
    "UserField2": "sample string 19",
    "UserField3": "sample string 20",
    "UserField4": "sample string 21",
    "UserField5": "sample string 22",
    "UserField6": "sample string 23",
    "UserField7": "sample string 24",
    "UserField8": "sample string 25",
    "UserField9": "sample string 26",
    "UserField10": "sample string 27",
    "UserField11": "sample string 28",
    "UserField12": "sample string 29",
    "UserField13": "sample string 30",
    "UserField14": "sample string 31",
    "UserField15": "sample string 32",
    "UserField16": "sample string 33",
    "UserField17": "sample string 34",
    "UserField18": "sample string 35",
    "UserField19": "sample string 36",
    "UserField20": "sample string 37",
    "NonUsPayroll": "sample string 38",
    "TotBudget1": 1.0,
    "TotBudget2": 1.0,
    "TotBudget3": 1.0,
    "TotBudget4": 1.0,
    "TotBudget5": 1.0,
    "TotBudget6": 1.0,
    "TotBudget7": 1.0,
    "TotBudget8": 1.0,
    "TotBudget9": 1.0,
    "TotBudget10": 1.0,
    "TotBudget11": 1.0,
    "TotBudget12": 1.0,
    "TotBudget13": 1.0,
    "TotBudget14": 1.0,
    "TotBudget15": 1.0,
    "TotBudget16": 1.0,
    "TotBudget17": 1.0,
    "TotBudget18": 1.0,
    "TotBudget19": 1.0,
    "TotBudget20": 1.0,
    "GrandTotBudget": 1.0,
    "TotOrigBud": 1.0,
    "TotAdjustBud": 1.0,
    "TotFinalBud": 1.0,
    "TotBudget21": 1.0,
    "TotBudget22": 1.0,
    "TotBudget23": 1.0,
    "TotBudget24": 1.0,
    "TotBudget25": 1.0,
    "TotBudget26": 1.0,
    "TotBudget27": 1.0,
    "TotBudget28": 1.0,
    "TotBudget29": 1.0,
    "TotBudget30": 1.0,
    "TotBudget31": 1.0,
    "TotBudget32": 1.0,
    "TotBudget33": 1.0,
    "TotBudget34": 1.0,
    "TotBudget35": 1.0,
    "TotBudget36": 1.0,
    "TotBudget37": 1.0,
    "TotBudget38": 1.0,
    "TotBudget39": 1.0,
    "TotBudget40": 1.0,
    "AltPolicyDateBeg": "2025-05-09T17:52:28.3757487+00:00",
    "AltPolicyDateEnd": "2025-05-09T17:52:28.3757487+00:00",
    "AltPolicyID": 1,
    "AltPolicyDesc": "sample string 39",
    "AltYearEndPolicyID": 1,
    "AltYearEndPolicyDesc": "sample string 40",
    "RitAppliedDate": "2025-05-09T17:52:28.3757487+00:00",
    "RitOverrideState": 1.1,
    "HBUseCredit": 1,
    "HBTypeBuyer": 1,
    "HBPurchasePrice": 1.0,
    "HBPurchaseDate": "2025-05-09T17:52:28.3757487+00:00",
    "HBFamilyIncome": 1.0,
    "PayrollHoldUntil": "2025-05-09T17:52:28.3757487+00:00",
    "ShortTermAssignment": "sample string 41",
    "FedOverrideRate": 1.1,
    "StateOverrideRate": 1.1,
    "LocalWages2": 1.0,
    "LocalWages3": 1.0,
    "LocalWages4": 1.0,
    "LocalWages5": 1.0,
    "AltFederalWages": 1.0,
    "PayrollLocalCode1": "sample string 42",
    "PayrollLocalCode2": "sample string 43",
    "PayrollLocalCode3": "sample string 44",
    "PayrollLocalCode4": "sample string 45",
    "PayrollLocalCode5": "sample string 46",
    "PayPeriodProcessingGroup": "sample string 47",
    "ShorttermAssignmentChanged": "sample string 48",
    "CanEiWages": 1.0,
    "CanEiRespreadWages": 1.0,
    "ID": 49,
    "TaxProfileSubmitDate": "2025-05-09T17:52:28.3757487+00:00",
    "STAssignmentChanged": "2025-05-09T17:52:28.3757487+00:00"
  }
]

application/xml, text/xml

Sample:
<ArrayOfTaxAssistance xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fabric">
  <TaxAssistance i:nil="true" />
  <TaxAssistance>
    <AltFederalWages>1</AltFederalWages>
    <AltPolicyDateBeg>2025-05-09T17:52:28.3757487+00:00</AltPolicyDateBeg>
    <AltPolicyDateEnd>2025-05-09T17:52:28.3757487+00:00</AltPolicyDateEnd>
    <AltPolicyDesc>sample string 39</AltPolicyDesc>
    <AltPolicyID>1</AltPolicyID>
    <AltYearEndPolicyDesc>sample string 40</AltYearEndPolicyDesc>
    <AltYearEndPolicyID>1</AltYearEndPolicyID>
    <AuthorizationID>sample string 1</AuthorizationID>
    <CanEiRespreadWages>1</CanEiRespreadWages>
    <CanEiWages>1</CanEiWages>
    <Cancelled>2025-05-09T17:52:28.3757487+00:00</Cancelled>
    <Children>1</Children>
    <Effective>2025-05-09T17:52:28.3757487+00:00</Effective>
    <EmployeePayments>1</EmployeePayments>
    <ExceptionPolicy>sample string 5</ExceptionPolicy>
    <Excludable>1</Excludable>
    <FedOverrideRate>1.1</FedOverrideRate>
    <FederalDependents>1</FederalDependents>
    <FederalExemptions>1</FederalExemptions>
    <FederalWages>1</FederalWages>
    <FicaOnly>1</FicaOnly>
    <FilingStatus>1</FilingStatus>
    <FromStWages>1</FromStWages>
    <FromState>sample string 7</FromState>
    <GrandTotBudget>1</GrandTotBudget>
    <HBFamilyIncome>1</HBFamilyIncome>
    <HBPurchaseDate>2025-05-09T17:52:28.3757487+00:00</HBPurchaseDate>
    <HBPurchasePrice>1</HBPurchasePrice>
    <HBTypeBuyer>1</HBTypeBuyer>
    <HBUseCredit>1</HBUseCredit>
    <HHGVendor>sample string 14</HHGVendor>
    <HomeFindingVendor>sample string 16</HomeFindingVendor>
    <ID>49</ID>
    <Initiation>2025-05-09T17:52:28.3757487+00:00</Initiation>
    <ItemizeAmount>1</ItemizeAmount>
    <ItemizeType>1</ItemizeType>
    <LocalWages>1</LocalWages>
    <LocalWages2>1</LocalWages2>
    <LocalWages3>1</LocalWages3>
    <LocalWages4>1</LocalWages4>
    <LocalWages5>1</LocalWages5>
    <MedicareWages>1</MedicareWages>
    <MiscVendor>sample string 17</MiscVendor>
    <MoveComplete>2025-05-09T17:52:28.3757487+00:00</MoveComplete>
    <MoveMiles>1.1</MoveMiles>
    <MoveReason>sample string 3</MoveReason>
    <MoveType>sample string 2</MoveType>
    <NonUsPayroll>sample string 38</NonUsPayroll>
    <OtherNonGup>1</OtherNonGup>
    <OtherWages>1</OtherWages>
    <PayPeriodProcessingGroup>sample string 47</PayPeriodProcessingGroup>
    <PayrollHoldUntil>2025-05-09T17:52:28.3757487+00:00</PayrollHoldUntil>
    <PayrollLocalCode1>sample string 42</PayrollLocalCode1>
    <PayrollLocalCode2>sample string 43</PayrollLocalCode2>
    <PayrollLocalCode3>sample string 44</PayrollLocalCode3>
    <PayrollLocalCode4>sample string 45</PayrollLocalCode4>
    <PayrollLocalCode5>sample string 46</PayrollLocalCode5>
    <PayrollWages>1</PayrollWages>
    <RetirementWages>1</RetirementWages>
    <RitAppliedDate>2025-05-09T17:52:28.3757487+00:00</RitAppliedDate>
    <RitOverrideState>1.1</RitOverrideState>
    <STAssignmentChanged>2025-05-09T17:52:28.3757487+00:00</STAssignmentChanged>
    <ShortTermAssignment>sample string 41</ShortTermAssignment>
    <ShorttermAssignmentChanged>sample string 48</ShorttermAssignmentChanged>
    <StateOverrideRate>1.1</StateOverrideRate>
    <TaxPolicyID>1</TaxPolicyID>
    <TaxProfileSubmitDate>2025-05-09T17:52:28.3757487+00:00</TaxProfileSubmitDate>
    <TaxYear>1</TaxYear>
    <Taxable>1</Taxable>
    <TempLivingBegin>2025-05-09T17:52:28.3757487+00:00</TempLivingBegin>
    <TempLivingEnd>2025-05-09T17:52:28.3757487+00:00</TempLivingEnd>
    <ThirdPartyVendor>sample string 15</ThirdPartyVendor>
    <ToStWages>1</ToStWages>
    <ToState>sample string 6</ToState>
    <ToStateEffective>2025-05-09T17:52:28.3757487+00:00</ToStateEffective>
    <TotAdjustBud>1</TotAdjustBud>
    <TotBudget1>1</TotBudget1>
    <TotBudget10>1</TotBudget10>
    <TotBudget11>1</TotBudget11>
    <TotBudget12>1</TotBudget12>
    <TotBudget13>1</TotBudget13>
    <TotBudget14>1</TotBudget14>
    <TotBudget15>1</TotBudget15>
    <TotBudget16>1</TotBudget16>
    <TotBudget17>1</TotBudget17>
    <TotBudget18>1</TotBudget18>
    <TotBudget19>1</TotBudget19>
    <TotBudget2>1</TotBudget2>
    <TotBudget20>1</TotBudget20>
    <TotBudget21>1</TotBudget21>
    <TotBudget22>1</TotBudget22>
    <TotBudget23>1</TotBudget23>
    <TotBudget24>1</TotBudget24>
    <TotBudget25>1</TotBudget25>
    <TotBudget26>1</TotBudget26>
    <TotBudget27>1</TotBudget27>
    <TotBudget28>1</TotBudget28>
    <TotBudget29>1</TotBudget29>
    <TotBudget3>1</TotBudget3>
    <TotBudget30>1</TotBudget30>
    <TotBudget31>1</TotBudget31>
    <TotBudget32>1</TotBudget32>
    <TotBudget33>1</TotBudget33>
    <TotBudget34>1</TotBudget34>
    <TotBudget35>1</TotBudget35>
    <TotBudget36>1</TotBudget36>
    <TotBudget37>1</TotBudget37>
    <TotBudget38>1</TotBudget38>
    <TotBudget39>1</TotBudget39>
    <TotBudget4>1</TotBudget4>
    <TotBudget40>1</TotBudget40>
    <TotBudget5>1</TotBudget5>
    <TotBudget6>1</TotBudget6>
    <TotBudget7>1</TotBudget7>
    <TotBudget8>1</TotBudget8>
    <TotBudget9>1</TotBudget9>
    <TotFinalBud>1</TotFinalBud>
    <TotOrigBud>1</TotOrigBud>
    <UserField1>sample string 18</UserField1>
    <UserField10>sample string 27</UserField10>
    <UserField11>sample string 28</UserField11>
    <UserField12>sample string 29</UserField12>
    <UserField13>sample string 30</UserField13>
    <UserField14>sample string 31</UserField14>
    <UserField15>sample string 32</UserField15>
    <UserField16>sample string 33</UserField16>
    <UserField17>sample string 34</UserField17>
    <UserField18>sample string 35</UserField18>
    <UserField19>sample string 36</UserField19>
    <UserField2>sample string 19</UserField2>
    <UserField20>sample string 37</UserField20>
    <UserField3>sample string 20</UserField3>
    <UserField4>sample string 21</UserField4>
    <UserField5>sample string 22</UserField5>
    <UserField6>sample string 23</UserField6>
    <UserField7>sample string 24</UserField7>
    <UserField8>sample string 25</UserField8>
    <UserField9>sample string 26</UserField9>
    <VendorExcludable>1</VendorExcludable>
    <VendorPayments>1</VendorPayments>
    <WorkState>sample string 8</WorkState>
    <YearendTaxPolicy>sample string 4</YearendTaxPolicy>
    <localCode1>sample string 9</localCode1>
    <localCode2>sample string 10</localCode2>
    <localCode3>sample string 11</localCode3>
    <localCode4>sample string 12</localCode4>
    <localCode5>sample string 13</localCode5>
  </TaxAssistance>
</ArrayOfTaxAssistance>