POST api/irs1099exports

Export Regular Filing.

Request Information

URI Parameters

None.

Body Parameters

Parameters to export

Name	Description	Type	Additional information
ProcessedEntityIds	[Required]Processed Entity Ids to Export.	Collection of integer	Required
TaxProfileId	[Required]Tax Profile ID to export	integer	Range: inclusive between 0 and 2147483647
Year	[Required]Year	integer	Range: inclusive between 1900 and 3000

Request Formats

application/json, text/json

Sample:

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

application/xml, text/xml

Sample:

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

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

Response Information

Resource Description

IrsCompletedExportViewModel

Name	Description	Type	Additional information
Id	Export Id	integer	None.
Year	Tax Year	integer	None.
TIN	Federal Tax Id	string	None.
ControlCode	TCC Code, Transmit Control Code	string	None.
CreatedBy	Creator(User)	integer	None.
CreatedOn	Date of creation	date	None.
FileName	Export file name	string	None.
TotalItemCount	This is the total item count when adding all the item counts from all the detail records	integer	None.
Details	List of details(entities) for the export	Collection of IrsCompletedExportDetailViewModel	None.