POST api/PaymentSchedule

Create a new Payment Schedule document

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
LicenseKey	string	None.
CompanyId	string	None.
SiteId	string	None.
ProductDetails	PaymentScheduleProductDetails	None.
LoanDetails	PaymentScheduleLoanDetails	None.
BrokerDetails	PaymentScheduleBrokerDetails	None.
Applicants	Collection of PaymentScheduleApplicant	None.
PaymentScheduleType	PaymentScheduleType	None.
HeaderImageBase64	string	None.
HeaderImageType	ImageType	None.

Request Formats

application/json, text/json

Sample:

{
  "LicenseKey": "sample string 1",
  "CompanyId": "sample string 2",
  "SiteId": "sample string 3",
  "ProductDetails": {
    "ProductCode": "sample string 1",
    "BaseProductCode": "sample string 2",
    "LenderProductReference": "sample string 3",
    "ProductName": "sample string 4",
    "LenderCode": "sample string 5",
    "LenderName": "sample string 6",
    "LenderNameOverride": "sample string 7",
    "PackagerName": "sample string 8",
    "Rates": [
      {
        "Rate": 1.0,
        "Loading": 2.0,
        "DurationMonths": 3,
        "DurationEndDate": "sample string 4",
        "RateClass": 0,
        "RateType": 0,
        "RateDescription": "sample string 5"
      },
      {
        "Rate": 1.0,
        "Loading": 2.0,
        "DurationMonths": 3,
        "DurationEndDate": "sample string 4",
        "RateClass": 0,
        "RateType": 0,
        "RateDescription": "sample string 5"
      }
    ],
    "Fees": [
      {
        "Name": "sample string 1",
        "Description": "sample string 2",
        "Type": 0,
        "WhenPayable": 0,
        "AddToLoanCondition": 0,
        "AddToLoan": true,
        "Amount": 4.0
      },
      {
        "Name": "sample string 1",
        "Description": "sample string 2",
        "Type": 0,
        "WhenPayable": 0,
        "AddToLoanCondition": 0,
        "AddToLoan": true,
        "Amount": 4.0
      }
    ]
  },
  "LoanDetails": {
    "LoanAmount": 1.0,
    "ExpectedValuation": 2.0,
    "LoanRequiredInvestmentPart": 3.0,
    "Term": 4,
    "TermUnit": 0,
    "PaymentMethod": 0,
    "IsRemortgage": true,
    "MortgageType": 0,
    "PaymentSchedule": {
      "MonthlyPayments": [
        {
          "PaymentNumber": 1,
          "Date": "sample string 2",
          "Rate": 3.0,
          "RateType": 0,
          "RateClass": 0,
          "Amount": 4.0,
          "InterestOnlyAmount": 5.0,
          "Interest": 6.0,
          "Repayment": 7.0,
          "Principal": 8.0,
          "TotalInterest": 9.0,
          "TotalRepayment": 10.0,
          "TotalCost": 11.0
        },
        {
          "PaymentNumber": 1,
          "Date": "sample string 2",
          "Rate": 3.0,
          "RateType": 0,
          "RateClass": 0,
          "Amount": 4.0,
          "InterestOnlyAmount": 5.0,
          "Interest": 6.0,
          "Repayment": 7.0,
          "Principal": 8.0,
          "TotalInterest": 9.0,
          "TotalRepayment": 10.0,
          "TotalCost": 11.0
        }
      ],
      "InitialMonthlyPayment": 1.0,
      "RevertMonthlyPayment": 2.0,
      "RevertMonthlyPaymentPlus1Percent": 3.0,
      "TrueCostFullTerm": 4.0,
      "TotalInterest": 5.0
    },
    "BuyToLetDetails": {
      "ConsumerBuyToLet": 0,
      "LimitedCompany": 0,
      "LimitedCompanySPV": 0,
      "LimitedCompanyName": "sample string 1"
    }
  },
  "BrokerDetails": {
    "BrokerCompanyName": "sample string 1",
    "BrokerPhoneNumber": "sample string 2",
    "BrokerName": "sample string 3",
    "BrokerEmailAddress": "sample string 4",
    "BrokerAddressLine1": "sample string 5",
    "BrokerAddressLine2": "sample string 6",
    "BrokerAddressLine3": "sample string 7",
    "BrokerAddressTown": "sample string 8",
    "BrokerAddressCounty": "sample string 9",
    "BrokerAddressCountry": "sample string 10",
    "BrokerAddressPostCode": "sample string 11"
  },
  "Applicants": [
    {
      "Title": "sample string 1",
      "FirstName": "sample string 2",
      "MiddleName": "sample string 3",
      "LastName": "sample string 4"
    },
    {
      "Title": "sample string 1",
      "FirstName": "sample string 2",
      "MiddleName": "sample string 3",
      "LastName": "sample string 4"
    }
  ],
  "PaymentScheduleType": 0,
  "HeaderImageBase64": "sample string 4",
  "HeaderImageType": 0
}

application/xml, text/xml

Sample:

<PaymentScheduleRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Twenty7Tec.Common">
  <Applicants>
    <PaymentScheduleApplicant>
      <FirstName>sample string 2</FirstName>
      <LastName>sample string 4</LastName>
      <MiddleName>sample string 3</MiddleName>
      <Title>sample string 1</Title>
    </PaymentScheduleApplicant>
    <PaymentScheduleApplicant>
      <FirstName>sample string 2</FirstName>
      <LastName>sample string 4</LastName>
      <MiddleName>sample string 3</MiddleName>
      <Title>sample string 1</Title>
    </PaymentScheduleApplicant>
  </Applicants>
  <BrokerDetails>
    <BrokerAddressCountry>sample string 10</BrokerAddressCountry>
    <BrokerAddressCounty>sample string 9</BrokerAddressCounty>
    <BrokerAddressLine1>sample string 5</BrokerAddressLine1>
    <BrokerAddressLine2>sample string 6</BrokerAddressLine2>
    <BrokerAddressLine3>sample string 7</BrokerAddressLine3>
    <BrokerAddressPostCode>sample string 11</BrokerAddressPostCode>
    <BrokerAddressTown>sample string 8</BrokerAddressTown>
    <BrokerCompanyName>sample string 1</BrokerCompanyName>
    <BrokerEmailAddress>sample string 4</BrokerEmailAddress>
    <BrokerName>sample string 3</BrokerName>
    <BrokerPhoneNumber>sample string 2</BrokerPhoneNumber>
  </BrokerDetails>
  <CompanyId>sample string 2</CompanyId>
  <HeaderImageBase64>sample string 4</HeaderImageBase64>
  <HeaderImageType>Jpeg</HeaderImageType>
  <LicenseKey>sample string 1</LicenseKey>
  <LoanDetails>
    <BuyToLetDetails>
      <ConsumerBuyToLet>Yes</ConsumerBuyToLet>
      <LimitedCompany>Yes</LimitedCompany>
      <LimitedCompanyName>sample string 1</LimitedCompanyName>
      <LimitedCompanySPV>Yes</LimitedCompanySPV>
    </BuyToLetDetails>
    <ExpectedValuation>2</ExpectedValuation>
    <IsRemortgage>true</IsRemortgage>
    <LoanAmount>1</LoanAmount>
    <LoanRequiredInvestmentPart>3</LoanRequiredInvestmentPart>
    <MortgageType>Standard</MortgageType>
    <PaymentMethod>Repayment</PaymentMethod>
    <PaymentSchedule xmlns:d3p1="http://schemas.datacontract.org/2004/07/Twenty7Tec.Common.Documents">
      <d3p1:InitialMonthlyPayment>1</d3p1:InitialMonthlyPayment>
      <d3p1:MonthlyPayments>
        <d3p1:DocsAmortPayment>
          <d3p1:Amount>4</d3p1:Amount>
          <d3p1:Date>sample string 2</d3p1:Date>
          <d3p1:Interest>6</d3p1:Interest>
          <d3p1:InterestOnlyAmount>5</d3p1:InterestOnlyAmount>
          <d3p1:PaymentNumber>1</d3p1:PaymentNumber>
          <d3p1:Principal>8</d3p1:Principal>
          <d3p1:Rate>3</d3p1:Rate>
          <d3p1:RateClass>Fixed</d3p1:RateClass>
          <d3p1:RateType>BoE</d3p1:RateType>
          <d3p1:Repayment>7</d3p1:Repayment>
          <d3p1:TotalCost>11</d3p1:TotalCost>
          <d3p1:TotalInterest>9</d3p1:TotalInterest>
          <d3p1:TotalRepayment>10</d3p1:TotalRepayment>
        </d3p1:DocsAmortPayment>
        <d3p1:DocsAmortPayment>
          <d3p1:Amount>4</d3p1:Amount>
          <d3p1:Date>sample string 2</d3p1:Date>
          <d3p1:Interest>6</d3p1:Interest>
          <d3p1:InterestOnlyAmount>5</d3p1:InterestOnlyAmount>
          <d3p1:PaymentNumber>1</d3p1:PaymentNumber>
          <d3p1:Principal>8</d3p1:Principal>
          <d3p1:Rate>3</d3p1:Rate>
          <d3p1:RateClass>Fixed</d3p1:RateClass>
          <d3p1:RateType>BoE</d3p1:RateType>
          <d3p1:Repayment>7</d3p1:Repayment>
          <d3p1:TotalCost>11</d3p1:TotalCost>
          <d3p1:TotalInterest>9</d3p1:TotalInterest>
          <d3p1:TotalRepayment>10</d3p1:TotalRepayment>
        </d3p1:DocsAmortPayment>
      </d3p1:MonthlyPayments>
      <d3p1:RevertMonthlyPayment>2</d3p1:RevertMonthlyPayment>
      <d3p1:RevertMonthlyPaymentPlus1Percent>3</d3p1:RevertMonthlyPaymentPlus1Percent>
      <d3p1:TotalInterest>5</d3p1:TotalInterest>
      <d3p1:TrueCostFullTerm>4</d3p1:TrueCostFullTerm>
    </PaymentSchedule>
    <Term>4</Term>
    <TermUnit>Years</TermUnit>
  </LoanDetails>
  <PaymentScheduleType>None</PaymentScheduleType>
  <ProductDetails>
    <BaseProductCode>sample string 2</BaseProductCode>
    <Fees>
      <PaymentScheduleFee>
        <AddToLoan>true</AddToLoan>
        <AddToLoanCondition>CanAddToLoan</AddToLoanCondition>
        <Amount>4</Amount>
        <Description>sample string 2</Description>
        <Name>sample string 1</Name>
        <Type>BrokerApplicationFee</Type>
        <WhenPayable>OnApplication</WhenPayable>
      </PaymentScheduleFee>
      <PaymentScheduleFee>
        <AddToLoan>true</AddToLoan>
        <AddToLoanCondition>CanAddToLoan</AddToLoanCondition>
        <Amount>4</Amount>
        <Description>sample string 2</Description>
        <Name>sample string 1</Name>
        <Type>BrokerApplicationFee</Type>
        <WhenPayable>OnApplication</WhenPayable>
      </PaymentScheduleFee>
    </Fees>
    <LenderCode>sample string 5</LenderCode>
    <LenderName>sample string 6</LenderName>
    <LenderNameOverride>sample string 7</LenderNameOverride>
    <LenderProductReference>sample string 3</LenderProductReference>
    <PackagerName>sample string 8</PackagerName>
    <ProductCode>sample string 1</ProductCode>
    <ProductName>sample string 4</ProductName>
    <Rates>
      <PaymentScheduleRateStep>
        <DurationEndDate>sample string 4</DurationEndDate>
        <DurationMonths>3</DurationMonths>
        <Loading>2</Loading>
        <Rate>1</Rate>
        <RateClass>Fixed</RateClass>
        <RateDescription>sample string 5</RateDescription>
        <RateType>BoE</RateType>
      </PaymentScheduleRateStep>
      <PaymentScheduleRateStep>
        <DurationEndDate>sample string 4</DurationEndDate>
        <DurationMonths>3</DurationMonths>
        <Loading>2</Loading>
        <Rate>1</Rate>
        <RateClass>Fixed</RateClass>
        <RateDescription>sample string 5</RateDescription>
        <RateType>BoE</RateType>
      </PaymentScheduleRateStep>
    </Rates>
  </ProductDetails>
  <SiteId>sample string 3</SiteId>
</PaymentScheduleRequest>

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 'PaymentScheduleRequest'.

Response Information

Resource Description

A Payment Schedule document id

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.