# vnt_transferorders.transferorders_createnewitem_: Visma.net Financials Package for TransferOrders operations that could not be mapped to a table.
vnt_transferorders.transferorders_createnewitem_: Visma.net Financials Package for TransferOrders operations that could not be mapped to a table.
The customer of a transfer order is the own organisation account of the destination warehouse's branch,
its ship-to address and contact are those of the destination warehouse unless `shipping.address` or
`shipping.contact` overrides them, and its bill-to address and contact those of the organisation account. Lines are never priced and the order is always in the base currency.
Shipping settings that are not given (ship via, FOB point, terms, zone, preferred warehouse, priority and the
delivery flags) take the defaults of the organisation account's location, as in the Classic UI. A line without
`warehouseId` is transferred from the preferred warehouse of the order when it has one. A line without
`purchaseOrderSource` is marked for purchase order when its item's warehouse has the purchase to order or drop
ship replenishment source, except on an order type that requires allocation, and takes the item's preferred
supplier when `supplierId` is not given, as in the Classic UI. `allocations` sets lot or serial numbers and
allocated quantities as on a sales order line; an order type requiring lot or serial entry or stock allocation
assigns or allocates the rest at entry.
Sample request:
```
POST /transferorders
{
"type": "TR",
"destinationWarehouseId": "MAIN",
"description": "Replenish the main warehouse",
"orderLines": [
{ "inventoryId": "ITEM1", "warehouseId": "STORE", "quantity": 5 }
]
}
```Parameters of Procedure
The following parameters can be used to control the behaviour of the procedure `vnt_transferorders.transferorders_createnewitem_`. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example: a `begin package.procedure(value1, value2, value3); end` on a procedure with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `begin package.procedure(name1 => value1, name3 => value3); end` on the same procedure will use the default values for the second and fourth parameters and the specified values for the first and third.
| Name | Data Type | Required | Default Value | Documentation |
|---|:---:|:---:|:---:|---|
| `type` | `string` | ☑ | | The transfer order type, `TR` or a custom order type derived from it |
| `orderId` | `string` | ☐ | | The order id, for an order type with manual numbering or when Visma.net.ERP.SalesOrders.Api.Application.Commands.NewTransferOrder.NewTransferOrderCommand.OverrideNumberSeries is set |
| `overrideNumberSeries` | `boolean` | ☐ | | Uses Visma.net.ERP.SalesOrders.Api.Application.Commands.NewTransferOrder.NewTransferOrderCommand.OrderId instead of the number the order type would give automatically. When set, the
order id must be given |
| `destinationWarehouseId` | `string` | ☑ | | The warehouse the goods are transferred to. Mandatory; it cannot be the transit warehouse. |
| `branchId` | `string` | ☐ | | The branch of the order, defaulted as for a sales order. It is never derived from the destination warehouse. |
| `ownerId` | `string` | ☐ | | The owner (employee) of the order |
| `date` | `datetime` | ☐ | | |
| `requestOn` | `datetime` | ☐ | | |
| `cancelBy` | `datetime` | ☐ | | |
| `description` | `string` | ☐ | | |
| `status` | `string` | ☐ | | `Open` or `Hold`; the order type default when omitted |
| `rule` | `string` | ☐ | | `BackOrderAllowed`, `CancelRemainder` or `ShipComplete` |
| `scheduledDate` | `datetime` | ☐ | | |
| `shipSeparately` | `boolean` | ☐ | | Sets whether the order should be shipped separately or included in a batch segment |
| `preferredWarehouseId` | `string` | ☐ | | The preferred warehouse of the order, the default warehouse of new lines. Must be a valid warehouse id |
| `intrastatTransactionTypeId` | `int32` | ☐ | | The intrastat transaction type id. Must be a valid intrastat transaction type id |
| `shipViaId` | `string` | ☐ | | The carrier and its service used to ship the goods. Must be a valid carrier id |
| `residentialDelivery` | `boolean` | ☐ | | Sets whether this is residential delivery |
| `saturdayDelivery` | `boolean` | ☐ | | Sets whether this is a saturday delivery |
| `insurance` | `boolean` | ☐ | | Sets whether insurance applies to this shipping |
| `priority` | `int32` | ☐ | | Sets priority of the order |
| `zoneId` | `string` | ☐ | | The shipping zone of the order. Must be a valid shipping zone id |
| `fobPointId` | `string` | ☐ | | The point (such as a city or town) where the title of the goods passes. Must be a valid FOB point id |
| `termsId` | `string` | ☐ | | The shipping terms of the order. Must be a valid shipping terms id |
| `address_line1` | `string` | ☐ | | Address line 1 |
| `address_line2` | `string` | ☐ | | Address line 2 |
| `address_line3` | `string` | ☐ | | Address line 3 |
| `address_postalCode` | `string` | ☐ | | The postal code |
| `address_city` | `string` | ☐ | | The city |
| `address_countryId` | `string` | ☐ | | The country. Required when setting the address. |
| `address_stateId` | `string` | ☐ | | The state |
| `contact_name` | `string` | ☐ | | Sets the full name of the contact |
| `contact_attention` | `string` | ☐ | | Sets any attention for the contact |
| `contact_phone1` | `string` | ☐ | | Sets the primary phone number of the contact |
| `contact_email` | `string` | ☐ | | Sets the e-mail address of the contact, multiple e-mails can be separated by semicolon |
| `contact_phone2` | `string` | ☐ | | Sets the secondary phone number of the contact |
| `contact_fax` | `string` | ☐ | | Sets the fax number of the contact |
| `contact_emails` | `string` | ☐ | | |
| `note` | `string` | ☐ | | |
| `customStr1` | `string` | ☐ | | A free custom colum of type string with max length 100. |
| `customStr2` | `string` | ☐ | | A free custom colum of type string with max length 100. |
| `customStr3` | `string` | ☐ | | A free custom colum of type string with max length 100. |
| `customStr4` | `string` | ☐ | | A free custom colum of type string with max length 100. |
| `customStr5` | `string` | ☐ | | A free custom colum of type string with max length 100. |
| `customDec1` | `double` | ☐ | | A free custom colum of type decimal with max 4 decimals. |
| `customDec2` | `double` | ☐ | | A free custom colum of type decimal with max 4 decimals. |
| `customInt1` | `int32` | ☐ | | A free custom colum of type int |
| `customInt2` | `int32` | ☐ | | A free custom colum of type int |
| `customDateTimeUtc1` | `datetime` | ☐ | | A free custom colum of type DateTime - in UTC timezone |