GET api/entity1098exports/{taxProfileId}/{year}

Get entities ready to export for the tax year

Request Information

URI Parameters

NameDescriptionTypeAdditional information
taxProfileId

integer

Required

year

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of Entity1098ExportViewModel
NameDescriptionTypeAdditional information
Id

Id

integer

None.

SuperEntityId

SuperEntityId

integer

None.

EntityName

EntityName

string

None.

TaxId

TaxId

string

None.

EntityNumber

EntityNumber

string

None.

GroupedResidentCount

Resident count

integer

None.

ParameterIds

Entity calculation parameters ids

Collection of integer

None.

RealEstateTaxes

decimal number

None.

MortgageInterest

decimal number

None.

MortgageOriginationPrincipal

decimal number

None.

MortgageOriginationDate

date

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "id": 1,
    "superEntityId": 2,
    "entityName": "sample string 3",
    "taxId": "sample string 4",
    "entityNumber": "sample string 5",
    "groupedResidentCount": 6,
    "parameterIds": [
      1,
      2
    ],
    "realEstateTaxes": 7.0,
    "mortgageInterest": 8.0,
    "mortgageOriginationPrincipal": 9.0,
    "mortgageOriginationDate": "2024-10-14T08:26:28.1907772-04:00"
  },
  {
    "id": 1,
    "superEntityId": 2,
    "entityName": "sample string 3",
    "taxId": "sample string 4",
    "entityNumber": "sample string 5",
    "groupedResidentCount": 6,
    "parameterIds": [
      1,
      2
    ],
    "realEstateTaxes": 7.0,
    "mortgageInterest": 8.0,
    "mortgageOriginationPrincipal": 9.0,
    "mortgageOriginationDate": "2024-10-14T08:26:28.1907772-04:00"
  }
]

application/xml, text/xml

Sample:
<ArrayOfEntity1098ExportViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <Entity1098ExportViewModel>
    <MortgageInterest>8</MortgageInterest>
    <MortgageOriginationDate>2024-10-14T08:26:28.1907772-04:00</MortgageOriginationDate>
    <MortgageOriginationPrincipal>9</MortgageOriginationPrincipal>
    <RealEstateTaxes>7</RealEstateTaxes>
    <EntityName>sample string 3</EntityName>
    <EntityNumber>sample string 5</EntityNumber>
    <GroupedResidentCount>6</GroupedResidentCount>
    <Id>1</Id>
    <ParameterIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </ParameterIds>
    <SuperEntityId>2</SuperEntityId>
    <TaxId>sample string 4</TaxId>
  </Entity1098ExportViewModel>
  <Entity1098ExportViewModel>
    <MortgageInterest>8</MortgageInterest>
    <MortgageOriginationDate>2024-10-14T08:26:28.1907772-04:00</MortgageOriginationDate>
    <MortgageOriginationPrincipal>9</MortgageOriginationPrincipal>
    <RealEstateTaxes>7</RealEstateTaxes>
    <EntityName>sample string 3</EntityName>
    <EntityNumber>sample string 5</EntityNumber>
    <GroupedResidentCount>6</GroupedResidentCount>
    <Id>1</Id>
    <ParameterIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </ParameterIds>
    <SuperEntityId>2</SuperEntityId>
    <TaxId>sample string 4</TaxId>
  </Entity1098ExportViewModel>
</ArrayOfEntity1098ExportViewModel>