Table of Contents

Table "Sales Shipment Header"

ID 110
Namespace: Microsoft.Sales.History

Stores header information for posted sales shipments including shipping details and customer information.

Properties

Name Value
Caption Sales Shipment Header
DataCaptionFields 3,79
DrillDownPageID Page Microsoft.Sales.History."Posted Sales Shipments"
LookupPageID Page Microsoft.Sales.History."Posted Sales Shipments"
DataClassification CustomerContent

Fields

Name Type Description
"Sell-to Customer No." Code[20]

Specifies the customer number who received the shipped items.
"No." Code[20]

Specifies the unique document number of the posted sales shipment.
"Bill-to Customer No." Code[20]

Specifies the customer number to whom the invoice will be sent.
"Bill-to Name" Text[100]

Specifies the name of the customer receiving the invoice.
"Bill-to Name 2" Text[50]

Specifies additional name information for the bill-to customer.
"Bill-to Address" Text[100]

Specifies the street address of the customer receiving the invoice.
"Bill-to Address 2" Text[50]

Specifies additional street address information for the bill-to customer.
"Bill-to City" Text[30]

Specifies the city of the customer receiving the invoice.
"Bill-to Contact" Text[100]

Specifies the name of the contact person at the bill-to customer.
"Your Reference" Text[35]

Specifies the customer's own reference number for this document.
"Ship-to Code" Code[10]

Specifies the code for an alternate ship-to address.
"Ship-to Name" Text[100]

Specifies the name of the recipient at the ship-to address.
"Ship-to Name 2" Text[50]

Specifies additional name information for the ship-to address.
"Ship-to Address" Text[100]

Specifies the street address where items were shipped.
"Ship-to Address 2" Text[50]

Specifies additional street address information for the ship-to address.
"Ship-to City" Text[30]

Specifies the city of the ship-to address.
"Ship-to Contact" Text[100]

Specifies the name of the contact person at the ship-to address.
"Order Date" Date

Specifies the date when the sales order was created.
"Posting Date" Date

Specifies the date when the shipment was posted to the ledger.
"Shipment Date" Date

Specifies the date when the items were shipped.
"Posting Description" Text[100]

Specifies a description of the posting.
"Payment Terms Code" Code[10]

Specifies the code for payment terms.
"Due Date" Date

Specifies the date by which payment is due.
"Payment Discount %" Decimal

Specifies the percentage of payment discount given if payment is made on time.
"Pmt. Discount Date" Date

Specifies the last date for taking the payment discount.
"Shipment Method Code" Code[10]

Specifies the shipment method used for delivering the items.
"Location Code" Code[10]

Specifies the warehouse location from which items were shipped.
"Shortcut Dimension 1 Code" Code[20]

Specifies the first global dimension code used for analysis.
"Shortcut Dimension 2 Code" Code[20]

Specifies the second global dimension code used for analysis.
"Customer Posting Group" Code[20]

Specifies the customer posting group that determines G/L accounts for posting.
"Currency Code" Code[10]

Specifies the currency code for amounts on the shipment.
"Currency Factor" Decimal

Specifies the exchange rate between the document currency and the local currency.
"Customer Price Group" Code[10]

Specifies the customer price group for determining sales prices.
"Prices Including VAT" Boolean

Indicates whether the unit prices include VAT.
"Invoice Disc. Code" Code[20]

Specifies the code used to determine invoice discount terms.
"Customer Disc. Group" Code[20]

Specifies the customer discount group for determining line discounts.
"Language Code" Code[10]

Specifies the language code used for printing documents.
"Format Region" Text[80]

Specifies the regional format for dates, numbers, and other data on printed documents.
"Salesperson Code" Code[20]

Specifies the salesperson responsible for this sale.
"Order No." Code[20]

Specifies the sales order number from which this shipment was created.
Comment Boolean

Indicates whether comments exist for this shipment.
"No. Printed" Integer

Specifies how many times the shipment has been printed.
"On Hold" Code[3]

Specifies a code indicating that processing is on hold.
"Applies-to Doc. Type" Enum Microsoft.Finance.GeneralLedger.Journal."Gen. Journal Document Type"

Specifies the type of document this applies to for payment application.
"Applies-to Doc. No." Code[20]

Specifies the document number this applies to for payment application.
"Bal. Account No." Code[20]

Specifies the balancing account number used for posting.
"VAT Registration No." Text[20]

Specifies the customer's VAT registration number.
"Reason Code" Code[10]

Specifies the reason code for the transaction.
"Gen. Bus. Posting Group" Code[20]

Specifies the general business posting group for determining G/L accounts.
"EU 3-Party Trade" Boolean

Indicates whether this is a three-party trade within the EU.
"Transaction Type" Code[10]

Specifies the transaction type for Intrastat reporting.
"Transport Method" Code[10]

Specifies the transport method for Intrastat reporting.
"VAT Country/Region Code" Code[10]

Specifies the country or region code for VAT purposes.
"Sell-to Customer Name" Text[100]

Specifies the name of the sell-to customer.
"Sell-to Customer Name 2" Text[50]

Specifies additional name information for the sell-to customer.
"Sell-to Address" Text[100]

Specifies the street address of the sell-to customer.
"Sell-to Address 2" Text[50]

Specifies additional street address information for the sell-to customer.
"Sell-to City" Text[30]

Specifies the city of the sell-to customer.
"Sell-to Contact" Text[100]

Specifies the name of the contact person at the sell-to customer.
"Bill-to Post Code" Code[20]

Specifies the postal code of the bill-to customer.
"Bill-to County" Text[30]

Specifies the county or state of the bill-to customer.
"Bill-to Country/Region Code" Code[10]

Specifies the country or region of the bill-to customer.
"Sell-to Post Code" Code[20]

Specifies the postal code of the sell-to customer.
"Sell-to County" Text[30]

Specifies the county or state of the sell-to customer.
"Sell-to Country/Region Code" Code[10]

Specifies the country or region of the sell-to customer.
"Ship-to Post Code" Code[20]

Specifies the postal code of the ship-to address.
"Ship-to County" Text[30]

Specifies the county or state of the ship-to address.
"Ship-to Country/Region Code" Code[10]

Specifies the country or region of the ship-to address.
"Bal. Account Type" Enum Microsoft.Bank.Payment."Payment Balance Account Type"

Specifies the type of balancing account used for posting.
"Exit Point" Code[10]

Specifies the exit point for goods leaving the country for Intrastat reporting.
Correction Boolean

Indicates whether this shipment is a correction entry.
"Document Date" Date

Specifies the date when the document was created.
"External Document No." Code[35]

Specifies an external document number such as the customer's purchase order number.
"Area" Code[10]

Specifies the geographic area for Intrastat reporting.
"Transaction Specification" Code[10]

Specifies additional transaction details for Intrastat reporting.
"Payment Method Code" Code[10]

Specifies the method of payment.
"Shipping Agent Code" Code[10]

Specifies the shipping agent used for delivery.
"Package Tracking No." Text[50]

Specifies the tracking number for tracking shipped packages.
"No. Series" Code[20]

Specifies the number series used for the posted shipment.
"Order No. Series" Code[20]

Specifies the number series of the original sales order.
"User ID" Code[50]

Specifies the user who posted the shipment.
"Source Code" Code[10]

Specifies the source code that identifies where the entry was created.
"Tax Area Code" Code[20]

Specifies the tax area code for sales tax calculation.
"Tax Liable" Boolean

Indicates whether the customer is liable for sales tax.
"VAT Bus. Posting Group" Code[20]

Specifies the VAT business posting group for VAT calculation.
"VAT Base Discount %" Decimal

Specifies the percentage of payment discount deducted from the VAT base.
"Quote No." Code[20]

Specifies the quote number from which the order originated.
"Company Bank Account Code" Code[20]

Specifies the company bank account for receiving payment.
"Sell-to Phone No." Text[30]

Specifies the phone number of the sell-to customer.
"Sell-to E-Mail" Text[80]

Specifies the email address of the sell-to customer.
"Work Description" Blob

Contains the work or job description for the shipment.
"Ship-to Phone No." Text[30]

Specifies the phone number at the ship-to address.
"Dimension Set ID" Integer

Specifies the unique identifier for the dimension set applied to this document.
"Campaign No." Code[20]

Specifies the marketing campaign associated with this shipment.
"Sell-to Contact No." Code[20]

Specifies the contact number for the sell-to customer.
"Bill-to Contact No." Code[20]

Specifies the contact number for the bill-to customer.
"Opportunity No." Code[20]

Specifies the sales opportunity associated with this shipment.
"Responsibility Center" Code[10]

Specifies the responsibility center for this shipment.
"Requested Delivery Date" Date

Specifies the date the customer requested delivery.
"Promised Delivery Date" Date

Specifies the date that was promised for delivery.
"Shipping Time" DateFormula

Specifies the time required for shipping from the shipping agent.
"Outbound Whse. Handling Time" DateFormula

Specifies the time required for outbound warehouse handling.
"Shipping Agent Service Code" Code[10]

Specifies the shipping agent service level used for delivery.
"Price Calculation Method" Enum Microsoft.Pricing.Calculation."Price Calculation Method"

Specifies the method used for calculating prices.
"Allow Line Disc." Boolean

Indicates whether line discounts are allowed.
"Customer Id" Guid

Stores the unique identifier for the sell-to customer.
"Bill-to Customer Id" Guid

Stores the unique identifier for the bill-to customer.
SystemId Guid
SystemCreatedAt DateTime
SystemCreatedBy Guid
SystemModifiedAt DateTime
SystemModifiedBy Guid
SystemCreatedByUserName Text[50]
SystemCreatedByFullName Text[80]
SystemModifiedByUserName Text[50]
SystemModifiedByFullName Text[80]
SystemRowVersion BigInteger

Methods

SendProfile

Sends the shipment document using the specified document sending profile.

procedure SendProfile(var DocumentSendingProfile: Record "Document Sending Profile")

Parameters

Name Type Description
DocumentSendingProfile Table Microsoft.Foundation.Reporting."Document Sending Profile"

Specifies the sending profile to use.

SendRecords

Sends the selected shipment records using the customer's document sending profile.

procedure SendRecords()

PrintRecords

Prints the sales shipment records using the configured report selection.

procedure PrintRecords(ShowRequestForm: Boolean)

Parameters

Name Type Description
ShowRequestForm Boolean

Specifies whether to show the report request page.

CheckNoPrinted

Validates that the shipment has been printed at least once.

procedure CheckNoPrinted()

EmailRecords

Sends the sales shipment records via email using the configured document sending profile.

procedure EmailRecords(ShowDialog: Boolean)

Parameters

Name Type Description
ShowDialog Boolean

Specifies whether to show the email dialog.

Navigate

Opens the Navigate page to show related entries for this sales shipment.

procedure Navigate()

StartTrackingSite

Opens the shipping agent's tracking website for the package.

procedure StartTrackingSite()

ShowDimensions

Opens a page showing the dimension set for this sales shipment.

procedure ShowDimensions()

IsCompletlyInvoiced

Checks if all lines in the shipment have been fully invoiced.

procedure IsCompletlyInvoiced(): Boolean

Returns

Type Description
Boolean

Returns true if there are no uninvoiced quantities remaining.

SetSecurityFilterOnRespCenter

Sets a security filter based on the user's responsibility center.

procedure SetSecurityFilterOnRespCenter()

GetCustomerVATRegistrationNumber

Gets the customer's VAT registration number.

procedure GetCustomerVATRegistrationNumber(): Text

Returns

Type Description
Text

The VAT registration number.

GetCustomerVATRegistrationNumberLbl

Gets the label for the VAT registration number field.

procedure GetCustomerVATRegistrationNumberLbl(): Text

Returns

Type Description
Text

The field caption if VAT registration number exists, otherwise empty.

GetCustomerGlobalLocationNumber

Gets the customer's global location number (GLN).

procedure GetCustomerGlobalLocationNumber(): Text

Returns

Type Description
Text

The GLN if customer exists, otherwise empty.

GetCustomerGlobalLocationNumberLbl

Gets the label for the GLN field.

procedure GetCustomerGlobalLocationNumberLbl(): Text

Returns

Type Description
Text

The field caption if customer exists, otherwise empty.

GetLegalStatement

Gets the legal statement from sales setup for printing on shipments.

procedure GetLegalStatement(): Text

Returns

Type Description
Text

The legal statement text.

GetWorkDescription

Gets the work description text from the blob field.

procedure GetWorkDescription(): Text

Returns

Type Description
Text

The work description text.

PrintToDocumentAttachment

Prints the shipments and saves them as document attachments.

procedure PrintToDocumentAttachment(var SalesShipmentHeader: Record "Sales Shipment Header")

Parameters

Name Type Description
SalesShipmentHeader Table Microsoft.Sales.History."Sales Shipment Header"

The shipment records to print and attach.

Events

OnBeforeEmailRecords

Raised before emailing sales shipment records.

[IntegrationEvent(False,False)]
local procedure OnBeforeEmailRecords(var SalesShipmentHeader: Record "Sales Shipment Header"; var SendDialog: Boolean; var IsHandled: Boolean)

Parameters

Name Type Description
SalesShipmentHeader Table Microsoft.Sales.History."Sales Shipment Header"

The sales shipment header records to email.
SendDialog Boolean

Specifies whether to show the send dialog.
IsHandled Boolean

Set to true to skip the default logic.

OnBeforePrintRecords

Raised before printing sales shipment records.

[IntegrationEvent(False,False)]
local procedure OnBeforePrintRecords(var SalesShipmentHeader: Record "Sales Shipment Header"; ShowDialog: Boolean; var IsHandled: Boolean)

Parameters

Name Type Description
SalesShipmentHeader Table Microsoft.Sales.History."Sales Shipment Header"

The sales shipment header records to print.
ShowDialog Boolean

Specifies whether to show the print dialog.
IsHandled Boolean

Set to true to skip the default logic.

OnBeforeStartTrackingSite

Raised before starting the package tracking site for the shipment.

[IntegrationEvent(False,False)]
local procedure OnBeforeStartTrackingSite(var SalesShipmentHeader: Record "Sales Shipment Header"; var IsHandled: Boolean)

Parameters

Name Type Description
SalesShipmentHeader Table Microsoft.Sales.History."Sales Shipment Header"

The sales shipment header record.
IsHandled Boolean

Set to true to skip the default logic.

OnBeforeSendProfile

Raised before sending the sales shipment using a document sending profile.

[IntegrationEvent(False,False)]
local procedure OnBeforeSendProfile(var DocumentSendingProfile: Record "Document Sending Profile"; var SalesShipmentHeader: Record "Sales Shipment Header"; var IsHandled: Boolean)

Parameters

Name Type Description
DocumentSendingProfile Table Microsoft.Foundation.Reporting."Document Sending Profile"

The document sending profile to use.
SalesShipmentHeader Table Microsoft.Sales.History."Sales Shipment Header"

The sales shipment header record.
IsHandled Boolean

Set to true to skip the default logic.

OnBeforeSetSecurityFilterOnRespCenter

Raised before setting the security filter on responsibility center for the sales shipment header.

[IntegrationEvent(False,False)]
local procedure OnBeforeSetSecurityFilterOnRespCenter(var SalesShipmentHeader: Record "Sales Shipment Header"; var IsHandled: Boolean)

Parameters

Name Type Description
SalesShipmentHeader Table Microsoft.Sales.History."Sales Shipment Header"

The sales shipment header record.
IsHandled Boolean

Set to true to skip the default logic.

OnLookupAppliesToDocNoOnAfterSetFilters

Raised after setting filters during the Applies-to Doc. No. lookup.

[IntegrationEvent(False,False)]
local procedure OnLookupAppliesToDocNoOnAfterSetFilters(var CustLedgEntry: Record "Cust. Ledger Entry"; SalesShipmentHeader: Record "Sales Shipment Header")

Parameters

Name Type Description
CustLedgEntry Table Microsoft.Sales.Receivables."Cust. Ledger Entry"

The customer ledger entry record with filters applied.
SalesShipmentHeader Table Microsoft.Sales.History."Sales Shipment Header"

The sales shipment header record.

OnBeforeNavigate

Raised before navigating to related entries for the sales shipment.

[IntegrationEvent(False,False)]
local procedure OnBeforeNavigate(SalesShipmentHeader: Record "Sales Shipment Header"; var IsHandled: Boolean)

Parameters

Name Type Description
SalesShipmentHeader Table Microsoft.Sales.History."Sales Shipment Header"

The sales shipment header record.
IsHandled Boolean

Set to true to skip the default logic.

OnBeforeCheckNoPrinted

Raised before checking the number of times the sales shipment has been printed.

[IntegrationEvent(False,False)]
local procedure OnBeforeCheckNoPrinted(var SalesShipmentHeader: Record "Sales Shipment Header"; var IsHandled: Boolean)

Parameters

Name Type Description
SalesShipmentHeader Table Microsoft.Sales.History."Sales Shipment Header"

The sales shipment header record.
IsHandled Boolean

Set to true to skip the default logic.

See also