POST api/properties/{propertyAddressId}/payment-history

Request Information

URI Parameters

Name	Description	Type	Additional information
propertyAddressId		integer	Required

Body Parameters

PropertyTaxPaymentHistoryModel

Name	Type	Additional information
formattedPin	string	None.
pin	string	None.
propertyLocation	string	None.
propertyOwner	string	None.
mailingAddress	string	None.
taxYears	Collection of TaxPaymentYearModel	None.
sourceCallbackUrl	string	None.

Request Formats

application/json, text/json

Sample:

{
  "formattedPin": "sample string 1",
  "pin": "sample string 2",
  "propertyLocation": "sample string 3",
  "propertyOwner": "sample string 4",
  "mailingAddress": "sample string 5",
  "taxYears": [
    {
      "taxYear": 1,
      "billedYear": 2,
      "totalAmountBilled": 3.0,
      "totalAmountDue": 4.0,
      "installments": [
        {
          "installmentNumber": 1,
          "originalInstallmentBilled": 2.0,
          "dueDate": "2025-11-14T04:46:35.2113247-06:00",
          "tax": 3.0,
          "interest": 4.0,
          "lastPaymentReceived": 5.0,
          "dateReceived": "2025-11-14T04:46:35.2133937-06:00",
          "currentAmountDue": 6.0,
          "taxBillUrl": "sample string 7"
        },
        {
          "installmentNumber": 1,
          "originalInstallmentBilled": 2.0,
          "dueDate": "2025-11-14T04:46:35.2113247-06:00",
          "tax": 3.0,
          "interest": 4.0,
          "lastPaymentReceived": 5.0,
          "dateReceived": "2025-11-14T04:46:35.2133937-06:00",
          "currentAmountDue": 6.0,
          "taxBillUrl": "sample string 7"
        }
      ],
      "exemptions": {
        "hasHomeownerExemption": true,
        "hasSeniorCitizenExemption": true,
        "hasSeniorFreezeExemption": true,
        "hasReturningVeteranExemption": true,
        "hasDisabledPersonExemption": true,
        "hasDisabledVeteranExemption": true
      }
    },
    {
      "taxYear": 1,
      "billedYear": 2,
      "totalAmountBilled": 3.0,
      "totalAmountDue": 4.0,
      "installments": [
        {
          "installmentNumber": 1,
          "originalInstallmentBilled": 2.0,
          "dueDate": "2025-11-14T04:46:35.2113247-06:00",
          "tax": 3.0,
          "interest": 4.0,
          "lastPaymentReceived": 5.0,
          "dateReceived": "2025-11-14T04:46:35.2133937-06:00",
          "currentAmountDue": 6.0,
          "taxBillUrl": "sample string 7"
        },
        {
          "installmentNumber": 1,
          "originalInstallmentBilled": 2.0,
          "dueDate": "2025-11-14T04:46:35.2113247-06:00",
          "tax": 3.0,
          "interest": 4.0,
          "lastPaymentReceived": 5.0,
          "dateReceived": "2025-11-14T04:46:35.2133937-06:00",
          "currentAmountDue": 6.0,
          "taxBillUrl": "sample string 7"
        }
      ],
      "exemptions": {
        "hasHomeownerExemption": true,
        "hasSeniorCitizenExemption": true,
        "hasSeniorFreezeExemption": true,
        "hasReturningVeteranExemption": true,
        "hasDisabledPersonExemption": true,
        "hasDisabledVeteranExemption": true
      }
    }
  ],
  "sourceCallbackUrl": "sample string 6"
}

text/html

Sample:

{"formattedPin":"sample string 1","pin":"sample string 2","propertyLocation":"sample string 3","propertyOwner":"sample string 4","mailingAddress":"sample string 5","taxYears":[{"taxYear":1,"billedYear":2,"totalAmountBilled":3.0,"totalAmountDue":4.0,"installments":[{"installmentNumber":1,"originalInstallmentBilled":2.0,"dueDate":"2025-11-14T04:46:35.2113247-06:00","tax":3.0,"interest":4.0,"lastPaymentReceived":5.0,"dateReceived":"2025-11-14T04:46:35.2133937-06:00","currentAmountDue":6.0,"taxBillUrl":"sample string 7"},{"installmentNumber":1,"originalInstallmentBilled":2.0,"dueDate":"2025-11-14T04:46:35.2113247-06:00","tax":3.0,"interest":4.0,"lastPaymentReceived":5.0,"dateReceived":"2025-11-14T04:46:35.2133937-06:00","currentAmountDue":6.0,"taxBillUrl":"sample string 7"}],"exemptions":{"hasHomeownerExemption":true,"hasSeniorCitizenExemption":true,"hasSeniorFreezeExemption":true,"hasReturningVeteranExemption":true,"hasDisabledPersonExemption":true,"hasDisabledVeteranExemption":true}},{"taxYear":1,"billedYear":2,"totalAmountBilled":3.0,"totalAmountDue":4.0,"installments":[{"installmentNumber":1,"originalInstallmentBilled":2.0,"dueDate":"2025-11-14T04:46:35.2113247-06:00","tax":3.0,"interest":4.0,"lastPaymentReceived":5.0,"dateReceived":"2025-11-14T04:46:35.2133937-06:00","currentAmountDue":6.0,"taxBillUrl":"sample string 7"},{"installmentNumber":1,"originalInstallmentBilled":2.0,"dueDate":"2025-11-14T04:46:35.2113247-06:00","tax":3.0,"interest":4.0,"lastPaymentReceived":5.0,"dateReceived":"2025-11-14T04:46:35.2133937-06:00","currentAmountDue":6.0,"taxBillUrl":"sample string 7"}],"exemptions":{"hasHomeownerExemption":true,"hasSeniorCitizenExemption":true,"hasSeniorFreezeExemption":true,"hasReturningVeteranExemption":true,"hasDisabledPersonExemption":true,"hasDisabledVeteranExemption":true}}],"sourceCallbackUrl":"sample string 6"}

application/xml, text/xml

Sample:

<PropertyTaxPaymentHistoryModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.Response">
  <FormattedPin>sample string 1</FormattedPin>
  <MailingAddress>sample string 5</MailingAddress>
  <Pin>sample string 2</Pin>
  <PropertyLocation>sample string 3</PropertyLocation>
  <PropertyOwner>sample string 4</PropertyOwner>
  <SourceCallbackUrl>sample string 6</SourceCallbackUrl>
  <TaxYears>
    <TaxPaymentYearModel>
      <BilledYear>2</BilledYear>
      <Exemptions>
        <HasDisabledPersonExemption>true</HasDisabledPersonExemption>
        <HasDisabledVeteranExemption>true</HasDisabledVeteranExemption>
        <HasHomeownerExemption>true</HasHomeownerExemption>
        <HasReturningVeteranExemption>true</HasReturningVeteranExemption>
        <HasSeniorCitizenExemption>true</HasSeniorCitizenExemption>
        <HasSeniorFreezeExemption>true</HasSeniorFreezeExemption>
      </Exemptions>
      <Installments>
        <TaxPaymentInstallmentModel>
          <CurrentAmountDue>6</CurrentAmountDue>
          <DateReceived>2025-11-14T04:46:35.2133937-06:00</DateReceived>
          <DueDate>2025-11-14T04:46:35.2113247-06:00</DueDate>
          <InstallmentNumber>1</InstallmentNumber>
          <Interest>4</Interest>
          <LastPaymentReceived>5</LastPaymentReceived>
          <OriginalInstallmentBilled>2</OriginalInstallmentBilled>
          <Tax>3</Tax>
          <TaxBillUrl>sample string 7</TaxBillUrl>
        </TaxPaymentInstallmentModel>
        <TaxPaymentInstallmentModel>
          <CurrentAmountDue>6</CurrentAmountDue>
          <DateReceived>2025-11-14T04:46:35.2133937-06:00</DateReceived>
          <DueDate>2025-11-14T04:46:35.2113247-06:00</DueDate>
          <InstallmentNumber>1</InstallmentNumber>
          <Interest>4</Interest>
          <LastPaymentReceived>5</LastPaymentReceived>
          <OriginalInstallmentBilled>2</OriginalInstallmentBilled>
          <Tax>3</Tax>
          <TaxBillUrl>sample string 7</TaxBillUrl>
        </TaxPaymentInstallmentModel>
      </Installments>
      <TaxYear>1</TaxYear>
      <TotalAmountBilled>3</TotalAmountBilled>
      <TotalAmountDue>4</TotalAmountDue>
    </TaxPaymentYearModel>
    <TaxPaymentYearModel>
      <BilledYear>2</BilledYear>
      <Exemptions>
        <HasDisabledPersonExemption>true</HasDisabledPersonExemption>
        <HasDisabledVeteranExemption>true</HasDisabledVeteranExemption>
        <HasHomeownerExemption>true</HasHomeownerExemption>
        <HasReturningVeteranExemption>true</HasReturningVeteranExemption>
        <HasSeniorCitizenExemption>true</HasSeniorCitizenExemption>
        <HasSeniorFreezeExemption>true</HasSeniorFreezeExemption>
      </Exemptions>
      <Installments>
        <TaxPaymentInstallmentModel>
          <CurrentAmountDue>6</CurrentAmountDue>
          <DateReceived>2025-11-14T04:46:35.2133937-06:00</DateReceived>
          <DueDate>2025-11-14T04:46:35.2113247-06:00</DueDate>
          <InstallmentNumber>1</InstallmentNumber>
          <Interest>4</Interest>
          <LastPaymentReceived>5</LastPaymentReceived>
          <OriginalInstallmentBilled>2</OriginalInstallmentBilled>
          <Tax>3</Tax>
          <TaxBillUrl>sample string 7</TaxBillUrl>
        </TaxPaymentInstallmentModel>
        <TaxPaymentInstallmentModel>
          <CurrentAmountDue>6</CurrentAmountDue>
          <DateReceived>2025-11-14T04:46:35.2133937-06:00</DateReceived>
          <DueDate>2025-11-14T04:46:35.2113247-06:00</DueDate>
          <InstallmentNumber>1</InstallmentNumber>
          <Interest>4</Interest>
          <LastPaymentReceived>5</LastPaymentReceived>
          <OriginalInstallmentBilled>2</OriginalInstallmentBilled>
          <Tax>3</Tax>
          <TaxBillUrl>sample string 7</TaxBillUrl>
        </TaxPaymentInstallmentModel>
      </Installments>
      <TaxYear>1</TaxYear>
      <TotalAmountBilled>3</TotalAmountBilled>
      <TotalAmountDue>4</TotalAmountDue>
    </TaxPaymentYearModel>
  </TaxYears>
</PropertyTaxPaymentHistoryModel>

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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.