Skip to main content

Microsoft Dynamics NAV to iPaaS.com Sales Order Mapping Documentation

How Microsoft Dynamics NAV sales orders are captured into iPaaS.com as transactions, including lines, addresses, tracking, and payments.

Summary

Microsoft Dynamics NAV sales orders can be captured into iPaaS.com as transactions through the Sales Order To iPaaS.com mapping collections. NAV orders are polled on a schedule; each order's header is captured along with its address, line item, tracking number, and transaction payment child collections.

ID Format

Manual Sync ID Format. To capture a single order on demand, open the subscription's Manual Sync page in the iPaaS.com portal, select the Sales Order To iPaaS.com transfer, and enter the Microsoft Dynamics NAV sales order number (No.).

  • Pattern: the NAV sales order number

  • Example: SO002970326

External ID Format. The iPaaS.com transaction number (the NAV order number) is stored as the external ID linking the two records.

Deleted Record Support

Not supported. The integration captures orders into iPaaS.com only; deleting an order in Microsoft Dynamics NAV is not captured.

Custom Field Support

The Sales Order (Transaction) collection supports custom fields, allowing additional Microsoft Dynamics NAV order fields to be captured into iPaaS.com transaction custom fields. (The tracking-number and payment child collections do not use custom fields.)

Mapping Collection Status

Status: Enabled

Trigger Events: Automatic transfers are activated by the subscriber in the iPaaS.com subscription configuration's Inbound Data Flows section, by enabling this collection's events (Poll, Create, and Update). No automatic transfer runs until they are enabled there. Manual Sync (see ID Format) is available at any time regardless.

Duplicate or Conflicting Mappings

Other collections that affect the same record. The Sales Order Add and Update To iPaaS.com collections both target the same iPaaS.com transaction. Once an order is posted as an invoice in NAV it is captured by the Invoice To iPaaS.com collections instead (read from SalesInvoices). The Sales Order From iPaaS.com collections write orders in the reverse direction (round-trip).

Collision handling. Not applicable on the capture side (configurable collision handling applies to the Sales Order From iPaaS.com write).

Duplicate Matching

The order updates/links to the existing iPaaS.com transaction matched on the NAV order number; it does not create a duplicate.

Supported Child Collections

  • Add/Update Microsoft Dynamics NAV Sales Order Address TO iPaaS.com — bill-to/ship-to address.

  • Add/Update Microsoft Dynamics NAV Sales Order Line Item TO iPaaS.com — order item lines.

  • Add/Update Microsoft Dynamics NAV Sales Order Tracking Number TO iPaaS.com — shipment tracking.

  • Add/Update Microsoft Dynamics NAV Transaction Payment TO iPaaS.com — payment terms as a transaction payment.

System Caveats

Microsoft Dynamics NAV Caveats

  • The SalesOrders OData web service must be published in Microsoft Dynamics NAV with the service name exactly SalesOrders, or orders cannot be polled.

  • Orders are read from Microsoft Dynamics NAV; the integration does not create or modify orders in NAV through these collections.

iPaaS.com Caveats

  • Customer or company must be linked. The transaction's CompanyId/CustomerId resolve only when the order's Sell-to Customer is already linked to an iPaaS.com company or customer; otherwise they resolve to null.

Setup Requirements

Microsoft Dynamics NAV Configuration

  • Publish the SalesOrders OData web service (Web Services), service name exactly SalesOrders. See the Installation Instructions.

Subscription Settings — Polling

  • Transaction Poll Search Days and Poll Time UTC Adjustment govern the order poll window and the NAV UTC date-filtering compensation. See the Connections and Settings documentation.

Authentication

  • The integration authenticates using the connection credentials in the subscription settings.

Integration Flow

  1. The scheduled transaction poll requests orders from the Microsoft Dynamics NAV SalesOrders endpoint.

  2. Valid orders (status Released, with a linked customer/company) are captured; the order header is created or updated as an iPaaS.com transaction.

  3. The order's addresses, item lines, tracking numbers, and payment terms are captured through the child collections.

Mappings

Add/Update Microsoft Dynamics NAV Sales Order TO iPaaS.com (Header)

iPaaS.com data type: Transaction

Filter Description. Only valid sales orders are captured: the NAV order status must be Released and the order's Sell-to Customer must be linked to an existing iPaaS.com customer or company. Orders that do not meet both conditions are skipped.

Description. Captures the NAV sales order header into the iPaaS.com transaction. The Add and Update collections share the same field mappings.

Mapping Type

Source Field (Microsoft Dynamics NAV)

Destination Field (iPaaS.com)

Description

Field

No

TransactionNumber

Required. iPaaS.com transaction number, from the NAV order number.

Field

DocumentType

Type

Required. Transaction type, from the NAV document type.

Lookup Translation

Lookup Translation

Status

Required. iPaaS.com transaction status, mapped from the NAV order status.

Dynamic Formula

SpaceportSystemId

SystemId

Required (automatic). The current subscription's system id.

Dynamic Formula

resolves the linked customer's NAV Sell-to Customer No. to an iPaaS.com company

CompanyId

Required (customer/company linkage). iPaaS.com company linked to the order, or null when not linked to a company. The collection's filter passes only orders whose Sell-to Customer is linked, so linkage holds. See mapping notes for the full formula.

Dynamic Formula

resolves the linked customer's NAV Sell-to Customer No. to an iPaaS.com customer

CustomerId

Required (customer/company linkage). iPaaS.com customer linked to the order, or null when not linked. The collection's filter passes only orders whose Sell-to Customer is linked, so linkage holds. See mapping notes for the full formula.

Dynamic Formula

order total excluding VAT (rounded 2dp)

Subtotal

Recommended. Transaction subtotal, from the order's line total excluding VAT.

Dynamic Formula

order total including VAT (rounded 2dp)

Total

Recommended. Transaction total, from the order's line total including VAT.

Dynamic Formula

sum of Item-line quantities

TotalQty

Recommended. Total quantity across item-type lines.

Dynamic Formula

DateTimeOffset.Parse(OrderDate)

TransactionCreatedDateTime

Recommended. Transaction created date/time, from the NAV order date.

Add/Update Microsoft Dynamics NAV Sales Order Address TO iPaaS.com

iPaaS.com data type: Transaction Address

Description. Captures the order's bill-to and ship-to address into the iPaaS.com transaction address.

Mapping Type

Source Field (Microsoft Dynamics NAV)

Destination Field (iPaaS.com)

Description

Field

IsPrimaryBilling

IsPrimaryBilling

Recommended. Primary-billing flag.

Field

IsPrimaryShipping

IsPrimaryShipping

Recommended. Primary-shipping flag.

Field

Address

Address1

Recommended. Address line 1.

Field

Address2

Address2

Recommended. Address line 2.

Field

City

City

Recommended. City.

Field

County

Region

Recommended. Region (state/province).

Field

CountryRegionCode

Country

Recommended. Country.

Field

PostCode

PostalCode

Recommended. Postal code.

Dynamic Formula

if(IsPrimaryShipping == true) return Parent.ShippingAgentCode; return null;

ShippingMethod

Recommended. Shipping method on the primary shipping address, from the order's Shipping Agent Code; if present, must match a Shipping Method configured in iPaaS.com.

Dynamic Formula

return Name.Split(' ')[0];

FirstName

Recommended. First name, split from the address Name.

Dynamic Formula

return Name.Split(' ').length > 1 ? Name.Split(' ')[1] : '';

LastName

Recommended. Last name, split from the address Name.

Add/Update Microsoft Dynamics NAV Sales Order Line Item TO iPaaS.com

iPaaS.com data type: Transaction Line

Mapping Filter

No != "" && Type == "Item"

Filter Description. Only item-type order lines that have an item number are captured; other line types (shipping, tax, G/L) are skipped.

Description. Captures the order's item lines into the iPaaS.com transaction line items.

Mapping Type

Source Field (Microsoft Dynamics NAV)

Destination Field (iPaaS.com)

Description

Static

"Product"

Type

Required. Fixed line type.

Dynamic Formula

return Parent.Status == 'Released' ? 'Shipped' : 'Pending';

Status

Required. Line status: Shipped when the order is Released, else Pending.

Field

No

Sku

Required. Line SKU, from the NAV line item number; must resolve to an existing iPaaS.com product/variant when Type is Product.

Field

Description

Description

Recommended. Line description.

Field

Quantity

Qty

Recommended. Ordered quantity.

Field

QtyToShip

QtyShipped

Recommended. Shipped quantity.

Field

UnitPrice

UnitPrice

Recommended. Unit price.

Field

LineAmount

ExtendedPrice

Recommended. Extended price.

Field

LineDiscountAmount

DiscountAmount

Recommended. Line discount amount.

Field

LineDiscountPercent

DiscountPercent

Recommended. Line discount percent.

Add/Update Microsoft Dynamics NAV Sales Order Tracking Number TO iPaaS.com

iPaaS.com data type: Transaction Tracking Number

Mapping Filter

!string.IsNullOrEmpty(PackageTrackingNo_SalesShipment) && Type == "Item"   (Add)
Type == "Item"                                                             (Update)

Filter Description. The Add collection captures only item lines that have a package tracking number; the Update collection captures item lines. Lines without a tracking number are excluded on Add.

Description. Captures shipment tracking detail (assembled from the NAV order line, sales shipment, and shipment line records) into the iPaaS.com transaction tracking number. The collection carries a large set of NAV shipment fields; the subscriber-facing core fields are shown below, with the remaining internal fields summarized after the table.

Core fields

Mapping Type

Source Field (Microsoft Dynamics NAV)

Destination Field (iPaaS.com)

Description

Field

PackageTrackingNo_SalesShipment (Add) / PackageTrackingNo (Update)

TrackingNumber

Recommended. Package tracking number.

Field

ShippingAgentCode

ShippingMethod

Required. Shipping method (shipping agent code); must match a Shipping Method configured in iPaaS.com.

Field

Quantity

Quantity

Recommended. Quantity.

Field

Shipment_Line_No

Line Item Id

Recommended. Shipment line number.

Dynamic Formula

return "Line No: "+Shipment_Line_No;

ShippingMethodDescription

Recommended. (Update) A descriptive label carrying the shipment line number.

Dynamic Formula

matches the parent order line on shipment line number and returns its unit price; defaults to 0

Cost

Recommended. (Update) Tracking line cost, from the matching order line's unit price.

Dynamic Formula

combines invoiced quantity, shipping agent code, and tracking number when all present

Partial Deliveries

Recommended. (Update) Pipe-delimited partial-delivery descriptor.

Captured NAV shipment attributes (reference). In addition to the core fields, the collection captures the full NAV shipment detail, grouped by source record. These pass through to the iPaaS.com tracking record and are not typically remapped by subscribers; the complete field inventory is maintained in the collection's mapping notes (Mapping Collection Notes/MicrosoftNav-Microsoft-Nav-Order-Sales-Tracking-Number-*-To-iPaaS-Child-mapping-notes-Final.md):

  • Order line (VBCOLI): Document_No, Creation/Processed/Sent date-times, Short_Shipped_Qty, Status, Remarks, M2/M1/3PL order ids and flags, and related control fields.

  • Sales shipment: Shipment_No, Location/Posting/Document dates, Sell-to/Bill-to/Ship-to name, address, post code, country, and contact fields, Salesperson Code, Currency Code, Shipment Method/Agent codes.

  • Shipment line (Update collection): ETag, Location code, package tracking number, sell-to customer, shipment date, and dimension codes.

  • Line detail: Type, Description, Variant Code, Unit of Measure (Code), Appl. to Item Entry, Job No, Quantity Invoiced.

Error Handling

For the catalog of subscriber-visible errors, see the Microsoft Dynamics NAV Error Messages article.

Add/Update Microsoft Dynamics NAV Transaction Payment TO iPaaS.com

iPaaS.com data type: Transaction Payment

Mapping Filter

SourceTypeName == "ParentOnly" && !string.IsNullOrEmpty(Parent.PaymentTermsCode)

Filter Description. A transaction payment is recorded only when the parent order has a Payment Terms Code; orders without one produce no payment.

Description. Records the order's payment terms as a transaction payment on the iPaaS.com transaction.

Mapping Type

Source Field (Microsoft Dynamics NAV)

Destination Field (iPaaS.com)

Description

Dynamic Formula

Parent.PaymentTermsCode

Method

Required. Payment method, from the parent order's Payment Terms Code; must match a Payment Method configured in iPaaS.com.

Testing & Validation

Test Scenarios

  1. Release an order in Microsoft Dynamics NAV whose customer is linked in iPaaS.com and run the poll (or a manual sync by order number); confirm the transaction is captured with its addresses, item lines, tracking, and payment.

  2. Confirm an order whose customer is not linked, or that is not Released, is skipped by the filter.

  3. Update an order in NAV and re-run; confirm the iPaaS.com transaction updates without duplicating.

  4. Confirm a line without a tracking number does not produce a tracking record on the Add collection.

Validation Checklist

  • The SalesOrders web service is published in NAV with the exact service name SalesOrders.

  • The order's customer/company is linked between iPaaS.com and NAV.

  • The header filter validates Released status + linked customer/company (the return true; test override is not present in the deployed template).

Additional Notes

Related Documents

Did this answer your question?