POST api/me/properties/{userPropertyId}/documents/appeal-engagement?overpayment={overpayment}

Requires Authorization!

Request Information

URI Parameters

NameDescriptionTypeAdditional information
userPropertyId

integer

Required

overpayment

decimal number

Required

Body Parameters

None.

Response Information

Resource Description

GeneratedDocumentModelResponse
NameDescriptionTypeAdditional information
ProductId

integer

None.

TaxYear

integer

None.

Name

string

None.

Description

string

None.

PathUri

string

None.

IsReport

boolean

None.

ProductBundleId

integer

None.

DocumentId

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "productId": 1,
  "taxYear": 1,
  "name": "sample string 2",
  "description": "sample string 3",
  "pathUri": "sample string 4",
  "isReport": true,
  "productBundleId": 6,
  "documentId": 7
}

text/html

Sample:
{"productId":1,"taxYear":1,"name":"sample string 2","description":"sample string 3","pathUri":"sample string 4","isReport":true,"productBundleId":6,"documentId":7}

application/xml, text/xml

Sample:
<GeneratedDocumentModelResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ptd.Model.WebModels.DocumentGeneration">
  <Description>sample string 3</Description>
  <DocumentId>7</DocumentId>
  <IsReport>true</IsReport>
  <Name>sample string 2</Name>
  <PathUri>sample string 4</PathUri>
  <ProductBundleId>6</ProductBundleId>
  <ProductId>1</ProductId>
  <TaxYear>1</TaxYear>
</GeneratedDocumentModelResponse>