POST api/edi/ExportEdi

Request Information

URI Parameters

None.

Body Parameters

EdiCriteria
NameDescriptionTypeAdditional information
VendorId

string

None.

ExportType

string

None.

TransactionType

string

None.

FromDate

date

None.

ToDate

date

None.

ItemNumber

string

None.

FileName

string

None.

IncludeRawProducts

boolean

None.

IncludeFinishedProducts

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "VendorId": "sample string 1",
  "ExportType": "sample string 2",
  "TransactionType": "sample string 3",
  "FromDate": "2026-11-20T20:26:55.4793104+00:00",
  "ToDate": "2026-11-20T20:26:55.4793104+00:00",
  "ItemNumber": "sample string 4",
  "FileName": "sample string 5",
  "IncludeRawProducts": true,
  "IncludeFinishedProducts": true
}

application/xml, text/xml

Sample:
<EdiModels.EdiCriteria xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HarAccountingAPI.Models">
  <ExportType>sample string 2</ExportType>
  <FileName>sample string 5</FileName>
  <FromDate>2026-11-20T20:26:55.4793104+00:00</FromDate>
  <IncludeFinishedProducts>true</IncludeFinishedProducts>
  <IncludeRawProducts>true</IncludeRawProducts>
  <ItemNumber>sample string 4</ItemNumber>
  <ToDate>2026-11-20T20:26:55.4793104+00:00</ToDate>
  <TransactionType>sample string 3</TransactionType>
  <VendorId>sample string 1</VendorId>
</EdiModels.EdiCriteria>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

EdiExportResult
NameDescriptionTypeAdditional information
HasErrors

boolean

None.

Problems

Collection of EdiZipProblem

None.

FileName

string

None.

FileContentBase64

string

None.

Response Formats

application/json, text/json

Sample:
{
  "HasErrors": true,
  "Problems": [
    {
      "DocNumber": "sample string 1",
      "CustNmbr": "sample string 2",
      "CustName": "sample string 3",
      "BillZip": "sample string 4",
      "Length": 5
    },
    {
      "DocNumber": "sample string 1",
      "CustNmbr": "sample string 2",
      "CustName": "sample string 3",
      "BillZip": "sample string 4",
      "Length": 5
    }
  ],
  "FileName": "sample string 2",
  "FileContentBase64": "sample string 3"
}

application/xml, text/xml

Sample:
<EdiModels.EdiExportResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HarAccountingAPI.Models">
  <FileContentBase64>sample string 3</FileContentBase64>
  <FileName>sample string 2</FileName>
  <HasErrors>true</HasErrors>
  <Problems>
    <EdiModels.EdiZipProblem>
      <BillZip>sample string 4</BillZip>
      <CustName>sample string 3</CustName>
      <CustNmbr>sample string 2</CustNmbr>
      <DocNumber>sample string 1</DocNumber>
      <Length>5</Length>
    </EdiModels.EdiZipProblem>
    <EdiModels.EdiZipProblem>
      <BillZip>sample string 4</BillZip>
      <CustName>sample string 3</CustName>
      <CustNmbr>sample string 2</CustNmbr>
      <DocNumber>sample string 1</DocNumber>
      <Length>5</Length>
    </EdiModels.EdiZipProblem>
  </Problems>
</EdiModels.EdiExportResult>