POST api/entity1098corrections

Export corrections for entities

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

IrsReturnFileExportModel

Name	Type	Additional information
ReturnFileExportId	integer	None.
FileTypeId	integer	None.
IsTestFileIndicator	boolean	None.
FilePath	string	None.
FileName	string	None.
CreatedBy	integer	None.
CreatedOn	date	None.
ModifiedBy	integer	None.
ModifiedOn	date	None.

Response Formats

application/json, text/json

Sample:

{
  "returnFileExportId": 1,
  "fileTypeId": 2,
  "isTestFileIndicator": true,
  "filePath": "sample string 4",
  "fileName": "sample string 5",
  "createdBy": 6,
  "createdOn": "2024-10-13T23:40:07.8896075-04:00",
  "modifiedBy": 1,
  "modifiedOn": "2024-10-13T23:40:07.8896075-04:00"
}

application/xml, text/xml

Sample:

<IrsReturnFileExportModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CamAcctApi.Core.Models">
  <CreatedBy>6</CreatedBy>
  <CreatedOn>2024-10-13T23:40:07.8896075-04:00</CreatedOn>
  <FileName>sample string 5</FileName>
  <FilePath>sample string 4</FilePath>
  <FileTypeId>2</FileTypeId>
  <IsTestFileIndicator>true</IsTestFileIndicator>
  <ModifiedBy>1</ModifiedBy>
  <ModifiedOn>2024-10-13T23:40:07.8896075-04:00</ModifiedOn>
  <ReturnFileExportId>1</ReturnFileExportId>
</IrsReturnFileExportModel>