inboundReturnOrder resource type

Represents an inbound return 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 inboundReturnOrder	inbound return order	Gets an inbound return order object.
DELETE inboundReturnOrder	inbound return order	Deletes an inbound return order object.
POST inboundReturnOrder	inbound return order	Creates an inbound return order object.
PATCH inboundReturnOrder	inbound return order	Updates an inbound return order object.

Navigation	Return Type	Description
inboundReturnOrderLinesWebCon	inboundReturnOrderLines	Gets the inboundReturnOrderLines for the inbound return order
inboundReturnOrderCommentsWebCon	inboundReturnOrderComments	Gets the inboundReturnOrderComments for the inbound return order

Properties

Property	Type	Description	Max Length
🔑 id	GUID	The unique ID of the inbound return order. Non-editable.
number	String	Specifies inbound return order no. Non-editable.	20
externalDocumentNumber	String	Specifies an external document number for the inbound return 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 return order uses.
shipmentMethodCode	String	Specifies which shipment method the return order uses.	10
shippingAgentId	GUID	Specifies which shipment agent the return order uses.
shippingAgentCode	String	Specifies which shipment agent the return order uses.	10
shippingAgentServiceId	GUID	Specifies which shipment agent service the return order uses.
shippingAgentServiceCode	String	Specifies which shipment agent service the return order uses.	10
campaignId	GUID	Specifies which campaign the return order uses.
campaignNumber	String	Specifies which campaign the return order uses.	20
responsibilityCenterId	GUID	Specifies which responsibility center the return order uses.
responsibilityCenter	String	Specifies which responsibility center the return order uses.	10
salesperson	String	The salesperson code for the inbound return order.	20
lastModifiedDateTime	DateTime	The last datetime the inbound return order was modified. Read-Only.
phoneNumber	String	Specifies the inbound return order's telephone number.	50
email	String	Specifies the inbound return 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
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
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.	10
returnReasonCode	String	Specifies the main reason for the return (e.g., wrong address, long delivery time, delivery refused).	10

Best practice

How to handle return orders

Inbound return orders support both returns with a reference to an existing invoice and returns without a reference.

Without invoice reference: Leave appliesToInvoiceId and appliesToInvoiceNumber empty. The same validations as for a sales order are applied, and a return document is created.
With invoice reference: Provide either appliesToInvoiceId or appliesToInvoiceNumber. The referenced invoice must exist, otherwise the return order cannot be created.

Important: - When a return order references an invoice, the system internally uses the "Copy Document" function. The return is prefilled with data from the original invoice (for example, addresses, payment method, etc.). - You may omit fields in your request when they are identical to the invoice values. However, to ensure accuracy, we recommend supplying all known values and explicitly overriding any prefilled fields that could differ. - You can als omit the return order lines, when it is a full cancelation, and you want simply to cancel the whole invoice.