inboundSalesOrder resource type

Represents an inbound sales order in Business Central.

Availability Information

This endpoint is only available if KatarGo is installed. Click here for the documentation without KatarGo.

Note

For information about enabling APIs for Business Central see Enabling the APIs for Dynamics 365 Business Central.

Methods

Method	Return Type	Description
GET inboundSalesOrder	inbound sales order	Gets an inbound sales order object.
DELETE inboundSalesOrder	inbound sales order	Deletes an inbound sales order object.
POST inboundSalesOrder	inbound sales order	Creates an inbound sales order object.
PATCH inboundSalesOrder	inbound sales order	Updates an inbound sales order object.

Navigation	Return Type	Description
inboundSalesOrderLinesWebCon	inboundSalesOrderLines	Gets the inboundSalesOrderLines to the inbound sales order
inboundSalesOrderCommentsWebCon	inboundSalesOrderComments	Gets the inboundSalesOrderComments to the inbound sales order

Properties

Property	Type	Description	Max Length
🔑 id	GUID	The unique ID of the inbound sales order. Non-editable.
number	String	Specifies inbound sales order no. Non-editable.	20
externalDocumentNumber	String	Specifies an external document number for the inbound sales order.	35
documentDate	DateTime	The document date.
orderDate	DateTime	The order date.
orderTime	Time	The order time.
postingDate	DateTime	The posting date.
requestedDeliveryDate	DateTime	The requested delivery date.
customerId	GUID	The unique ID of customer.
customerNumber	String	The customer's number.	20
contactId	GUID	The unique ID of contact.
contactNumber	String	The contact's number.	20
sellToCustomerTemplateId	GUID	The unique ID of the sell-to customer template.
sellToCustomerTemplateCode	String	The sell-to customer template number.	20
billToCustomerTemplateId	GUID	The unique ID of the bill-to customer template.
billToCustomerTemplateCode	String	The bill-to customer template number.	20
customerName	String	The customer's name.	100
customerName2	String	The customer's name 2.	50
customerFirstName	String	The customer's first name.	50
customerSurName	String	The customer's surname.	50
billToName	String	Bill to name.	100
billToName2	String	Bill to name 2.	50
billToFirstName	String	Bill to first name.	50
billToSurName	String	Bill to surname.	50
billToCustomerId	GUID	The unique ID of the bill-to customer.
billToCustomerNumber	String	Specifies campaign starting date.	20
billToContactId	GUID	The unique ID of the bill-to contact.
billToContactNumber	String	Bill to customer number.	20
shipToName	String	Ship to name.	100
shipToName2	String	Ship to name 2.	50
shipToFirstName	String	Ship to firstname.	50
shipToSurName	String	Ship to surname.	50
shipToContact	String	Ship to contact.	100
sellToAddressLine1	String	Sell to address line 1.	100
sellToAddressLine2	String	Sell to address line 2.	50
sellToCity	String	Sell to city.	30
sellToCountry	String	Sell to country.
sellToState	String	Sell to state.	30
sellToPostCode	String	Sell to post code.	20
billToAddressLine1	String	Bill to address line 1.	100
billToAddressLine2	String	Bill to address line 2.	50
billToCity	String	Bill to city.	30
billToCountry	String	Bill to country.
billToState	String	Bill to state.	30
billToPostCode	String	Bill to post code.	20
shipToAddressLine1	String	Ship to address line 1.	100
shipToAddressLine2	String	Ship to address line 2.	50
shipToCity	String	Ship to city.	30
shipToCountry	String	Ship to country.
shipToState	String	Ship to state.	30
shipToPostCode	String	Ship to post code.	20
shipToPostNumber	String	Ship to post number.	10
shipToParcelStationNumber	String	Ship to parcel station number.	10
shipToPostOfficeNumber	String	Ship to post office number.	10
currencyId	GUID	Specifies which currency the inbound sales order uses.
currencyCode	String	The default currency code for the inbound sales order.
pricesIncludeTax	Boolean	Specifies whether the prices include Tax or not.
paymentTermsId	GUID	Specifies which payment term the inbound sales order uses.
paymentMethodId	GUID	Specifies which payment method the inbound sales order uses.
paymentMethodCode	String	Specifies which payment method the inbound sales order uses.	10
shipmentMethodId	GUID	Specifies which shipment method the sales order uses.
shipmentMethodCode	String	Specifies which shipment method the sales order uses.	10
shippingAgentId	GUID	Specifies which shipment agent the sales order uses.
shippingAgentCode	String	Specifies which shipment agent the sales order uses.	10
shippingAgentServiceId	GUID	Specifies which shipment agent service the sales order uses.
shippingAgentServiceCode	String	Specifies which shipment agent service the sales order uses.	10
campaignId	GUID	Specifies which campaign the sales order uses.
campaignNumber	String	Specifies which campaign the sales order uses.	20
responsibilityCenterId	GUID	Specifies which responsibility center the sales order uses.
responsibilityCenter	String	Specifies which responsibility center the sales order uses.	10
salesperson	String	The salesperson code for the inbound sales order.	20
lastModifiedDateTime	DateTime	The last datetime the inbound sales order was modified. Read-Only.
phoneNumber	String	Specifies the inbound sales order's telephone number.	50
email	String	Specifies the inbound sales order's email address.	80
vatRegistrationNumber	String	Specifies the vat registration number.	20
billToVATRegistrationNumber	String	Specifies the bill to vat registration number.	20
shipToCode	String	Specifies the ship to code.	10
~~paymentTransactionId~~	~~string~~	~~The payment provider transaction id.~~
~~paymentTransactionCode~~	~~String~~	~~The payment provider transaction code.~~
~~paymentTransactionAmount~~	~~decimal~~	~~The payment provider transaction amount.~~
paymentTransactionNo	string	The payment provider transaction number.	70
transactionAmountPayment	decimal	The payment provider transaction amount.
languageCode	String	Specifies the language code.	10
yourReference	String	Specified the shop reference number.	35
documentSourcecode	String	Specified the document sourcecode. The value must be filled to exactly match the document source code table in BC.	10
distributionChannelCode	String	Specifies the distribution channel.	10
~~calulateFreight~~	~~Boolean~~	~~Specifies whether the KatarGo freight costs are to be determined.~~
freightAmount	Decimal	Specifies the freight amount. Based on this amount, a G/L account line is written into the order.
freightConditionCode	String	Specifies the freight Condition Code. Based on the freight conditions, the freight costs are transferred to the sales order as a G/L account line. The corresponding G/L account is derived from the booking matrix.

Best practice

Freight Costs

Freight costs can be managed via the freight conditions (Freight Conditions). If no freight conditions are transferred in the incoming sales document, the default freight condition is taken from the Inbound Sales Document Setup.

Based on the freight conditions, the freight costs are transferred to the sales order as a G/L account line. The corresponding G/L account is derived from the booking matrix.

Calculating Freight Costs in Business Central

To enable Business Central to calculate freight costs automatically, the following conditions must be met:

A shipment method must be specified with the property Calculate Freight = true.
This can be provided via the shipmentMethodId or shipmentMethodCode.

Accepting Freight Costs from the Shop

To use freight costs provided directly by the shop, the following parameters must be set:

A shipment method with the property Calculate Freight = false, provided via shipmentMethodId or shipmentMethodCode.
The freight cost value must be set in the freightAmount field.

Warning

Avoid relying on the calculateFreight field from the API, as it is usually overridden by the configured shipment method.
This field is deprecated and may be removed in future versions.