Inbound shipment

Information about a delivery. That is, a quantity of goods that we expect to receive together. The goods may not be ordered on the same purchase order.

InboundShipment

Constraints

You must supply either an id or a number of a supplier. It is not posible to have more than 1000 lines on an inbound shipment.

Fields

Id

Unique identification of this delivery across all subscribers.

id Long Read only

No.

Unique identification of delivery within the area.

inboundShipmentNumber String Unique Length 1 to 36

Expected arrival

Time when the goods are expected to arrive.

expectedTimeOfArrival Date Format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

Expected delivery

Time when the goods are expected to be delivered.

expectedTimeOfDelivery Date Format yyyy-MM-dd'T'HH:mm:ss.SSS'Z'

Delivery address

DeliveryAddress.

deliveryAddress Address

Incoterms

Incoterms.

incoterms Incoterms

Created

The date of creation of this delivery.

timeCreated Date Format yyyy-MM-dd'T'HH:mm:ss.SSS'Z' Read only

Delivery note no.

The number of the delivery note that came with the goods on delivery.

deliveryNoteNumber String Length 0 to 250

Invoice number.

The number of a possible invoice that came with the goods on delivery.

invoiceNumber String Length 0 to 250

Order conf. no.

The number of the order confirmation sent by the supplier.

orderConfirmationNumber String Length 0 to 250

Supplier no.

Unique identification of the supplier within the area.

supplierNumber String Supplier

Supplier ID

Unique identification of the supplier of this delivery.

supplierId Long Supplier

Currency code

Currency code for all amounts on this delivery.

currencyCode CurrencyCode

Exchange rate

The price used to calculate the cost.

currencyExchangeRate BigDecimal Min 0.000001 Max 999999.999999

Transportation

Costs for transportation and handling incurred and invoiced by the supplier. Must be in the same currency as the rest of the invoice.

transportAndHandlingCost BigDecimal Min 0.00 Max 999999.99

Combined discount

Combined discount given in currency.

combinedDiscount BigDecimal Min 0.00 Max 999999.99

Goods receipt created

Time the goods receipt for this deliverance was created.

goodsReceiptTimeCreated Date Format yyyy-MM-dd'T'HH:mm:ss.SSS'Z' Read only

Goods receipt number

Number of the goods receipt created for this deliverance.

goodsReceiptNumber Long Read only

Supplier address

Address of the supplier of the deliverance.

supplierAddressee String Read only

Cost variance list created

Time of the creation of the cost variance list.

costVarianceListTimeCreated Date Format yyyy-MM-dd'T'HH:mm:ss.SSS'Z' Read only

Cost variance list number

The number of the cost variance list made for this deliverance.

costVarianceListNumber Long Read only

Goods receipt id

Unique identification of the goods receipt made for this deliverance.

goodsReceiptId Long Read only Document

Cost variance list id

Unique identifikation of the cost variance list made for this deliverance.

costVarianceListId Long Read only Document

Delivery lines

Lines describing which items are expected to be received on this delivery.

inboundShipmentLines List InboundShipmentLine

Distribution key

inboundShipment.costDistributionKey.description

costDistributionKey CostDistributionKey

Area id

Unique identification of the area within which the deliverance is created.

contextId Long Context

Receive to location

The number of the location that the deliverance must be received to.

receiveToLocationNumber String Location

Receive to location id

Unique identification of the location that the items must be received to.

receiveToLocationId Long Location

Location required

Is it required to receive the items to a common location?

receiveToLocationRequired Boolean

Notes on ordering

Notes meant for the supplier.

notesOnOrdering String

Created event id

Unique identification of the creation of this deliverance. Messages regarding the creation are attached to this id.

inboundShipmentCreatedEventId String Read only

Delivery confirmed

Time for the confirmation of the delivery in accordance with the agreed upon incoterms.

timeDeliveryConfirmed Date Format yyyy-MM-dd'T'HH:mm:ss.SSS'Z' Read only

Delivery confirmation id

Unique identification of the delivery confirmation.

deliveryConfirmationId String Read only

On-hold

Indicates that this inbound shipment is on-hold and therefore not yet ready to be received.

onHold Boolean

Cancelled

Indicates that this inbound shipment is cancelled and will never be received.

cancelled Boolean

Data document

JSON document containing additional information about this deliverance.

dataDocument String JSON

Filter

Delivery number

A search term that the delivery number should match for a delivery to pass the filter.

inboundShipmentNumberMatch String

Supplier number

Search terms that the supplier of the delivery should match.

supplierNumberMatch String

Supplier Address

An expression to be found in the supplier's address information.

supplierAddressMatch String

Only without receipt

Only show the deliveries that have not yet been issued.

onlyNoGoodsReceipt Boolean

Only without cost variance list

Only show the deliveries where no cost variance list has yet been made.

onlyNoCostVarianceList Boolean

Only expected today

Show only the deliveries that are expected to be received today.

onlyExpectedToday Boolean

Delivery note number

Search terms as the delivery's tracking number must match.

deliveryNoteNumberMatch String

Invoice number

A search term that the invoice number should match.

invoiceNumberMatch String

Date receipt

Only show deliveries where receipt was printed on this date.

dateGoodsReceiptCreated Date

Delivery address

Delivery address.

deliveryAddressMatch String

Delivery horizon

Delivery horizon.

deliveryHorizon Integer