WebConnector API v3.20

Introduction

Web Connector services are designed in Microsoft Dynamics NAV. Some of these services follow a Create, Read, Update and Delete pattern. Basically this helps to control all data in NAV just by setting them up in NAV. However, sometimes it's better, or even necessary to customize the generic NAV web services. This leads to optimized and easy-to-use processes. In the following Description we provide message structures, examples and basic accessibility features.

Performance Hints trending_up

Response time is primarily depending on the NAV hosting system. For this it's mandatory to know the framework conditions of the web connector interface. Despite there can be various factors that affect system performance we recommend to generally consider the following points:
  • Real time price and item availability calculations should be done for 50 positions max (up to 150 in exceptional cases).

  • For pure data queries response data should not overexceed 500 results as this can cause time outs. Use data paging instead.

  • Cache data and raise item availability the moment data is neede at best. Weigh this with the performance of other processes.

  • Filter fields with keys set up in NAV only. Do not filter text fields that do not have any keys. (i.e. "*Smith*" in contact data is very insufficient)

General Services

These services provide subsidiary data for interacting with Dynamics NAV. This section shows how to get, update or create these data from or in the ERP.

Item

Items (articles) can be read and updated by various ways within the WebConnector. The item services are to read one specific or filter multiple items by different criteria. Please also see Item Transfer

WSDL schema: Item Service

  • vpn_keyNo* [String, Capital, max. length 20, 1..1]
    Primary Key of the item table. Contains the Item Number.

  • No_2 [String, Capital, max. length 20, 0..1]
    Secondary Item Number.

  • Description [String, max. length 50, 0..1]
    Primary item description

  • Description_2 [String, max. length 50, 0..1]
    Secondary item description

  • Search_Description [String, Capital, max. length 50, 0..1]
    Search description. This value is generated in NAV for indexing purposes.

  • Base_Unit_of_Measure [String, Capital , max. length 10, 1..1]
    The Base UOM is used to indicate the base unit of the item. i.E. 'STÜCK'. Get a list of codes from the Master Data Service

  • Sales_Unit_of_Measure [String, Capital , max. length 10, 1..1]
    The Base UOM is used to indicate the sales unit of the item. i.E. 'KARTON'. Get a list of codes from the Master Data Service

  • Country_Region_Purchased_Code [String, Capital, max. length 10, 0..1]
    Specifies a code for the country/region in which the item was produced or processed. Get a list of codes from the Master Data Service

  • Country_Region_of_Origin_Code [String, Capital, max. length 10, 0..1]
    Specifies a code for the country/region in which the item was produced or processed. Get a list of codes from the Master Data Service

  • Freight_Type [String, Capital, max. length 10, 0..1]
    Specifies how the item is shipped.

  • Gross_Weight [Decimal, 0..1]
    Specifies the gross weight of the item.

  • Net_Weight [Decimal, 0..1]
    Specifies the net weight of the item.

  • Unit_Volume [Decimal, 0..1]
    Specifies the volume of one unit of the item.

  • Blocked [Boolean, 0..1]
    Specifies whether an item is blocked

  • Last_Date_Modified [Datetime, 0..1]
    Shows when the item card was last modified.

  • Price_Includes_VAT [Boolean, 0..1]
    Indicates item's price included VAT.

  • Gen_Prod_Posting_Group [String, Capital, max. length 10, 0..1]

  • VAT_Prod_Posting_Group [String, Capital, max. length 10, 0..1]
    Specifies the VAT product posting group to which this item belongs.

  • VAT_Bus_Posting_Gr_Price [String, Capital, max. length 10, 0..1]
    Specifies a VAT business posting group for customers for whom you want the item price including VAT, as shown in the Unit Price field, to apply.

  • Tax_Group_Code [String, Capital, max. length 10, 0..1]
    Specifies the sales tax group code to which this item belongs.

  • Manufacturer_Code [String, Capital, max. length 10, 0..1]
    Specifies the code that identifies the manufacturer of the item.

  • Item_Category_Code [String, Capital, max. length 10, 0..1]
    Contains the item category code for the item. Get a list of codes from the Master Data Service

  • Product_Group_Code [String, Capital, max. length 10, 0..1]
    Contains a product group code that relates to the item category that is assigned to the item. Get a list of codes from the Master Data Service

  • Webshop_Item [Boolean, 0..1]
    Indicates whether this item sold in the web shop.

  • Created From Nonstock Item [Boolean, 0..1]
    Indicates whether this item is created from non stock.

  • Item Disc. Group [String, Capital, max. length 10, 0..1]
    Specifies the item discount group code.

Supported Actions

  • Create
  • Read
  • Read Multiple
  • Update
  • Update Multiple

Request
{{itemReadRequest}}
Response
{{itemReadResponse}}

Request
{{itemReadMultipleRequest}}
Response
{{itemReadMultipleResponse}}

Item Variant

Items variants can be read and updated by various ways within the WebConnector. Please also see Item Transfer

WSDL schema: Item Variant Service

  • vpn_keyCode* [String, Capital, max. length 10, 1..1]
    Item Variant Code.

  • vpn_keyItem_No* [String, Capital, max. length 20, 0..1]
    Item Number

  • Description [String, max. length 50, 0..1]
    Primary item description

Supported Actions

  • Create
  • Read
  • Read Multiple
  • Update
  • Update Multiple

Request
{{itemVariantReadRequest}}
Response
{{itemVariantReadResponse}}

Item Vendor

Item vendors are combinations of specific items, sold by specific vendors. Please also see Item Transfer

WSDL schema: Item Vendor Service

  • vpn_keyItem_No* [String, Capital, max. length 20, 0..1]
    Item Number

  • vpn_keyVendor_No* [String, Capital, max. length 20, 1..1]
    Vendor Number

  • Lead_Time_Calculation [String, 0..1]Specifies a date formula for the amount of time that it takes to replenish the item. The program uses this field to calculate the date fields on purchase order and order proposal lines as follows: Order Date + Lead Time Calculation = Planned Receipt Date.

  • Description [String, max. length 50, 0..1]
    Primary item description

Supported Actions

  • Create
  • Read
  • Read Multiple
  • Update
  • Update Multiple

Request
{{itemVendorReadRequest}}
Response
{{itemVendorReadResponse}}

Item Cross-Selling

This service delivers real time item cross selling from NAV. Use this to get corresponding order items to a specific item.

WSDL schema: Item Cross-Selling

    • Item_No [String, Capital, max. length 20, 1..1]

      Item no. of filtered item.
    • Variant_Code [String, Capital, max. length 10, 0..1]

      Variant code of filtered item
    • Cross_Selling_No [String, Capital, max. length 20, 1..1]

      Item no. of cross selling result item
    • Cross_Selling_Variant_Code [String, Capital, max. length 10, 0..1]

      Variant code of cross selling result item
    • Quantity [Integer, 1..1]

      Quantity of cross selling items corresponding with filter item

Supported Actions

  • GetItemCrossSelling

Request
{{outItemCrossSellingRequest}}
Response
{{outItemCrossSellingResponse}}

Vendor

The vendor services are to read one specific or filter multiple items by different criteria. It can also update data.

WSDL schema: Vendor Service

  • vpn_keyNo* [String, Capital, max. length 20, 1..1]
    Specifies the number of the vendor.

  • Name [String, max. length 50, 0..1]
    Specifies the vendor's name.

  • Name_2 [String, max. length 50, 0..1]
    Specifies the vendor's add. name information.

  • Search_Name [String, max. length 50, 0..1]
    Search Name. This value is generated in NAV for indexing purposes.

  • Address [String, max. length 50, 1..1]
    Specifies the vendor's address. i.E. 'Hauptstraße 12b'

  • Address_2 [String, max. length 50, 1..1]
    Specifies the vendor's add. address information.

  • City [String, max. length 30, 1..1]
    Specifies the vendor's city.

  • Post_Code [String, Capital, max. length 10, 0..1]
    Specifies a code for the post code of the vendors address. Get a list of codes from the Master Data Service

  • Country_Region_Code [String, Capital, max. length 10, 0..1]
    Specifies a code for the country/region of the vendors address. Get a list of codes from the Master Data Service

  • Contact [String, max. length 50, 0..1]
    Name of the contact at the vendor.

  • Phone_No [String, max. length 30, 0..1]
    Specifies the vendor's phone no.

  • Fax_No [String, max. length 30, 0..1]
    Specifies the vendor's fax no.

  • Our_Account_No [String, max. length 20, 0..1]
    Specifies your account number with the vendor, if you have one.

  • Currency_Code [String, Capital, max. length 10, 0..1]
    Specifies a default currency code for the vendor. Get a list of codes from the Master Data Service

  • Language_Code [String, Capital, max. length 10, 0..1]
    Specifies a default language code for the vendor. Get a list of codes from the Master Data Service

  • Last_Date_Modified [Datetime, 0..1]
    Shows when the vendor card was last modified.

  • Price_Includes_VAT [Boolean, 0..1]
    Indicates vendor's price included VAT.

  • Payment_Terms_Code [String, Capital, max. length 10,, 0..1]
    Specifies a code that indicates the payment terms that the vendor usually requires. Get a list of codes from the Master Data Service

  • Gen_Bus_Posting_Group [String, Capital, max. length 10, 0..1]

  • Vendor_Posting_Group [String, Capital, max. length 10, 0..1]
    Specifies the VAT product posting group to which this vendor belongs.

  • VAT_Bus_Posting_Group [String, Capital, max. length 10, 0..1]
    Specifies a VAT business posting group for customers for whom you want the vendor price including VAT, as shown in the Unit Price field, to apply.

  • Tax_Liable [Boolean, 0..1]

  • Responsibility_Center [String, Capital, max. length 10, 0..1]
    Specifies the code for the responsibility center that will administer this vendor by default.. Get a list of codes from the Master Data Service

  • Registration_No [String, Capital, max. length 20, 0..1]
    Contains the registration number of the vendor.

Supported Actions

  • Create
  • Read
  • Read Multiple
  • Update
  • Update Multiple

Request
{{vendorReadRequest}}
Response
{{vendorReadResponse}}

Customer

In NAV there are customers and contacts. When customer represents the financial and balancing aspects, contacts are ie. used to store communication data. Contacts are necessary to be created within the WebConnector Order Processes. Don't worry, customer data is automatically generated by customer templates when a new contact is created by the shop. The customer services are to read one specific or filter multiple customers by different criteria. It also includes the shipping addresses for the customers. Please also see Ship-to Address and Contact.

WSDL schema: Customer Service

  • Customer Part
    • vpn_keyNo* [String, Capital, max. length 20, 1..1]
      Specifies the number of the customer.

    • Name [String, max. length 50, 0..1]
      Specifies the customer's name.

    • Name_2 [String, max. length 50, 0..1]
      Specifies the customer's add. name information.

    • Address [String, max. length 50, 1..1]
      Specifies the customer's address. i.E. 'Hauptstraße 12b'

    • Address_2 [String, max. length 50, 1..1]
      Specifies the customer's add. address information.

    • City [String, max. length 30, 1..1]
      Specifies the customer's city.

    • Post_Code [String, Capital, max. length 10, 0..1]
      Specifies a code for the post code of the customer's address. Get a list of codes from the Master Data Service

    • Country_Region_Code [String, Capital, max. length 10, 0..1]
      Specifies a code for the country/region of the customer's address. Get a list of codes from the Master Data Service

    • Contact [String, max. length 50, 0..1]
      Name of the contact at the customer.

    • Phone_No [String, max. length 30, 0..1]
      Specifies the customer's phone no.

    • Fax_No [String, max. length 30, 0..1]
      Specifies the customer's fax no.

    • Currency_Code [String, Capital, max. length 10, 0..1]
      Specifies a default currency code for the customer. Get a list of codes from the Master Data Service

    • Language_Code [String, Capital, max. length 10, 0..1]
      Specifies a default language code for the customer. Get a list of codes from the Master Data Service

    • Gen_Bus_Posting_Group [String, Capital, max. length 10, 0..1]

    • Customer_Posting_Group [String, Capital, max. length 10, 0..1]
      Specifies the VAT product posting group to which this customer belongs.

    • VAT_Bus_Posting_Group [String, Capital, max. length 10, 0..1]
      Specifies a VAT business posting group for customers for whom you want the customer price including VAT, as shown in the Unit Price field, to apply.

    • Responsibility_Center [String, Capital, max. length 10, 0..1]
      Specifies the code for the responsibility center that will administer this customer by default.. Get a list of codes from the Master Data Service

    • Customer_Price_Group [String, Capital, max. length 10, 0..1]
      Specifies the customer price group code, which you can use as a criterion to set up special sales prices. Get a list of codes from the Master Data Service

    • Blocked [Boolean, 0..1]
      Specifies whether the customer is blocked.

    • Customer Disc. Group [String, Capital, max. length 10, 0..1]
      Specifies the customer discount group code.

    • Allow Line Disc. [Boolean, 0..1]
      Specifies whether line discount is allowed .

    • Invoice Disc. Code [String, Capital, max. length 10, 0..1]
      Specifies the invoice discount group code.

  • Ship-to Address Part
    • vpn_keyCustomer No* [String, Capital, max. length 20, 1..1]
      Specifies the number of the customer.

    • vpn_keyCode* [String, Capital, max. length 10, 1..1]
      Code of the address. i.e. this can be an incremented string.

    • Name [String, max. length 50, 0..1]
      Specifies the customer's name.

    • Name_2 [String, max. length 50, 0..1]
      Specifies the customer's add. name information.

    • Address [String, max. length 50, 1..1]
      Specifies the customer's address. i.E. 'Hauptstraße 12b'

    • Address_2 [String, max. length 50, 1..1]
      Specifies the customer's add. address information.

    • City [String, max. length 30, 1..1]
      Specifies the customer's city.

    • Post_Code [String, Capital, max. length 10, 0..1]
      Specifies a code for the post code of the customer's address. Get a list of codes from the Master Data Service

    • Country_Region_Code [String, Capital, max. length 10, 0..1]
      Specifies a code for the country/region of the customer's address. Get a list of codes from the Master Data Service

    • Blocked [Boolean, 0..1]
      Specifies whether the customer is blocked.

Supported Actions

  • Create
  • Read
  • Read Multiple
  • Update
  • Update Multiple

Request
{{customerReadRequest}}
Response
{{customerReadResponse}}

Request
{{customerUpdateRequest}}
Response
{{customerUpdateResponse}}

Address

Shipping Addresses are stored at the customer in NAV. With this service you can receive addresses for a certain customer. The customer address services are to read one specific or filter multiple items by different criteria. You can also update and delete records.

WSDL schema: Customer Ship-to Address Service

  • vpn_keyCustomer No* [String, Capital, max. length 20, 1..1]
    Specifies the number of the customer.

  • vpn_keyCode* [String, Capital, max. length 10, 1..1]
    Code of the address. i.e. this can be an incremented string.

  • Name [String, max. length 50, 0..1]
    Specifies the customer's name.

  • Name_2 [String, max. length 50, 0..1]
    Specifies the customer's add. name information.

  • Address [String, max. length 50, 1..1]
    Specifies the customer's address. i.E. 'Hauptstraße 12b'

  • Address_2 [String, max. length 50, 1..1]
    Specifies the customer's add. address information.

  • City [String, max. length 30, 1..1]
    Specifies the customer's city.

  • Post_Code [String, Capital, max. length 10, 0..1]
    Specifies a code for the post code of the customer's address. Get a list of codes from the Master Data Service

  • Country_Region_Code [String, Capital, max. length 10, 0..1]
    Specifies a code for the country/region of the customer's address. Get a list of codes from the Master Data Service

  • Blocked [Boolean, 0..1]
    Specifies whether the customer is blocked.

Supported Actions

  • Create
  • Read
  • Read Multiple
  • Update
  • Update Multiple
  • Delete

xxx

Request
{{customerAddressReadMultipleRequest}}
Response
{{customerAddressReadMultipleResponse}}

Contact

Contacts are used to identify a customer in quotes and orders within the WebConnector. Please also see Customer

WSDL schema: Create Contact Service

WSDL schema: Read/Update Contact Service

WSDL schema: Outbound Contact Service

  • vpn_keyNo* [String, Capital, max. length 20, 1..1]
    Specifies the number of the contact.

  • Customer_Template_Code [String, Capital, max. length 10, 0..1]
    Specifies a customer template. This is necessary to create a customer in a later process, i.e. sales order. Get a list of codes from the Master Data Service

  • Name [String, max. length 50, 0..1]
    Specifies the contact's name.

  • Name_2 [String, max. length 50, 0..1]
    Specifies the contact's add. name information.

  • First_Name [String, max. length 30, 0..1]
    Specifies the contact's first name.

  • Middle_Name [String, max. length 30, 0..1]
    Specifies the contact's middle name.

  • Surname [String, max. length 30, 0..1]
    Specifies the contact's surname.

  • Address [String, max. length 50, 1..1]
    Specifies the contact's address. i.E. 'Hauptstraße 12b'

  • Address_2 [String, max. length 50, 1..1]
    Specifies the contact's add. address information.

  • City [String, max. length 30, 1..1]
    Specifies the contact's city.

  • Post_Code [String, Capital, max. length 10, 0..1]
    Specifies a code for the post code of the contact's address. Get a list of codes from the Master Data Service

  • Country_Region_Code [String, Capital, max. length 10, 0..1]
    Specifies a code for the country/region of the contact's address. Get a list of codes from the Master Data Service

  • Phone_No [String, max. length 30, 0..1]
    Specifies the contact's phone no.

  • Fax_No [String, max. length 30, 0..1]
    Specifies the contact's fax no.

  • E_Mail [String, max. length 80, 0..1]
    Specifies the contact's e-mail address.

  • Currency_Code [String, Capital, max. length 10, 0..1]
    Specifies a default currency code for the contact. Get a list of codes from the Master Data Service

  • Language_Code [String, Capital, max. length 10, 0..1]
    Specifies a default language code for the contact. Get a list of codes from the Master Data Service

  • Responsibility_Center [String, Capital, max. length 10, 0..1]
    Specifies the code for the responsibility center that will administer this contact by default.. Get a list of codes from the Master Data Service

  • Online_Login_ID [String, Capital, max. length 80, 0..1]
    Specifies the login ID (i.e. email address) to filter contacts

  • Online_Password [String, max. length 32, 0..1]
    Specifies a password, usually sent by the shop, as a md5 hash

  • Blocked [Boolean, 0..1]
    Specifies whether the contact is blocked.

Supported Actions

  • Create
  • Read
  • Read Multiple
  • Update
  • Update Multiple

Request
{{inbCreateContRequest}}
Response
{{inbCreateContResponse}}

Request
{{contactReadRequest}}
Response
{{contactReadResponse}}

Request
{{contactReadMultipleRequest}}
Response
{{contactReadMultipleResponse}}

Request
{{outboundContactRequest}}
Response
{{outboundContactResponse}}

Filter Item Attributes

This service returns items for defined attribute values. The available attributes and associated values can be queried in the service outboundItemAttributes.

WSDL schema: Filter Item Attributes

  • Attribute Filter Part
    • Name [String, Capital, max. length 250, 1..1]
      Specifies the attribute name.

    • Value [String, Capital, max. length 250, 1..1]
      The attribute value.

  • Misc.
    • maxResultItemFilter [Integer, 1..1]

      Maximum items in result message (default 2000).

Supported Actions

  • FilterItemAttributes

Request
{{outFilterItemAttributesRequest}}
Response
{{outFilterItemAttributesResponse}}

Create Sales Order

These services are used to create sales orders in NAV. Create Sales Order stores the order directly to the sales order tables in NAV while Create Inbound Sales Order uses the dedicated tables to store orders that will be created afterwards. This allows to check and verify these orders first, as well a create mandatory data within NAV. You will need different master data, that can be received via the Master Data Service

WSDL schema: Create Inbound Order Service

WSDL schema: Create Order Service

  • Amount Fields [READ ONLY]
    • Amount [Decimal, 0..1]
      Amount without invoice discount

    • Total_Amount [Decimal, 0..1]
      Amount incl. invoice discount

    • Invoice_Discount_Amount [Decimal, 0..1]
      Invoice discount amount

    • Total_VAT_Amount [Decimal, 0..1]
      Total VAT amount

    • Amount_Incl_VAT [Decimal, 0..1]
      Amount incl. VAT

  • Header Fields
    • vpn_keyDocument No* [String, Capital, max. length 20, 1..1]
      Specifies the number of the Sales Order. Leave this empty when creating a new order. [Requieres auto incremented no. series in NAV.]

    • Order_Date [DateTime, 0..1]
      Specifies the order DateTime. Date is saved in NAV only!

    • Shipment_Method_Code [String, Capital, max. length 50, 0..1]
      Specifies a default shipment method code for the order. Get a list of codes from the Master Data Service

    • Currency_Code [String, Capital, max. length 10, 0..1]
      Specifies a default currency code for the order. Get a list of codes from the Master Data Service

    • Shipping_Agent_Code [String, Capital, max. length 10, 0..1]
      Specifies a default shipping agent code for the order. Get a list of codes from the Master Data Service

    • Shipping_Agent_Service_Code [String, Capital, max. length 10, 0..1]
      Specifies a default shipping agent service code for the order. Get a list of codes from the Master Data Service

    • Customer_Order_No[String, Capital, max. length 20, 0..1]
      Specifies the customer's order no.

    • External_Document_No [String, max. length 35, 0..1]
      Specifies the external document no. This must be unique in NAV. You'll receive an error when insert two orders with the same external document no.

    • Payment_Method_Code [String, Capital, max. length 10, 0..1]
      Specifies a default payment method code for the order. Get a list of codes from the Master Data Service

    • Prices_Incl_VAT [Boolean, 0..1]
      Specifies the price to be incl. VAT

    • Campaign_No [String, Capital, max. length 10, 0..1]
      Specifies the campaign code assigned to an order. Get a list of codes from the Campaign Service

    • Order_Time [Time, 0..1]
      Specifies the order time. Date is saved in NAV only!

  • Address Sell-to, Ship-to, Bill-to
    • Customer_No [String, Capital, max. length 20, 1..1]
      Specifies the number of the customer.

    • Contact_No [String, Capital, max. length 20, 1..1]
      Specifies the number of the contact.

    • Code [String, max. length 10, 0..1]
      Specifies the Ship-to Address Codes.

    • Name [String, max. length 50, 0..1]
      Specifies the name.

    • Name_2 [String, max. length 50, 0..1]
      Specifies the additional name.

    • First_Name [String, max. length 30, 0..1]
      Specifies the first name.

    • Surname [String, max. length 30, 0..1]
      Specifies the surname.

    • Address [String, max. length 50, 1..1]
      Specifies the address. i.E. 'Hauptstraße 12b'

    • Address_2 [String, max. length 50, 1..1]
      Specifies the add. address information.

    • City [String, max. length 30, 1..1]
      Specifies the city.

    • Post_Code [String, Capital, max. length 10, 0..1]
      Specifies a code for the post code of the address. Get a list of codes from the Master Data Service

    • Country_Region_Code [String, Capital, max. length 10, 0..1]
      Specifies a code for the country/region of the address. Get a list of codes from the Master Data Service

    • Template_Code [String, max. length 50, 1..1]
      Specifies the customer template code that is used when a customer is created.

    • Shipping_Advice [String, max. length 50, 1..1]
      Specifies the complete or partial shipping information.

    • Create_Shipping_Address [String, max. length 30, 1..1]
      Specifies whether a shipping address is created from the ship-to block

  • Payment Block
    • TX_ID [String, Capital, max. length 80, 1..1]
      Specifies the payment transaction no.

    • TX_Code [String, Capital, max. length 20, 1..1]
      Specifies the transaction auth. code

    • TX_Amount [String, max. length 10, 0..1]
      Specifies the amount

  • Sales Line Fields , 1..n
    • vpn_keyLine No* [Decimal, 1..1]
      Specifies the pos. number.

    • Type [String, 0..1]
      Specifies the Type: "Item", "Resource", "G/L Account"

    • No [String, Capital, max. length 20, 0..1]
      Specifies the No. i.E. Item No. "70000"

    • Variant_Code [String, Capital, max. length 10, 0..1]
      Specifies the item variant code

    • Description [String, max. length 50, 0..1]
      Specifies the Description.

    • Description_2 [String, max. length 50, 0..1]
      Specifies the additional Description.

    • Unit_Of_Measure_Code [String, Capital, max. length 10, 0..1]
      Specifies the sales unit of measure of the item.

    • Quantity [Decimal, 1..1]
      Specifies the quantity.

    • Line_Amount [Decimal, 0..1]
      Specifies the lines amount

    • Line_Amount_Incl_VAT [Decimal, 0..1]
      Specifies the lines amount incl. VAT.

    • Line_Discount_Percent [Decimal, 0..1]
      Specifies the lines discount percentage.

    • Line_Discount_Amount [Decimal, 0..1]
      Specifies the lines discount amount.

    • Shipment_Date [DateTime, 0..1]
      Specifies the lines shipment date.

    • Unit_Price [Decimal, 0..1]
      Specifies the lines unit price

  • Comment Line Fields , 0..1
    • Comment [String, max. length 80, 1..1]
      Specifies comment line

Supported Actions

  • CreateSalesOrder
  • CreateSalesOrderFromQuote

Request
{{inbCreateInbOrderRequest}}
Response
{{inbCreateInbOrderResponse}}

Request
{{inbCreateOrderRequest}}
Response
{{inbCreateOrderResponse}}

Calculate Sales Order

This service is to calculate sales orders in NAV on a temporary basis. Amounts and prices can be calculated for customers, customer groups or all different pricing constructs. You will need different master data, that can be received via the Master Data Service

WSDL schema: Calculate Order Service

  • Amount Fields [READ ONLY]
    • Amount [Decimal, 0..1]
      Amount without invoice discount

    • Total_Amount [Decimal, 0..1]
      Amount incl. invoice discount

    • Invoice_Discount_Amount [Decimal, 0..1]
      Invoice discount amount

    • Total_VAT_Amount [Decimal, 0..1]
      Total VAT amount

    • Amount_Incl_VAT [Decimal, 0..1]
      Amount incl. VAT

  • Header Fields
    • vpn_keyDocument No* [String, Capital, max. length 20, 1..1]
      Specifies the number of the Sales Order. Leave this empty when creating a new order. [Requieres auto incremented no. series in NAV.]

    • Order_Date [DateTime, 0..1]
      Specifies the order date. Date is saved in NAV only!

    • Shipment_Method_Code [String, Capital, max. length 50, 0..1]
      Specifies a default shipment method code for the order. Get a list of codes from the Master Data Service

    • Currency_Code [String, Capital, max. length 10, 0..1]
      Specifies a default currency code for the order. Get a list of codes from the Master Data Service

    • Shipping_Agent_Code [String, Capital, max. length 10, 0..1]
      Specifies a default shipping agent code for the order. Get a list of codes from the Master Data Service

    • Shipping_Agent_Service_Code [String, Capital, max. length 10, 0..1]
      Specifies a default shipping agent service code for the order. Get a list of codes from the Master Data Service

    • Customer_Order_No[String, Capital, max. length 20, 0..1]
      Specifies the customer's order no.

    • External_Document_No [String, max. length 35, 0..1]
      Specifies the external document no. This must be unique in NAV. You'll receive an error when insert two orders with the same external document no.

    • Payment_Method_Code [String, Capital, max. length 10, 0..1]
      Specifies a default payment method code for the order. Get a list of codes from the Master Data Service

    • Prices_Incl_VAT [Boolean, 0..1]
      Specifies the price to be incl. VAT

    • Campaign_No [String, Capital, max. length 10, 0..1]
      Specifies the campaign code assigned to an order. Get a list of codes from the Campaign Service

  • Address Sell-to, Ship-to, Bill-to
    • Customer_No [String, Capital, max. length 20, 1..1]
      Specifies the number of the customer.

    • Contact_No [String, Capital, max. length 20, 1..1]
      Specifies the number of the contact.

    • Code [String, max. length 10, 0..1]
      Specifies the Ship-to Address Codes.

    • Name [String, max. length 50, 0..1]
      Specifies the name.

    • Name_2 [String, max. length 50, 0..1]
      Specifies the additional name.

    • First_Name [String, max. length 30, 0..1]
      Specifies the first name.

    • Surname [String, max. length 30, 0..1]
      Specifies the surname.

    • Address [String, max. length 50, 1..1]
      Specifies the address. i.E. 'Hauptstraße 12b'

    • Address_2 [String, max. length 50, 1..1]
      Specifies the add. address information.

    • City [String, max. length 30, 1..1]
      Specifies the city.

    • Post_Code [String, Capital, max. length 10, 0..1]
      Specifies a code for the post code of the address. Get a list of codes from the Master Data Service

    • Country_Region_Code [String, Capital, max. length 10, 0..1]
      Specifies a code for the country/region of the address. Get a list of codes from the Master Data Service

    • Template_Code [String, max. length 50, 1..1]
      Specifies the customer template code that is used when a customer is created.

    • Shipping_Advice [String, max. length 50, 1..1]
      Specifies the complete or partial shipping information.

  • Payment Block
    • TX_ID [String, Capital, max. length 80, 1..1]
      Specifies the payment transaction no.

    • TX_Code [String, Capital, max. length 20, 1..1]
      Specifies the transaction auth. code

    • TX_Amount [String, max. length 10, 0..1]
      Specifies the amount

  • Sales Line Fields , 1..n
    • vpn_keyLine No* [Decimal, 1..1]
      Specifies the pos. number.

    • Type [String, 0..1]
      Specifies the Type: "Item", "Resource", "G/L Account"

    • No [String, Capital, max. length 20, 0..1]
      Specifies the No. i.E. Item No. "70000"

    • Variant_Code [String, Capital, max. length 10, 0..1]
      Specifies the item variant code

    • Description [String, max. length 50, 0..1]
      Specifies the Description.

    • Description_2 [String, max. length 50, 0..1]
      Specifies the additional Description.

    • Unit_Of_Measure_Code [String, Capital, max. length 10, 0..1]
      Specifies the sales unit of measure of the item.

    • Quantity [Decimal, 1..1]
      Specifies the quantity.

    • Line_Amount [Decimal, 0..1]
      Specifies the lines amount

    • Line_Amount_Incl_VAT [Decimal, 0..1]
      Specifies the lines amount incl. VAT.

    • Line_Discount_Percent [Decimal, 0..1]
      Specifies the lines discount percentage.

    • Line_Discount_Amount [Decimal, 0..1]
      Specifies the lines discount amount.

    • Shipment_Date [DateTime, 0..1]
      Specifies the lines shipment date.

    • Unit_Price [Decimal, 0..1]
      Specifies the lines unit price

    • Availability_Numeric, [Decimal, 0..1]
      Readonly. Specifies the numeric availability for this line. Needs to be Type "Item"

    • Availability_Boolean, [Boolean, 0..1]
      Readonly. Specifies the boolean availability for this line. Needs to be Type "Item"

Supported Actions

  • CalcSalesOrder

Request
{{inbCalcOrderRequest}}
Response
{{inbCalcOrderResponse}}

Create Sales Quote

This service is to create sales quotes in NAV. You will need different master data, that can be received via the Master Data Service

WSDL schema: Create Quote Service

  • Amount Fields [READ ONLY]
    • Amount [Decimal, 0..1]
      Amount without invoice discount

    • Total_Amount [Decimal, 0..1]
      Amount incl. invoice discount

    • Invoice_Discount_Amount [Decimal, 0..1]
      Invoice discount amount

    • Total_VAT_Amount [Decimal, 0..1]
      Total VAT amount

    • Amount_Incl_VAT [Decimal, 0..1]
      Amount incl. VAT

  • Header Fields
    • vpn_keyDocument No* [String, Capital, max. length 20, 1..1]
      Specifies the number of the Sales quote. Leave this empty when creating a new quote. [Requieres auto incremented no. series in NAV.]

    • Order_Date [DateTime, 0..1]
      Specifies the quotes DateTime. Date is saved in NAV only!

    • Shipment_Method_Code [String, Capital, max. length 50, 0..1]
      Specifies a default shipment method code for the quote. Get a list of codes from the Master Data Service

    • Currency_Code [String, Capital, max. length 10, 0..1]
      Specifies a default currency code for the quote. Get a list of codes from the Master Data Service

    • Shipping_Agent_Code [String, Capital, max. length 10, 0..1]
      Specifies a default shipping agent code for the quote. Get a list of codes from the Master Data Service

    • Shipping_Agent_Service_Code [String, Capital, max. length 10, 0..1]
      Specifies a default shipping agent service code for the quote. Get a list of codes from the Master Data Service

    • Customer_Order_No[String, Capital, max. length 20, 0..1]
      Specifies the customer's quote no.

    • External_Document_No [String, max. length 35, 0..1]
      Specifies the external document no. This must be unique in NAV. You'll receive an error when insert two orders with the same external document no.

    • Payment_Method_Code [String, Capital, max. length 10, 0..1]
      Specifies a default payment method code for the quote. Get a list of codes from the Master Data Service

    • Prices_Incl_VAT [Boolean, 0..1]
      Specifies the price to be incl. VAT

  • Address Sell-to, Ship-to, Bill-to
    • Customer_No [String, Capital, max. length 20, 1..1]
      Specifies the number of the customer.

    • Contact_No [String, Capital, max. length 20, 1..1]
      Specifies the number of the contact.

    • Code [String, max. length 10, 0..1]
      Specifies the Ship-to Address Codes.

    • Name [String, max. length 50, 0..1]
      Specifies the name.

    • Name_2 [String, max. length 50, 0..1]
      Specifies the additional name.

    • First_Name [String, max. length 30, 0..1]
      Specifies the first name.

    • Surname [String, max. length 30, 0..1]
      Specifies the surname.

    • Address [String, max. length 50, 1..1]
      Specifies the address. i.E. 'Hauptstraße 12b'

    • Address_2 [String, max. length 50, 1..1]
      Specifies the add. address information.

    • City [String, max. length 30, 1..1]
      Specifies the city.

    • Post_Code [String, Capital, max. length 10, 0..1]
      Specifies a code for the post code of the address. Get a list of codes from the Master Data Service

    • Country_Region_Code [String, Capital, max. length 10, 0..1]
      Specifies a code for the country/region of the address. Get a list of codes from the Master Data Service

    • Template_Code [String, max. length 50, 1..1]
      Specifies the customer template code that is used when a customer is created.

    • Shipping_Advice [String, max. length 50, 1..1]
      Specifies the complete or partial shipping information.

    • Create_Shipping_Address [String, max. length 30, 1..1]
      Specifies whether a shipping address is created from the ship-to block

  • Payment Block
    • TX_ID [String, Capital, max. length 80, 1..1]
      Specifies the payment transaction no.

    • TX_Code [String, Capital, max. length 20, 1..1]
      Specifies the transaction auth. code

    • TX_Amount [String, max. length 10, 0..1]
      Specifies the amount

  • Sales Line Fields , 1..n
    • vpn_keyLine No* [Decimal, 1..1]
      Specifies the pos. number.

    • Type [String, 0..1]
      Specifies the Type: "Item", "Resource", "G/L Account"

    • No [String, Capital, max. length 20, 0..1]
      Specifies the No. i.E. Item No. "70000"

    • Variant_Code [String, Capital, max. length 10, 0..1]
      Specifies the item variant code

    • Description [String, max. length 50, 0..1]
      Specifies the Description.

    • Description_2 [String, max. length 50, 0..1]
      Specifies the additional Description.

    • Unit_Of_Measure_Code [String, Capital, max. length 10, 0..1]
      Specifies the sales unit of measure of the item.

    • Quantity [Decimal, 1..1]
      Specifies the quantity.

    • Line_Amount [Decimal, 0..1]
      Specifies the lines amount

    • Line_Amount_Incl_VAT [Decimal, 0..1]
      Specifies the lines amount incl. VAT.

    • Line_Discount_Percent [Decimal, 0..1]
      Specifies the lines discount percentage.

    • Line_Discount_Amount [Decimal, 0..1]
      Specifies the lines discount amount.

    • Shipment_Date [DateTime, 0..1]
      Specifies the lines shipment date.

    • Unit_Price [Decimal, 0..1]
      Specifies the lines unit price

  • Comment Line Fields , 0..1
    • Comment [String, max. length 80, 1..1]
      Specifies comment line

Supported Actions

  • CreateSalesQuote

Request
{{inbCreateQuoteRequest}}
Response
{{inbCreateQuoteResponse}}

Sales Order

This service is to recieve existing sales orders in NAV. Please see Sales Archive

WSDL schema: Sales Order WSDL schema: Bulk Transfer Sales Order

  • Sales Header Fields , 1..n
    • vpn_keyNo* [String, Capital, max. length 20, 1..1]
      Specifies the number of the Sales order. Leave this empty when creating a new order. [Requieres auto incremented no. series in NAV.]

    • Sell-to Contact_No [String, Capital, max. length 20, 1..1]
      Specifies the number of the contact.

    • Sell-to Customer_No [String, Capital, max. length 20, 1..1]
      Specifies the number of the customer.

    • Sell-to Name [String, max. length 50, 0..1]
      Specifies the name.

    • Sell-to Name_2 [String, max. length 50, 0..1]
      Specifies the additional name.

    • Sell-to First_Name [String, max. length 30, 0..1]
      Specifies the first name.

    • Sell-to Surname [String, max. length 30, 0..1]
      Specifies the surname.

    • Sell-to Address [String, max. length 50, 1..1]
      Specifies the address. i.E. 'Hauptstraße 12b'

    • Sell-to Address_2 [String, max. length 50, 1..1]
      Specifies the add. address information.

    • Sell-to City [String, max. length 30, 1..1]
      Specifies the city.

    • Sell-to Post_Code [String, Capital, max. length 10, 0..1]
      Specifies a code for the post code of the address. Get a list of codes from the Master Data Service

    • Sell-to Country_Region_Code [String, Capital, max. length 10, 0..1]
      Specifies a code for the country/region of the address. Get a list of codes from the Master Data Service

    • Bill-to Contact_No [String, Capital, max. length 20, 1..1]
      Specifies the number of the contact.

    • Bill-to Customer_No [String, Capital, max. length 20, 1..1]
      Specifies the number of the customer.

    • Bill-to Name [String, max. length 50, 0..1]
      Specifies the name.

    • Bill-to Name_2 [String, max. length 50, 0..1]
      Specifies the additional name.

    • Bill-to First_Name [String, max. length 30, 0..1]
      Specifies the first name.

    • Bill-to Surname [String, max. length 30, 0..1]
      Specifies the surname.

    • Bill-to Address [String, max. length 50, 1..1]
      Specifies the address. i.E. 'Hauptstraße 12b'

    • Bill-to Address_2 [String, max. length 50, 1..1]
      Specifies the add. address information.

    • Bill-to City [String, max. length 30, 1..1]
      Specifies the city.

    • Bill-to Post_Code [String, Capital, max. length 10, 0..1]
      Specifies a code for the post code of the address. Get a list of codes from the Master Data Service

    • Bill-to Country_Region_Code [String, Capital, max. length 10, 0..1]
      Specifies a code for the country/region of the address. Get a list of codes from the Master Data Service

    • Ship-to Code [String, max. length 10, 0..1]
      Specifies the Ship-to Address Codes.

    • Ship-to Contact_No [String, Capital, max. length 20, 1..1]
      Specifies the number of the contact.

    • Ship-to Name [String, max. length 50, 0..1]
      Specifies the name.

    • Ship-to Name_2 [String, max. length 50, 0..1]
      Specifies the additional name.

    • Ship-to First_Name [String, max. length 30, 0..1]
      Specifies the first name.

    • Ship-to Surname [String, max. length 30, 0..1]
      Specifies the surname.

    • Ship-to Address [String, max. length 50, 1..1]
      Specifies the address. i.E. 'Hauptstraße 12b'

    • Ship-to Address_2 [String, max. length 50, 1..1]
      Specifies the add. address information.

    • Ship-to City [String, max. length 30, 1..1]
      Specifies the city.

    • Ship-to Post_Code [String, Capital, max. length 10, 0..1]
      Specifies a code for the post code of the address. Get a list of codes from the Master Data Service

    • Ship-to Country_Region_Code [String, Capital, max. length 10, 0..1]
      Specifies a code for the country/region of the address. Get a list of codes from the Master Data Service

    • External_Document_No [String, max. length 35, 0..1]
      Specifies the external document no. This must be unique in NAV. You'll receive an error when insert two orders with the same external document no.

    • Order_Date [DateTime, 0..1]
      Specifies the orders DateTime. Date is saved in NAV only!

    • Status [String, 1..1]
      Specifies the order status. Possible Values are "Open","Released","Pending Approval","Pending Prepayment" !

    • Due_Date [DateTime, 0..1]
      Specifies due date of the order.

    • Currency_Code [String, Capital, max. length 10, 0..1]
      Specifies a default currency code for the order. Get a list of codes from the Master Data Service

    • Shipping_Agent_Code [String, Capital, max. length 10, 0..1]
      Specifies a default shipping agent code for the order. Get a list of codes from the Master Data Service

    • Shipping_Agent_Service_Code [String, Capital, max. length 10, 0..1]
      Specifies a default shipping agent service code for the order. Get a list of codes from the Master Data Service

  • Sales Line Fields , 1..n
    • vpn_keyLine No* [Decimal, 1..1]
      Specifies the pos. number.

    • Type [String, 0..1]
      Specifies the Type: "Item", "Resource", "G/L Account"

    • No [String, Capital, max. length 20, 0..1]
      Specifies the No. i.E. Item No. "70000"

    • Variant_Code [String, Capital, max. length 10, 0..1]
      Specifies the item variant code

    • Description [String, max. length 50, 0..1]
      Specifies the Description.

    • Description_2 [String, max. length 50, 0..1]
      Specifies the additional Description.

    • Unit_Of_Measure_Code [String, Capital, max. length 10, 0..1]
      Specifies the sales unit of measure of the item.

    • Quantity [Decimal, 1..1]
      Specifies the quantity.

    • Line_Amount [Decimal, 0..1]
      Specifies the lines amount

    • Line_Discount_Percent [Decimal, 0..1]
      Specifies the lines discount percentage.

    • Line_Discount_Amount [Decimal, 0..1]
      Specifies the lines discount amount.

    • Shipment_Date [DateTime, 0..1]
      Specifies the lines shipment date.

    • Unit_Price [Decimal, 0..1]
      Specifies the lines unit price

    • Gross_Weight [Decimal, 0..1]
      Specifies the gross weight

    • Net_Weight [Decimal, 0..1]
      Specifies the gross weight

Supported Actions

  • Read
  • Read Multiple
  • Update
  • Update Multiple

Request
{{orderReadRequest}}
Response
{{orderReadResponse}}

Sales Archive

This service is to recieve archived sales orders in NAV.

WSDL schema: Sales Order Archive

  • Amount Fields [READ ONLY]
    • Amount [Decimal, 0..1]
      Amount

    • Amount_Incl_VAT [Decimal, 0..1]
      Amount incl. VAT

  • Header Fields
    • vpn_keyDocument No* [String, Capital, max. length 20, 1..1]
      Specifies the number of the Sales Order. Leave this empty when creating a new order. [Requieres auto incremented no. series in NAV.]

    • Order_Date [DateTime, 0..1]
      Specifies the order DateTime. Date is saved in NAV only!

    • Payment_Method_Code [String, Capital, max. length 10, 0..1]
      Specifies a default payment method code for the order. Get a list of codes from the Master Data Service

    • Completely_Shipped [Boolean, 0..1]
      Specifies whether order is shipped completely

  • Address Ship-to, Bill-to
    • Bill_to_Customer_No [String, Capital, max. length 20, 1..1]
      Specifies the number of the customer.

    • Contact_No [String, Capital, max. length 20, 1..1]
      Specifies the number of the contact.

    • Name [String, max. length 50, 0..1]
      Specifies the name.

    • Name_2 [String, max. length 50, 0..1]
      Specifies the additional name.

    • Address [String, max. length 50, 1..1]
      Specifies the address. i.E. 'Hauptstraße 12b'

    • Address_2 [String, max. length 50, 1..1]
      Specifies the add. address information.

    • City [String, max. length 30, 1..1]
      Specifies the city.

    • Post_Code [String, Capital, max. length 10, 0..1]
      Specifies a code for the post code of the address. Get a list of codes from the Master Data Service

    • Country_Region_Code [String, Capital, max. length 10, 0..1]
      Specifies a code for the country/region of the address. Get a list of codes from the Master Data Service

  • Sales Line Fields , 1..n
    • vpn_keyLine No* [Decimal, 1..1]
      Specifies the pos. number.

    • Type [String, 0..1]
      Specifies the Type: "Item", "Resource", "G/L Account"

    • No [String, Capital, max. length 20, 0..1]
      Specifies the No. i.E. Item No. "70000"

    • Variant_Code [String, Capital, max. length 10, 0..1]
      Specifies the item variant code

    • Description [String, max. length 50, 0..1]
      Specifies the Description.

    • Description_2 [String, max. length 50, 0..1]
      Specifies the additional Description.

    • Unit_Of_Measure_Code [String, Capital, max. length 10, 0..1]
      Specifies the sales unit of measure of the item.

    • Quantity [Decimal, 1..1]
      Specifies the quantity.

    • Line_Amount [Decimal, 0..1]
      Specifies the lines amount

    • Line_Amount_Incl_VAT [Decimal, 0..1]
      Specifies the lines amount incl. VAT.

    • Line_Discount_Percent [Decimal, 0..1]
      Specifies the lines discount percentage.

    • Line_Discount_Amount [Decimal, 0..1]
      Specifies the lines discount amount.

    • Shipment_Date [DateTime, 0..1]
      Specifies the lines shipment date.

    • Unit_Price [Decimal, 0..1]
      Specifies the lines unit price

    • Shipping_Agent_Code [String, Capital, max. length 10, 0..1]
      Specifies a default shipping agent code for the order. Get a list of codes from the Master Data Service

    • Shipping_Agent_Service_Code [String, Capital, max. length 10, 0..1]
      Specifies a default shipping agent service code for the order. Get a list of codes from the Master Data Service

  • Sales Shipment Dates and Sales Invoice No.'s , 0..1
    • Posting_Date [DateTime, 0..1]
      Specifies the posting date of the sales shipment

    • No [String, Capital, max. length 20, 0..1]
      Specifies the sales invoice no.

Supported Actions

  • GetSalesArchive

Request
{{outSalesArchiveRequest}}
Response
{{outSalesArchiveResponse}}

Sales Invoice

This service is to recieve posted sales invoices from NAV.

WSDL schema: Sales Invoice

  • Amount Fields [READ ONLY]
    • Amount [Decimal, 0..1]
      Amount without invoice discount

    • Total_Amount [Decimal, 0..1]
      Amount incl. invoice discount

    • Invoice_Discount_Amount [Decimal, 0..1]
      Invoice discount amount

    • Total_VAT_Amount [Decimal, 0..1]
      Total VAT amount

    • Amount_Incl_VAT [Decimal, 0..1]
      Amount incl. VAT

  • Header Fields
    • vpn_keyDocument No* [String, Capital, max. length 20, 1..1]
      Specifies the number of the Sales invoice. Leave this empty when creating a new invoice. [Requieres auto incremented no. series in NAV.]

    • Order_Date [DateTime, 0..1]
      Specifies the order DateTime. Date is saved in NAV only!

    • Shipment_Method_Code [String, Capital, max. length 50, 0..1]
      Specifies a default shipment method code for the order. Get a list of codes from the Master Data Service

    • Currency_Code [String, Capital, max. length 10, 0..1]
      Specifies a default currency code for the invoice. Get a list of codes from the Master Data Service

    • Shipping_Agent_Code [String, Capital, max. length 10, 0..1]
      Specifies a default shipping agent code for the order. Get a list of codes from the Master Data Service

    • Shipping_Agent_Service_Code [String, Capital, max. length 10, 0..1]
      Specifies a default shipping agent service code for the order. Get a list of codes from the Master Data Service

    • Customer_Order_No[String, Capital, max. length 20, 0..1]
      Specifies the customer's order no.

    • External_Document_No [String, max. length 35, 0..1]
      Specifies the external document no. This must be unique in NAV. You'll receive an error when insert two orders with the same external document no.

    • Payment_Method_Code [String, Capital, max. length 10, 0..1]
      Specifies a default payment method code for the invoice. Get a list of codes from the Master Data Service

    • Prices_Incl_VAT [Boolean, 0..1]
      Specifies the price to be incl. VAT

  • Address Sell-to, Ship-to, Bill-to
    • Customer_No [String, Capital, max. length 20, 1..1]
      Specifies the number of the customer.

    • Contact_No [String, Capital, max. length 20, 1..1]
      Specifies the number of the contact.

    • Code [String, max. length 10, 0..1]
      Specifies the Ship-to Address Codes.

    • Name [String, max. length 50, 0..1]
      Specifies the name.

    • Name_2 [String, max. length 50, 0..1]
      Specifies the additional name.

    • Address [String, max. length 50, 1..1]
      Specifies the address. i.E. 'Hauptstraße 12b'

    • Address_2 [String, max. length 50, 1..1]
      Specifies the add. address information.

    • City [String, max. length 30, 1..1]
      Specifies the city.

    • Post_Code [String, Capital, max. length 10, 0..1]
      Specifies a code for the post code of the address. Get a list of codes from the Master Data Service

    • Country_Region_Code [String, Capital, max. length 10, 0..1]
      Specifies a code for the country/region of the address. Get a list of codes from the Master Data Service

  • Payment Block
    • TX_ID [String, Capital, max. length 80, 1..1]
      Specifies the payment transaction no.

    • TX_Code [String, Capital, max. length 20, 1..1]
      Specifies the transaction auth. code

    • TX_Amount [String, max. length 10, 0..1]
      Specifies the amount

  • Sales Invoice Line Fields , 1..n
    • vpn_keyLine No* [Decimal, 1..1]
      Specifies the pos. number.

    • Type [String, 0..1]
      Specifies the Type: "Item", "Resource", "G/L Account"

    • No [String, Capital, max. length 20, 0..1]
      Specifies the No. i.E. Item No. "70000"

    • Variant_Code [String, Capital, max. length 10, 0..1]
      Specifies the item variant code

    • Description [String, max. length 50, 0..1]
      Specifies the Description.

    • Description_2 [String, max. length 50, 0..1]
      Specifies the additional Description.

    • Unit_Of_Measure_Code [String, Capital, max. length 10, 0..1]
      Specifies the sales unit of measure of the item.

    • Quantity [Decimal, 1..1]
      Specifies the quantity.

    • Line_Amount [Decimal, 0..1]
      Specifies the lines amount

    • Line_Amount_Incl_VAT [Decimal, 0..1]
      Specifies the lines amount incl. VAT.

    • Line_Discount_Percent [Decimal, 0..1]
      Specifies the lines discount percentage.

    • Line_Discount_Amount [Decimal, 0..1]
      Specifies the lines discount amount.

    • Shipment_Date [DateTime, 0..1]
      Specifies the lines shipment date.

    • Unit_Price [Decimal, 0..1]
      Specifies the lines unit price

Supported Actions

  • GetSalesInvoice
  • GetSalesInvoiceByDate
  • GetSalesInvoiceAsPDF

Request
{{outSalesInvoiceGetRequest}}
Response
{{outSalesInvoiceGetResponse}}

Request
{{outSalesInvoiceGetByDateRequest}}
Response
{{outSalesInvoiceGetByDateResponse}}

Request
{{outSalesInvoiceGetAsPDFRequest}}
Response
{{outSalesInvoiceGetAsPDFResponse}}

Sales Shipment

This service is to recieve posted sales shipments from NAV.

WSDL schema: Sales Shipment

  • Header Fields
    • vpn_keyDocument No* [String, Capital, max. length 20, 1..1]
      Specifies the number of the Sales invoice. Leave this empty when creating a new invoice. [Requieres auto incremented no. series in NAV.]

    • Order_Date [DateTime, 0..1]
      Specifies the order DateTime. Date is saved in NAV only!

    • Shipment_Method_Code [String, Capital, max. length 50, 0..1]
      Specifies a default shipment method code for the order. Get a list of codes from the Master Data Service

    • Currency_Code [String, Capital, max. length 10, 0..1]
      Specifies a default currency code for the invoice. Get a list of codes from the Master Data Service

    • Shipping_Agent_Code [String, Capital, max. length 10, 0..1]
      Specifies a default shipping agent code for the order. Get a list of codes from the Master Data Service

    • Shipping_Agent_Service_Code [String, Capital, max. length 10, 0..1]
      Specifies a default shipping agent service code for the order. Get a list of codes from the Master Data Service

    • Customer_Order_No[String, Capital, max. length 20, 0..1]
      Specifies the customer's order no.

    • External_Document_No [String, max. length 35, 0..1]
      Specifies the external document no. This must be unique in NAV. You'll receive an error when insert two orders with the same external document no.

    • Payment_Method_Code [String, Capital, max. length 10, 0..1]
      Specifies a default payment method code for the invoice. Get a list of codes from the Master Data Service

    • Prices_Incl_VAT [Boolean, 0..1]
      Specifies the price to be incl. VAT

  • Address Sell-to, Ship-to, Bill-to
    • Customer_No [String, Capital, max. length 20, 1..1]
      Specifies the number of the customer.

    • Contact_No [String, Capital, max. length 20, 1..1]
      Specifies the number of the contact.

    • Code [String, max. length 10, 0..1]
      Specifies the Ship-to Address Codes.

    • Name [String, max. length 50, 0..1]
      Specifies the name.

    • Name_2 [String, max. length 50, 0..1]
      Specifies the additional name.

    • Address [String, max. length 50, 1..1]
      Specifies the address. i.E. 'Hauptstraße 12b'

    • Address_2 [String, max. length 50, 1..1]
      Specifies the add. address information.

    • City [String, max. length 30, 1..1]
      Specifies the city.

    • Post_Code [String, Capital, max. length 10, 0..1]
      Specifies a code for the post code of the address. Get a list of codes from the Master Data Service

    • Country_Region_Code [String, Capital, max. length 10, 0..1]
      Specifies a code for the country/region of the address. Get a list of codes from the Master Data Service

  • Sales Shipment Line Fields , 1..n
    • vpn_keyLine No* [Decimal, 1..1]
      Specifies the pos. number.

    • Type [String, 0..1]
      Specifies the Type: "Item", "Resource", "G/L Account"

    • No [String, Capital, max. length 20, 0..1]
      Specifies the No. i.E. Item No. "70000"

    • Variant_Code [String, Capital, max. length 10, 0..1]
      Specifies the item variant code

    • Description [String, max. length 50, 0..1]
      Specifies the Description.

    • Description_2 [String, max. length 50, 0..1]
      Specifies the additional Description.

    • Unit_Of_Measure_Code [String, Capital, max. length 10, 0..1]
      Specifies the sales unit of measure of the item.

    • Quantity [Decimal, 1..1]
      Specifies the quantity.

    • Line_Amount [Decimal, 0..1]
      Specifies the lines amount

    • Line_Amount_Incl_VAT [Decimal, 0..1]
      Specifies the lines amount incl. VAT.

    • Line_Discount_Percent [Decimal, 0..1]
      Specifies the lines discount percentage.

    • Line_Discount_Amount [Decimal, 0..1]
      Specifies the lines discount amount.

    • Shipment_Date [DateTime, 0..1]
      Specifies the lines shipment date.

    • Unit_Price [Decimal, 0..1]
      Specifies the lines unit price

Supported Actions

  • GetSalesShipment
  • GetSalesShipmentByDate
  • GetSalesShipmentAsPDF

Request
{{outSalesShipmentGetRequest}}
Response
{{outSalesShipmentGetResponse}}

Request
{{outSalesShipmentGetByDateRequest}}
Response
{{outSalesShipmentGetByDateResponse}}

Request
{{outSalesShipmentGetAsPDFRequest}}
Response
{{outSalesShipmentGetAsPDFResponse}}

Sales Credit Memo

This service is to recieve posted sales credit memos from NAV.

WSDL schema: Sales Credit Memo

  • Amount Fields [READ ONLY]
    • Amount [Decimal, 0..1]
      Amount without invoice discount

    • Total_Amount [Decimal, 0..1]
      Amount incl. invoice discount

    • Invoice_Discount_Amount [Decimal, 0..1]
      Invoice discount amount

    • Total_VAT_Amount [Decimal, 0..1]
      Total VAT amount

    • Amount_Incl_VAT [Decimal, 0..1]
      Amount incl. VAT

  • Header Fields
    • vpn_keyDocument No* [String, Capital, max. length 20, 1..1]
      Specifies the number of the Sales Credit Memo. Leave this empty when creating a new invoice. [Requieres auto incremented no. series in NAV.]

    • Document_Date [DateTime, 0..1]
      Specifies the Document DateTime. Date is saved in NAV only!

    • Shipment_Method_Code [String, Capital, max. length 50, 0..1]
      Specifies a default shipment method code for the order. Get a list of codes from the Master Data Service

    • Currency_Code [String, Capital, max. length 10, 0..1]
      Specifies a default currency code for the invoice. Get a list of codes from the Master Data Service

    • Shipping_Agent_Code [String, Capital, max. length 10, 0..1]
      Specifies a default shipping agent code for the order. Get a list of codes from the Master Data Service

    • Shipping_Agent_Service_Code [String, Capital, max. length 10, 0..1]
      Specifies a default shipping agent service code for the order. Get a list of codes from the Master Data Service

    • Customer_Order_No[String, Capital, max. length 20, 0..1]
      Specifies the customer's order no.

    • External_Document_No [String, max. length 35, 0..1]
      Specifies the external document no. This must be unique in NAV. You'll receive an error when insert two orders with the same external document no.

    • Payment_Method_Code [String, Capital, max. length 10, 0..1]
      Specifies a default payment method code for the invoice. Get a list of codes from the Master Data Service

    • Prices_Incl_VAT [Boolean, 0..1]
      Specifies the price to be incl. VAT

  • Address Sell-to, Ship-to, Bill-to
    • Customer_No [String, Capital, max. length 20, 1..1]
      Specifies the number of the customer.

    • Contact_No [String, Capital, max. length 20, 1..1]
      Specifies the number of the contact.

    • Code [String, max. length 10, 0..1]
      Specifies the Ship-to Address Codes.

    • Name [String, max. length 50, 0..1]
      Specifies the name.

    • Name_2 [String, max. length 50, 0..1]
      Specifies the additional name.

    • Address [String, max. length 50, 1..1]
      Specifies the address. i.E. 'Hauptstraße 12b'

    • Address_2 [String, max. length 50, 1..1]
      Specifies the add. address information.

    • City [String, max. length 30, 1..1]
      Specifies the city.

    • Post_Code [String, Capital, max. length 10, 0..1]
      Specifies a code for the post code of the address. Get a list of codes from the Master Data Service

    • Country_Region_Code [String, Capital, max. length 10, 0..1]
      Specifies a code for the country/region of the address. Get a list of codes from the Master Data Service

  • Sales Credit Memo Line Fields , 1..n
    • vpn_keyLine No* [Decimal, 1..1]
      Specifies the pos. number.

    • Type [String, 0..1]
      Specifies the Type: "Item", "Resource", "G/L Account"

    • No [String, Capital, max. length 20, 0..1]
      Specifies the No. i.E. Item No. "70000"

    • Variant_Code [String, Capital, max. length 10, 0..1]
      Specifies the item variant code

    • Description [String, max. length 50, 0..1]
      Specifies the Description.

    • Description_2 [String, max. length 50, 0..1]
      Specifies the additional Description.

    • Unit_Of_Measure_Code [String, Capital, max. length 10, 0..1]
      Specifies the sales unit of measure of the item.

    • Quantity [Decimal, 1..1]
      Specifies the quantity.

    • Line_Amount [Decimal, 0..1]
      Specifies the lines amount

    • Line_Amount_Incl_VAT [Decimal, 0..1]
      Specifies the lines amount incl. VAT.

    • Line_Discount_Percent [Decimal, 0..1]
      Specifies the lines discount percentage.

    • Line_Discount_Amount [Decimal, 0..1]
      Specifies the lines discount amount.

    • Shipment_Date [DateTime, 0..1]
      Specifies the lines shipment date.

    • Unit_Price [Decimal, 0..1]
      Specifies the lines unit price

Supported Actions

  • GetSalesCreditMemo
  • GetSalesCreditMemoByDate
  • GetSalesCreditMemoAsPDF

Request
{{outSalesCMGetRequest}}
Response
{{outSalesCMGetResponse}}

Request
{{outSalesCMGetByDateRequest}}
Response
{{outSalesCMGetByDateResponse}}

Request
{{outSalesCMGetAsPDFRequest}}
Response
{{outSalesCMGetAsPDFResponse}}

Master Data

This service provides master data from Dynamics NAV. These are i.e. currency code, country codes available shipping agents, shipment terms etc. These codes have to be used in various services, what makes this service very mandatory to use.

WSDL schema: Master Data

  • Master Data Tables
    • Language [0..n]
      Specifies language codes

    • Currency [0..n]
      Specifies currency codes

    • Country [0..n]
      Specifies country codes

    • Shipment Method [0..n]
      Specifies shipment method codes

    • Unit Of Measure [0..n]
      Specifies unit of measure codes

    • Payment Terms [0..n]
      Specifies payment terms codes

    • Payment Meathod [0..n]
      Specifies payment method codes

    • Shipping Agent [0..n]
      Specifies shipping agent codes

    • Shipping Agent Service [0..n]
      Specifies shipping agent service codes

    • Salutation [0..n]
      Specifies salutation codes

    • Customer Template [0..n]
      Specifies customer template codes

    • Customer Price Group [0..n]
      Specifies customer price groups codes

    • Responsibility Center [0..n]
      Specifies responsibility center codes

    • Item Category [0..n]
      Specifies item category codes

    • Product Group [0..n]
      Specifies product group codes

Supported Actions

  • OutboundMasterDataTransfer

Request
{{outMasterDataGetRequest}}
Response
{{outMasterDataGetResponse}}

Item Transfer

This service provides can be used to bulk synchronize items to the web shop. Large sizes can be transferd.

WSDL schema: Item Transfer

  • Item
    • vpn_keyNo [String, Capital, max. length 20, 1..1]
      Specifies the item no.

    • No_2 [String, Capital, max. length 20, 0..1]
      Secondary Item Number.

    • Description [String, max. length 50, 0..1]
      Primary item description

    • Description_2 [String, max. length 50, 0..1]
      Secondary item description

    • Search_Description [String, Capital, max. length 50, 0..1]
      Search description. This value is generated in NAV for indexing purposes.

    • Base_Unit_of_Measure [String, Capital , max. length 10, 1..1]
      The Base UOM is used to indicate the base unit of the item. i.E. 'STÜCK'. Get a list of codes from the Master Data Service

    • Sales_Unit_of_Measure [String, Capital , max. length 10, 1..1]
      The Base UOM is used to indicate the sales unit of the item. i.E. 'KARTON'. Get a list of codes from the Master Data Service

    • Country_Region_Purchased_Code [String, Capital, max. length 10, 0..1]
      Specifies a code for the country/region in which the item was produced or processed. Get a list of codes from the Master Data Service

    • Country_Region_of_Origin_Code [String, Capital, max. length 10, 0..1]
      Specifies a code for the country/region in which the item was produced or processed. Get a list of codes from the Master Data Service

    • Freight_Type [String, Capital, max. length 10, 0..1]
      Specifies how the item is shipped.

    • Gross_Weight [Decimal, 0..1]
      Specifies the gross weight of the item.

    • Net_Weight [Decimal, 0..1]
      Specifies the net weight of the item.

    • Unit_Volume [Decimal, 0..1]
      Specifies the volume of one unit of the item.

    • Blocked [Boolean, 0..1]
      Specifies whether an item is blocked

    • Last_Date_Modified [Datetime, 0..1]
      Shows when the item card was last modified.

    • Price_Includes_VAT [Boolean, 0..1]
      Indicates item's price included VAT.

    • Gen_Prod_Posting_Group [String, Capital, max. length 10, 0..1]

    • VAT_Prod_Posting_Group [String, Capital, max. length 10, 0..1]
      Specifies the VAT product posting group to which this item belongs.

    • VAT_Bus_Posting_Gr_Price [String, Capital, max. length 10, 0..1]
      Specifies a VAT business posting group for customers for whom you want the item price including VAT, as shown in the Unit Price field, to apply.

    • Tax_Group_Code [String, Capital, max. length 10, 0..1]
      Specifies the sales tax group code to which this item belongs.

    • Manufacturer_Code [String, Capital, max. length 10, 0..1]
      Specifies the code that identifies the manufacturer of the item.

    • Item_Category_Code [String, Capital, max. length 10, 0..1]
      Contains the item category code for the item. Get a list of codes from the Master Data Service

    • Product_Group_Code [String, Capital, max. length 10, 0..1]
      Contains a product group code that relates to the item category that is assigned to the item. Get a list of codes from the Master Data Service

    • Expiration_Calculation [String, 0..1]
      Indicates when this item will expire.

    • Common_Item_No. [String, Capital, max. length 20, 0..1]
      Specifies another item no. that ist common between the systems.

    • Webshop_Item [Boolean, 0..1]
      Indicates whether this item sold in the web shop.

    • Item_Discount_Group [String, Capital, max. length 20, 0..1]
      Specifies the item discount group code.

  • Item Variant
    • vpn_keyCode [String, Capital, max. length 20, 0..1]
      Indicates the item variant code for this item.

    • Description [String, max. length 50, 0..1]
      Primary item description

    • Description_2 [String, max. length 50, 0..1]
      Secondary item description

  • Item Vendor
    • vpn_keyVendor_No [String, Capital, max. length 20, 0..1]
      Specifies the vendor no.

    • Lead_Time_Calculation [String, 0..1]

      Lead time as calculation string.
    • Vendor_Item_No [String, Capital, max. length 20, 0..1]
      Specifies the vendor item no.

    • vpn_keyVariant_code [String, Capital, max. length 10, 0..1]
      Specifies

  • Item Sales Price
    • vpn_keySales_Type [String, 0..1]
      Specifies the Sales Type. There several Sales types that correspond with the sales code. "Customer","Customer Price Group","All Customers","Campaign"

    • vpn_keySales_Code [String, Capital, max. length 20, 0..1]
      The sales code is the code, corresponding to the sales type.

    • vpn_keyStarting_Date [DateTime, 0..1]

      Specifies the starting date of the item sales price.
    • vpn_keyCurrency_Code [String, Capital, max. length 10, 0..1]
      Specifies the currency code.

    • vpn_keyVariant_Code [String, Capital, max. length 10, 0..1]

      Specifies the variant code.
    • vpn_keyUnit_Of_Measure_Code [String, Capital, max. length 10, 0..1]
      Specifies the unit of measure code.

    • vpn_keyMinimum_Quantity [Decimal, 0..1]
      Minimum quantity. Zero is empty.

    • Ending_Date [DateTime, 0..1]
      Specifies the ending date.

    • Unit_Price [DateTime, 0..1]
      Specifies the unit price.

  • Item Translation
    • vpn_keyLanguage_code [String, Capital, max. length 10, 0..1]
      Specifies the language code

    • Description [String, max. length 50, 0..1]
      Primary item description translation

    • Description_2 [String, max. length 50, 0..1]
      Secondary item description translation

    • vpn_keyVariant_code [String, Capital, max. length 10, 0..1]
      Specifies the Variant code

  • Item Attributes
    • vpn_keyID [integer, 1..1]
      The attribute ID.

    • vpn_keyValue_ID [integer, 1..1]
      The value ID.

    • Name [String, Capital, max. length 250, 1..1]
      Specifies the attribute name.

    • Value [String, Capital, max. length 250, 1..1]
      The attribute value.

Supported Actions

  • ItemTransfer

Request
{{outItemTransferGetRequest}}
Response
{{outItemTransferGetResponse}}

Item Availability

Receive item availabilities through this service.

WSDL schema: Item Availability

  • Item Availability
    • vpn_keyNo [String, Capital, max. length 20, 1..1]
      Specifies the item no.

    • Availability [Decimal, 1..1]
      Contains the item availability

  • Variant Availability
    • Code [String, Capital, max. length 10, 0..1]
      Specifies the variant code

    • Description [String, max. length 30, 0..1]
      Contains the variant description.

    • Description [String, max. length 30, 0..1]
      Contains the additional variant description.

    • Variant_Availability [Decimal, 0..1]
      Contains the variant availability

Supported Actions

  • GetItemAvailability

Request
{{outItemAvailGetRequest}}
Response
{{outItemAvailGetResponse}}

Item Sales Price

Receive item sales price through this service.

WSDL schema: Item Sales Price

    • vpn_keySales_Type [String, 0..1]
      Specifies the Sales Type. There several Sales types that correspond with the sales code. "Customer","Customer Price Group","All Customers","Campaign"

    • vpn_keySales_Code [String, Capital, max. length 20, 0..1]
      The sales code is the code, corresponding to the sales type.

    • vpn_keyStarting_Date [DateTime, 0..1]

      Specifies the starting date of the item sales price.
    • vpn_keyCurrency_Code [String, Capital, max. length 10, 0..1]
      Specifies the currency code.

    • vpn_keyVariant_Code [String, Capital, max. length 10, 0..1]

      Specifies the variant code.
    • vpn_keyUnit_Of_Measure_Code [String, Capital, max. length 10, 0..1]
      Specifies the unit of measure code.

    • vpn_keyMinimum_Quantity [Decimal, 0..1]
      Minimum quantity. Zero is empty.

    • Ending_Date [DateTime, 0..1]
      Specifies the ending date.

    • Unit_Price [DateTime, 0..1]
      Specifies the unit price.

Supported Actions

  • GetItemSalesPrice

Request
{{outItemSalesPriceGetRequest}}
Response
{{outItemSalesPriceGetResponse}}

Campaign

This service can be used to bulk synchronize campaigns to the web shop. Large sizes can be transferd.

WSDL schema: Campaign

  • Campaign
    • vpn_keyNo [String, Capital, max. length 20, 1..1]
      Specifies the campaign no.

    • Description [String, max. length 50, 0..1]
      Primary Campaign description

    • Starting_Date [DateTime, 1..1]

      Specifies campaign starting date.
    • Ending_Date [DateTime, 1..1]

      Specifies campaign ending date.
    • Status_Code [String, Capital , max. length 10, 1..1]
      Status code of the campaign.

    • Activated [Boolean, 0..1]
      Specifies whether this campaign is activated.

Supported Actions

  • GetCampaigns

Request
{{outboundCampaignRequest}}
Response
{{outboundCampaignResponse}}

Line Discount Group

This service can be used to bulk synchronize Line Discount Group to the web shop. Large sizes can be transferd.

WSDL schema: Line Discount Group

  • Sales Line Discount
    • vpn_keyCode [String, Capital, max. length 20, 1..1]
      Specifies the group code

    • Sales_Type [String, 1..1]
      1-4: Customer,Customer Disc. Group,All Customers,Campaign

    • Sales_Code [String, max. length 10, 1..1]
      Corresponding Code to Sales Type

    • Currency_Code [String, max. length 10, 1..1]
      Currency Code

    • Starting_Date [DateTime, 1..1]

      Specifies Line Discount starting date.
    • Minimum_Quantity [Decimal, 1..1]
      Contains the minimum Quantity

    • Unit_Of_Measure_Code [String, Capital , max. length 10, 1..1]
      specifies the Unit of measure code

    • Variant_Code [String, Capital , max. length 10, 1..1]
      Variant Code

    • Line_Discount_Percentage [Decimal, 0..1]
      Line discount percentage

    • Ending_Date [DateTime, 1..1]
      Specifies Line Discount ending date

Supported Actions

  • GetLineDiscountGroups

Request
{{outLineDiscountGroupRequest}}
Response
{{outLineDiscountGroupResponse}}

Web Changes

Periodically call this service to receive changes made in defined tables in Dynamics NAV.

WSDL schema: Web Changes

    • vpn_keyEntryNo [Integer, 1..1]

      Index no. of the web changes table
    • TableID [Integer, 1..1]

      Table ID of the changed data
    • PrimaryKey1 [String, Capital, max. length 20, 1..1]

      Primary key part of changed data
    • PrimaryKey2 [String, Capital, max. length 20, 1..1]

      Primary key part of changed data
    • PrimaryKey3 [Integer, 1..1]

      Primary key part of changed data
    • CreatedAt [DateTime, 1..1]

      Specifies whether record was created.
    • Deleted [Boolean, 1..1]

      Specifies whether record was deleted.

Supported Actions

  • GetWebChanges

Request
{{outWebChangesGetRequest}}
Response
{{outWebChangesGetResponse}}

Item Attributes

This service returns the available attributes and associated values. It also returns Translations for both names and values.

WSDL schema: Item Attributes

  • Item Attribute Result
    • Name [String, Capital, max. length 250, 1..1]
      Specifies the attribute name.

    • Unit_of_Measure [String, Capital, max. length 30, 0..1]
      Specifies the attribute name.

    • Value [String, Capital, max. length 250, 1..1]
      The attribute value.

    • Numeric_Value [Decimal, 0..1]
      If available this contains the decimal/int value to a string.

    • Blocked [boolean, 0..1]
      Specifies wheter this is a valid attribute.

    • Attribute_ID [integer, 1..1]
      The attribute ID.

    • Value_ID [integer, 1..1]
      The value ID.

    • Code [String, Capital, max. length 10 ,0..1]
      If translations are available this specifies the NAV language code.

Supported Actions

  • GetItemAttributes

Request
{{outItemAttributesRequest}}
Response
{{outItemAttributesResponse}}