POST api/Customer/GetCustomerFundingInfo?ssn={ssn}&birthDate={birthDate}

Get customer's funding and disbursement information by ssn and birthDate.

Request Information

URI Parameters

Name	Description	Type	Additional information
ssn	Customer's 9 digit social security number [123456789].	string	Required
birthDate	Customer's date of birth [yyyy-dd-mm] or [dd/mm/yyyy]	string	Required

Body Parameters

None.

Response Information

Resource Description

Returns customer's funding and disbursement information by tax year.

Customer

Name	Description	Type	Additional information
IsValidCustomer	True or False - indicates if JTH received an application submitted in the current year for the customer.	boolean	None.
IsMultiTaxYear	True or False - indicates if JTH has received application for one or multiple tax years for the customer.	boolean	None.
TaxYears	TaxYears for the customer.	Collection of TaxYear	None.

Response Formats

application/xml

Sample:

<Customer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Web.IVR.BusinessLogic.Models">
  <IsMultiTaxYear>false</IsMultiTaxYear>
  <IsValidCustomer>true</IsValidCustomer>
  <TaxYears>
    <TaxYear>
      <Fundings>
        <Funding>
          <Amount>5554.0000</Amount>
          <Disbursements>
            <Disbursement>
              <Amount>5314.0500</Amount>
              <DisbursementType>Check</DisbursementType>
              <IsCustomerDisbursement>true</IsCustomerDisbursement>
            </Disbursement>
            <Disbursement>
              <Amount>39.9500</Amount>
              <DisbursementType>Account handling fee</DisbursementType>
              <IsCustomerDisbursement>false</IsCustomerDisbursement>
            </Disbursement>
            <Disbursement>
              <Amount>200.0000</Amount>
              <DisbursementType>Tax preparation fee</DisbursementType>
              <IsCustomerDisbursement>false</IsCustomerDisbursement>
            </Disbursement>
          </Disbursements>
          <FundingSource>IRS</FundingSource>
        </Funding>
      </Fundings>
      <Value>2014</Value>
    </TaxYear>
  </TaxYears>
</Customer>

application/json

Sample:

{
    "IsValidCustomer": true,
    "IsMultiTaxYear": false,
    "TaxYears": [
        {
            "Value": 2014,
            "Fundings": [
                {
                    "FundingSource": "IRS",
                    "Amount": 5554.0000,
                    "Disbursements": [
                        {
                            "IsCustomerDisbursement": true,
                            "DisbursementType": "Check",
                            "Amount": 5314.0500
                        },
                        {
                            "IsCustomerDisbursement": false,
                            "DisbursementType": "Account handling fee",
                            "Amount": 39.9500
                        },
                        {
                            "IsCustomerDisbursement": false,
                            "DisbursementType": "Tax preparation fee",
                            "Amount": 200.0000
                        }
                    ]
                }
            ]
        }
    ]
}

text/xml

Sample:

See application/xml sample.

text/json

Sample:

See application/json sample.