POST api/ui/customerclaim/sendconfirmation

Request Information

URI Parameters

None.

Body Parameters

ClaimCustomer
NameDescriptionTypeAdditional information
ClaimId

integer

None.

CustomerId

integer

None.

IndustryId

integer

None.

OccupationId

integer

None.

OtherExpenses

decimal number

None.

TaxYearIds

Collection of integer

None.

Title

string

None.

FirstName

string

None.

Surname

string

None.

Email

string

None.

DateOfBirth

date

None.

Address1

string

None.

Address2

string

None.

Address3

string

None.

County

string

None.

Postcode

string

None.

NI

string

None.

Phone

string

None.

UserId

string

None.

ClaimStatus

integer

None.

ThirdPtyPermission

boolean

None.

BrandId

integer

None.

Source

string

None.

Employer

string

None.

Job

string

None.

IPAddress

string

None.

MaxRefund

decimal number

None.

AverageRefund

decimal number

None.

AnnualRefund

decimal number

None.

EstimatedClaim

decimal number

None.

Married

boolean

None.

AcceptedTerms

boolean

None.

selfAssessed

boolean

None.

emailConfirm

string

None.

niConfirm

string

None.

energyOptin

boolean

None.

ClaimGenericReference

string

None.

NonUK

boolean

None.

Nationality

string

None.

NoObligationPostalQuote

boolean

None.

PostForms

boolean

None.

UniformBenefitsSignUpCompleted

boolean

None.

DateStamp

date

None.

IsRepeatCustomer

boolean

None.

SignaturePoints

string

None.

SignatureSVG

string

None.

SourceBrandId

integer

None.

CollectEmploymentHistory

boolean

None.

AWC

string

None.

EmploymentRecords

Collection of EmploymentRecordSerializable

None.

Subscriptions

Collection of Subscription

None.

Expenses

Collection of Subscription

None.

TrustPilotSiteUrl

string

None.

Email_DidYouMean

string

None.

ClaimedBefore

boolean

None.

EarnMoreThanMonthlyThreshold

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "ClaimId": 1,
  "CustomerId": 2,
  "IndustryId": 3,
  "OccupationId": 4,
  "OtherExpenses": 5.0,
  "TaxYearIds": [
    1,
    2
  ],
  "Title": "sample string 6",
  "FirstName": "sample string 7",
  "Surname": "sample string 8",
  "Email": "sample string 9",
  "DateOfBirth": "2019-10-21T08:55:06.7887705",
  "Address1": "sample string 10",
  "Address2": "sample string 11",
  "Address3": "sample string 12",
  "County": "sample string 13",
  "Postcode": "sample string 14",
  "NI": "sample string 15",
  "Phone": "sample string 16",
  "UserId": "sample string 17",
  "ClaimStatus": 18,
  "ThirdPtyPermission": true,
  "BrandId": 19,
  "Source": "sample string 20",
  "Employer": "sample string 21",
  "Job": "sample string 22",
  "IPAddress": "sample string 23",
  "MaxRefund": 24.0,
  "AverageRefund": 25.0,
  "AnnualRefund": 26.0,
  "EstimatedClaim": 27.0,
  "Married": true,
  "AcceptedTerms": true,
  "selfAssessed": true,
  "emailConfirm": "sample string 28",
  "niConfirm": "sample string 29",
  "energyOptin": true,
  "ClaimGenericReference": "sample string 30",
  "NonUK": true,
  "Nationality": "sample string 32",
  "NoObligationPostalQuote": true,
  "PostForms": true,
  "UniformBenefitsSignUpCompleted": true,
  "DateStamp": "2019-10-21T08:55:06.7887705",
  "IsRepeatCustomer": true,
  "SignaturePoints": "sample string 36",
  "SignatureSVG": "sample string 37",
  "SourceBrandId": 38,
  "CollectEmploymentHistory": true,
  "AWC": "sample string 40",
  "EmploymentRecords": [
    {
      "EmploymentId": 1,
      "EmployerName": "sample string 2",
      "JobTitle": "sample string 3",
      "Started": "2019-10-21T08:55:06.7887705",
      "Finished": "2019-10-21T08:55:06.7887705",
      "Uniformed": true,
      "Started_Month": 1,
      "Started_Year": 1,
      "Finished_Month": 1,
      "Finished_Year": 1
    },
    {
      "EmploymentId": 1,
      "EmployerName": "sample string 2",
      "JobTitle": "sample string 3",
      "Started": "2019-10-21T08:55:06.7887705",
      "Finished": "2019-10-21T08:55:06.7887705",
      "Uniformed": true,
      "Started_Month": 1,
      "Started_Year": 1,
      "Finished_Month": 1,
      "Finished_Year": 1
    }
  ],
  "Subscriptions": [
    {
      "OccupationSubscriptionId": 1,
      "Years": [
        {
          "SubscriptionId": 1,
          "TaxYearId": 1,
          "Amount": 1.0,
          "Name": "sample string 2"
        },
        {
          "SubscriptionId": 1,
          "TaxYearId": 1,
          "Amount": 1.0,
          "Name": "sample string 2"
        }
      ],
      "Name": "sample string 2",
      "Enabled": true
    },
    {
      "OccupationSubscriptionId": 1,
      "Years": [
        {
          "SubscriptionId": 1,
          "TaxYearId": 1,
          "Amount": 1.0,
          "Name": "sample string 2"
        },
        {
          "SubscriptionId": 1,
          "TaxYearId": 1,
          "Amount": 1.0,
          "Name": "sample string 2"
        }
      ],
      "Name": "sample string 2",
      "Enabled": true
    }
  ],
  "Expenses": [
    {
      "OccupationSubscriptionId": 1,
      "Years": [
        {
          "SubscriptionId": 1,
          "TaxYearId": 1,
          "Amount": 1.0,
          "Name": "sample string 2"
        },
        {
          "SubscriptionId": 1,
          "TaxYearId": 1,
          "Amount": 1.0,
          "Name": "sample string 2"
        }
      ],
      "Name": "sample string 2",
      "Enabled": true
    },
    {
      "OccupationSubscriptionId": 1,
      "Years": [
        {
          "SubscriptionId": 1,
          "TaxYearId": 1,
          "Amount": 1.0,
          "Name": "sample string 2"
        },
        {
          "SubscriptionId": 1,
          "TaxYearId": 1,
          "Amount": 1.0,
          "Name": "sample string 2"
        }
      ],
      "Name": "sample string 2",
      "Enabled": true
    }
  ],
  "TrustPilotSiteUrl": "sample string 41",
  "Email_DidYouMean": "sample string 42",
  "ClaimedBefore": true,
  "EarnMoreThanMonthlyThreshold": true
}

application/xml, text/xml

Sample:
<ClaimCustomer xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TaxRebate.TaxRefunds">
  <AWC>sample string 40</AWC>
  <AcceptedTerms>true</AcceptedTerms>
  <Address1>sample string 10</Address1>
  <Address2>sample string 11</Address2>
  <Address3>sample string 12</Address3>
  <AnnualRefund>26</AnnualRefund>
  <AverageRefund>25</AverageRefund>
  <BrandId>19</BrandId>
  <ClaimGenericReference>sample string 30</ClaimGenericReference>
  <ClaimId>1</ClaimId>
  <ClaimStatus>18</ClaimStatus>
  <ClaimedBefore>true</ClaimedBefore>
  <CollectEmploymentHistory>true</CollectEmploymentHistory>
  <County>sample string 13</County>
  <CustomerId>2</CustomerId>
  <DateOfBirth>2019-10-21T08:55:06.7887705+01:00</DateOfBirth>
  <DateStamp>2019-10-21T08:55:06.7887705+01:00</DateStamp>
  <EarnMoreThanMonthlyThreshold>true</EarnMoreThanMonthlyThreshold>
  <Email>sample string 9</Email>
  <Email_DidYouMean>sample string 42</Email_DidYouMean>
  <Employer>sample string 21</Employer>
  <EmploymentDataRecords xmlns:d2p1="http://schemas.datacontract.org/2004/07/TaxRebate.TaxRefunds.Data">
    <d2p1:EmploymentRecord>
      <d2p1:Claim i:nil="true" />
      <d2p1:ClaimId>0</d2p1:ClaimId>
      <d2p1:EmployerName>sample string 2</d2p1:EmployerName>
      <d2p1:EmploymentId>1</d2p1:EmploymentId>
      <d2p1:Finished>2019-10-21T08:55:06.7887705+01:00</d2p1:Finished>
      <d2p1:JobTitle>sample string 3</d2p1:JobTitle>
      <d2p1:Started>2019-10-21T08:55:06.7887705+01:00</d2p1:Started>
      <d2p1:Uniformed>true</d2p1:Uniformed>
    </d2p1:EmploymentRecord>
    <d2p1:EmploymentRecord>
      <d2p1:Claim i:nil="true" />
      <d2p1:ClaimId>0</d2p1:ClaimId>
      <d2p1:EmployerName>sample string 2</d2p1:EmployerName>
      <d2p1:EmploymentId>1</d2p1:EmploymentId>
      <d2p1:Finished>2019-10-21T08:55:06.7887705+01:00</d2p1:Finished>
      <d2p1:JobTitle>sample string 3</d2p1:JobTitle>
      <d2p1:Started>2019-10-21T08:55:06.7887705+01:00</d2p1:Started>
      <d2p1:Uniformed>true</d2p1:Uniformed>
    </d2p1:EmploymentRecord>
  </EmploymentDataRecords>
  <EmploymentRecords>
    <EmploymentRecordSerializable>
      <EmployerName>sample string 2</EmployerName>
      <EmploymentId>1</EmploymentId>
      <Finished>2019-10-21T08:55:06.7887705+01:00</Finished>
      <Finished_Month>1</Finished_Month>
      <Finished_Year>1</Finished_Year>
      <JobTitle>sample string 3</JobTitle>
      <Started>2019-10-21T08:55:06.7887705+01:00</Started>
      <Started_Month>1</Started_Month>
      <Started_Year>1</Started_Year>
      <Uniformed>true</Uniformed>
    </EmploymentRecordSerializable>
    <EmploymentRecordSerializable>
      <EmployerName>sample string 2</EmployerName>
      <EmploymentId>1</EmploymentId>
      <Finished>2019-10-21T08:55:06.7887705+01:00</Finished>
      <Finished_Month>1</Finished_Month>
      <Finished_Year>1</Finished_Year>
      <JobTitle>sample string 3</JobTitle>
      <Started>2019-10-21T08:55:06.7887705+01:00</Started>
      <Started_Month>1</Started_Month>
      <Started_Year>1</Started_Year>
      <Uniformed>true</Uniformed>
    </EmploymentRecordSerializable>
  </EmploymentRecords>
  <EstimatedClaim>27</EstimatedClaim>
  <Expenses>
    <Subscription>
      <Enabled>true</Enabled>
      <Name>sample string 2</Name>
      <OccupationSubscriptionId>1</OccupationSubscriptionId>
      <Years>
        <SubscriptionYear>
          <Amount>1</Amount>
          <Name>sample string 2</Name>
          <SubscriptionId>1</SubscriptionId>
          <TaxYearId>1</TaxYearId>
        </SubscriptionYear>
        <SubscriptionYear>
          <Amount>1</Amount>
          <Name>sample string 2</Name>
          <SubscriptionId>1</SubscriptionId>
          <TaxYearId>1</TaxYearId>
        </SubscriptionYear>
      </Years>
    </Subscription>
    <Subscription>
      <Enabled>true</Enabled>
      <Name>sample string 2</Name>
      <OccupationSubscriptionId>1</OccupationSubscriptionId>
      <Years>
        <SubscriptionYear>
          <Amount>1</Amount>
          <Name>sample string 2</Name>
          <SubscriptionId>1</SubscriptionId>
          <TaxYearId>1</TaxYearId>
        </SubscriptionYear>
        <SubscriptionYear>
          <Amount>1</Amount>
          <Name>sample string 2</Name>
          <SubscriptionId>1</SubscriptionId>
          <TaxYearId>1</TaxYearId>
        </SubscriptionYear>
      </Years>
    </Subscription>
  </Expenses>
  <FirstName>sample string 7</FirstName>
  <IPAddress>sample string 23</IPAddress>
  <IndustryId>3</IndustryId>
  <IsRepeatCustomer>true</IsRepeatCustomer>
  <Job>sample string 22</Job>
  <Married>true</Married>
  <MaxRefund>24</MaxRefund>
  <NI>sample string 15</NI>
  <Nationality>sample string 32</Nationality>
  <NoObligationPostalQuote>true</NoObligationPostalQuote>
  <NonUK>true</NonUK>
  <OccupationId>4</OccupationId>
  <OtherExpenses>5</OtherExpenses>
  <Phone>sample string 16</Phone>
  <PostForms>true</PostForms>
  <Postcode>sample string 14</Postcode>
  <SignaturePoints>sample string 36</SignaturePoints>
  <SignatureSVG>sample string 37</SignatureSVG>
  <Source>sample string 20</Source>
  <SourceBrandId>38</SourceBrandId>
  <Subscriptions>
    <Subscription>
      <Enabled>true</Enabled>
      <Name>sample string 2</Name>
      <OccupationSubscriptionId>1</OccupationSubscriptionId>
      <Years>
        <SubscriptionYear>
          <Amount>1</Amount>
          <Name>sample string 2</Name>
          <SubscriptionId>1</SubscriptionId>
          <TaxYearId>1</TaxYearId>
        </SubscriptionYear>
        <SubscriptionYear>
          <Amount>1</Amount>
          <Name>sample string 2</Name>
          <SubscriptionId>1</SubscriptionId>
          <TaxYearId>1</TaxYearId>
        </SubscriptionYear>
      </Years>
    </Subscription>
    <Subscription>
      <Enabled>true</Enabled>
      <Name>sample string 2</Name>
      <OccupationSubscriptionId>1</OccupationSubscriptionId>
      <Years>
        <SubscriptionYear>
          <Amount>1</Amount>
          <Name>sample string 2</Name>
          <SubscriptionId>1</SubscriptionId>
          <TaxYearId>1</TaxYearId>
        </SubscriptionYear>
        <SubscriptionYear>
          <Amount>1</Amount>
          <Name>sample string 2</Name>
          <SubscriptionId>1</SubscriptionId>
          <TaxYearId>1</TaxYearId>
        </SubscriptionYear>
      </Years>
    </Subscription>
  </Subscriptions>
  <Surname>sample string 8</Surname>
  <TaxYearIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </TaxYearIds>
  <ThirdPtyPermission>true</ThirdPtyPermission>
  <Title>sample string 6</Title>
  <TrustPilotSiteUrl>sample string 41</TrustPilotSiteUrl>
  <UniformBenefitsSignUpCompleted>true</UniformBenefitsSignUpCompleted>
  <UserId>sample string 17</UserId>
  <emailConfirm>sample string 28</emailConfirm>
  <energyOptin>true</energyOptin>
  <niConfirm>sample string 29</niConfirm>
  <selfAssessed>true</selfAssessed>
</ClaimCustomer>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ClaimCustomer'.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json

Sample:
true

application/xml, text/xml

Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>