Skip to content

Importing Sales Orders into Acumatica

This task will create new or update existing sales orders in Acumatica, from an XML file.

The sales orders provided in the XML file can be matched to existing orders in Acumatica using the following fields:

  • Id - Acumatica's unique ID of the record, as seen in exports from Acumatica in the NoteID field.
  • ExternalId - If the record has previously been imported into Acumatica via Zynk, and an external ID was specified at the time, it can be used for matching.
  • OrderType and OrderNbr - The order type and number form a unique identifier when both specified together.
  • MatchWhere - You can perform your own custom matching by specifying an OData filter here. For more details on the syntax, please refer to Acumatica's documentation.

The detail lines provided in the XML can be matched to existing lines in Acumatica by Id. If no line IDs are specified when updating an existing order, new lines will be added to the order.

Settings

Acumatica Connection

Required
The Acumatica connection to use. See the Connecting to Acumatica article if you require more information on how to create/manage connections.

Fail File

Required
The name of the file to write failed records to. The data will be output in the same XML format as the Input File. A sample can be found below.

Input File

Required
The name of the file containing the data you want to import into Acumatica. The data must be in XML format, a sample of which is shown below.

Success File

Required
The name of the file to write successfully imported records to. The data will be output in the same XML format as the Input File. A sample can be found below.

Auto Create Shipments/Receipts

Required
Set to true to automatically create shipments or receipts for the imported orders.

Expand

Optional
Used to specify the linked and detail entities that should included in the data returned. The entities can either be specified as a comma separated string, or using the 'List' Zynk object type. For more details on how to specify entities to expand, please refer to Acumatica's documentation.

Prevent Reprocessing

Required
Set to 'True' to prevent the same record being processed more than once. This works based on the value of the ExternalId element provided within the Input File.

Timeout

Optional
The length of time to wait for responses from the Acumatica API. If not specified, the timeout will default to 100 seconds.

Zynk Settings

See Common Task Settings

Examples

The example input file is shown below. The XML format is the same as the Export Sales Orders task.

<?xml version="1.0" encoding="utf-8"?>
<SalesOrders xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <SalesOrder>
    <Id>97920cbf-2b8c-f111-947f-0ac6bd3e620b</Id>
    <ExternalId>5230</ExternalId>
    <OrderNbr>000039</OrderNbr>
    <OrderType>SO</OrderType>
    <MatchWhere>ExternalRef eq 'Zynk Test'</MatchWhere>
    <ExternalRef>Zynk Test</ExternalRef>
    <CustomerID>C0001</CustomerID>
    <BillToAddress>
      <AddressLine1>Zynk Software</AddressLine1>
      <AddressLine2>6-8 Charlotte Square</AddressLine2>
      <City>Newcastle</City>
      <Country>GB</Country>
      <PostalCode>NE1 4XF</PostalCode>
      <State />
      <Department />
      <SubDepartment />
      <StreetName />
      <BuildingNumber />
      <BuildingName />
      <Floor />
      <UnitNumber />
      <PostBox />
      <Room />
      <TownLocationName />
      <DistrictName />
    </BillToAddress>
    <BillToAddressOverride>true</BillToAddressOverride>
    <Details>
      <Detail>
        <Id>9fb74e27-2d8c-f111-947f-0ac6bd3e620b</Id>
        <Branch>ZYN</Branch>
        <InventoryID>TSHIRT-M-WHITE</InventoryID>
        <OrderQty>2.000000</OrderQty>
        <UOM>EACH</UOM>
        <WarehouseID>MAIN</WarehouseID>
      </Detail>
    </Details>
  </SalesOrder>
</SalesOrders>