POST api/entity1098exports

Process entities that are sent for export

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
ParameterIds	Entity calculation parameter ids	Collection of integer	None.
Year	Export year. Must be current year or last year.	integer	None.
TaxProfileId	Tax profile id associated with 1098 export	integer	Range: inclusive between 1 and 2147483647

Request Formats

application/json, text/json

Sample:

{
  "parameterIds": [
    1,
    2
  ],
  "year": 1,
  "taxProfileId": 2
}

application/xml, text/xml

Sample:

<Entity1098FilterViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.ViewModels">
  <ParameterIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </ParameterIds>
  <TaxProfileId>2</TaxProfileId>
  <Year>1</Year>
</Entity1098FilterViewModel>

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

Response Information

Resource Description

Irs1098CompanySnapshotViewModel

Name	Description	Type	Additional information
Id	Export Id	integer	None.
Irs1098CompanyId	Irs1098Company table Id, this represents the most current data	integer	None.
IrsProfileId	Tax Profile Id	integer	None.
Year	Tax Year	integer	None.
TIN	Federal Tax Id	string	None.
ControlCode	TCC Code, Transmit Control Code	string	None.
CorrectedReturnIndicatorId	Is this a correction? if it is then the Id of the original export will be populated	integer	None.
IsTestFileIndicator	Is This a test file?	boolean	None.
Name	Name of the Company	string	None.
NameContinuation	Name Part 2(Optional)	string	None.
MailingAddress	MailingAddress	string	None.
City	City	string	None.
State	State	string	None.
ZipCode	Zip Code	string	None.
Country	Country	string	None.
ContactName	Contact Name	string	None.
ContactPhone	Contact Phone	string	None.
ContactEmail	Contact Email	string	None.
CreatedBy	Creator(User)	integer	None.
CreatedOn	Date of creation	date	None.
FileName	Export file name	string	None.
FilePath	Export File Path	string	None.

Response Formats

application/json, text/json

Sample:

{
  "id": 1,
  "irs1098CompanyId": 2,
  "irsProfileId": 3,
  "year": 4,
  "tin": "sample string 5",
  "controlCode": "sample string 6",
  "correctedReturnIndicatorId": 1,
  "isTestFileIndicator": true,
  "name": "sample string 8",
  "nameContinuation": "sample string 9",
  "mailingAddress": "sample string 10",
  "city": "sample string 11",
  "state": "sample string 12",
  "zipCode": "sample string 13",
  "country": "sample string 14",
  "contactName": "sample string 15",
  "contactPhone": "sample string 16",
  "contactEmail": "sample string 17",
  "createdBy": 18,
  "createdOn": "2024-10-14T08:19:51.4772711-04:00",
  "fileName": "sample string 20",
  "filePath": "sample string 21"
}

application/xml, text/xml

Sample:

<Irs1098CompanySnapshotViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.Controllers.TAX.Models">
  <City>sample string 11</City>
  <ContactEmail>sample string 17</ContactEmail>
  <ContactName>sample string 15</ContactName>
  <ContactPhone>sample string 16</ContactPhone>
  <ControlCode>sample string 6</ControlCode>
  <CorrectedReturnIndicatorId>1</CorrectedReturnIndicatorId>
  <Country>sample string 14</Country>
  <CreatedBy>18</CreatedBy>
  <CreatedOn>2024-10-14T08:19:51.4772711-04:00</CreatedOn>
  <Id>1</Id>
  <Irs1098CompanyId>2</Irs1098CompanyId>
  <IrsProfileId>3</IrsProfileId>
  <IsTestFileIndicator>true</IsTestFileIndicator>
  <MailingAddress>sample string 10</MailingAddress>
  <Name>sample string 8</Name>
  <NameContinuation>sample string 9</NameContinuation>
  <State>sample string 12</State>
  <TIN>sample string 5</TIN>
  <Year>4</Year>
  <ZipCode>sample string 13</ZipCode>
</Irs1098CompanySnapshotViewModel>