KVSKBAPurchaseReturnOrder
Events
OnUpdateRequestPageSettings(Enum KVSKBADocumentInitEventType, Boolean, Integer, Boolean, Boolean, Boolean) :
Summary: Raised during request page lifecycle events to allow customization of report options.
[IntegrationEvent(true, false)]
local procedure OnUpdateRequestPageSettings(InitEventType: Enum "KVSKBADocumentInitEventType"; RequestPageAlreadyOpen: Boolean; var NoOfCopies: Integer; var ShowInternalInfo: Boolean; var LogInteraction: Boolean; var PrintOnNotePaper: Boolean):
Parameters:
InitEventType: The lifecycle event type that triggered this call (OnOpenPage, OnClosePage, OnBeforeOnPreReport, OnAfterOnPreReport).RequestPageAlreadyOpen: Indicates whether the request page has already been opened in this session.NoOfCopies: The number of additional copies to print. Can be modified by subscribers.ShowInternalInfo: Specifies whether internal information is shown. Can be modified by subscribers.LogInteraction: Specifies whether the print action is logged as an interaction. Can be modified by subscribers.PrintOnNotePaper: Specifies whether the report prints on business letterhead paper. Can be modified by subscribers.
Remarks: Fired on OnOpenPage, OnClosePage, OnBeforeOnPreReport and OnAfterOnPreReport. Use InitEventType to react to specific lifecycle phases only. Unlike PurchaseOrder, this event has no ArchiveDocument or PrintOrderCancelation parameter. No ArchiveManagement call is performed for purchase return orders.
OnBeforeCheckDocStructureOnAfterGetRecord(Record Purchase Header, Boolean) :
Summary: Raised before the document structure check (position numbers, total structure) is performed in the DocHeader OnAfterGetRecord trigger.
[IntegrationEvent(true, false)]
local procedure OnBeforeCheckDocStructureOnAfterGetRecord(var DocumentHeader: Record "Purchase Header"; var Handled: Boolean):
Parameters:
DocumentHeader: The purchase header record (Return Order) currently being processed.Handled: Set to true to skip the default structure validation (RunCalcPosNoInPurchLines, CheckTotalStructureInPurchLine, CheckPosNoNotEmptyInPurchLine).
Remarks: Unlike PurchaseOrder, there is no OnBeforeCheckDocStatusOnAfterGetRecord for purchase return orders (no status check performed). The default logic recalculates position numbers for open return orders if needed, validates the total structure of purchase lines, and optionally checks that position numbers are not empty. Set Handled to true to bypass all structure validation.
OnBeforeCreateDocumentHeader(Record KVSKBADocumentHeaderBuffer, Boolean, Record Purchase Header, Codeunit KVSKBAMasterDoc) :
[IntegrationEvent(true, false)]
local procedure OnBeforeCreateDocumentHeader(var DocumentHeaderBuffer: Record "KVSKBADocumentHeaderBuffer" temporary; var Handled: Boolean; var DocumentHeader: Record "Purchase Header"; var MasterDoc: Codeunit "KVSKBAMasterDoc"):
OnBeforeCreateDocumentAddress(Record KVSKBADocumentHeaderBuffer, Boolean, Record Purchase Header, Codeunit KVSKBAMasterDoc) :
[IntegrationEvent(true, false)]
local procedure OnBeforeCreateDocumentAddress(var DocumentHeaderBuffer: Record "KVSKBADocumentHeaderBuffer" temporary; var Handled: Boolean; var DocumentHeader: Record "Purchase Header"; var MasterDoc: Codeunit "KVSKBAMasterDoc"):
OnBeforeAddDocHeader(Record KVSKBADocumentHeaderBuffer, Record Purchase Header, Codeunit KVSKBAMasterDoc) :
[IntegrationEvent(true, false)]
local procedure OnBeforeAddDocHeader(var DocumentHeaderBuffer: Record "KVSKBADocumentHeaderBuffer" temporary; var DocumentHeader: Record "Purchase Header"; var MasterDoc: Codeunit "KVSKBAMasterDoc"):
OnBeforeCreateDocumentHeading(Record KVSKBADocumentHeaderBuffer, Boolean, Record Purchase Header, Codeunit KVSKBAMasterDoc) :
[IntegrationEvent(true, false)]
local procedure OnBeforeCreateDocumentHeading(var DocumentHeaderBuffer: Record "KVSKBADocumentHeaderBuffer" temporary; var Handled: Boolean; var DocumentHeader: Record "Purchase Header"; var MasterDoc: Codeunit "KVSKBAMasterDoc"):
OnAfterCreateDocumentHeading(Record KVSKBADocumentHeaderBuffer, Record Purchase Header, Codeunit KVSKBAMasterDoc) :
[IntegrationEvent(true, false)]
local procedure OnAfterCreateDocumentHeading(var DocumentHeaderBuffer: Record "KVSKBADocumentHeaderBuffer" temporary; var DocumentHeader: Record "Purchase Header"; var MasterDoc: Codeunit "KVSKBAMasterDoc"):
OnPreDataItemDocHeaderText(Record KVSKBADocumentHeaderBuffer, Record KVSKBADocumentLineBuffer, Boolean, Record Purchase Header, Codeunit KVSKBAMasterDoc) :
[IntegrationEvent(true, false)]
local procedure OnPreDataItemDocHeaderText(var DocumentHeaderBuffer: Record "KVSKBADocumentHeaderBuffer" temporary; var DocumentLineBuffer: Record "KVSKBADocumentLineBuffer" temporary; var isHandled: Boolean; var DocumentHeader: Record "Purchase Header"; var MasterDoc: Codeunit "KVSKBAMasterDoc"):
OnPostDataItemDocHeaderText(Record KVSKBADocumentHeaderBuffer, Record KVSKBADocumentLineBuffer, Record Purchase Header, Codeunit KVSKBAMasterDoc) :
[IntegrationEvent(true, false)]
local procedure OnPostDataItemDocHeaderText(var DocumentHeaderBuffer: Record "KVSKBADocumentHeaderBuffer" temporary; var DocumentLineBuffer: Record "KVSKBADocumentLineBuffer" temporary; var DocumentHeader: Record "Purchase Header"; var MasterDoc: Codeunit "KVSKBAMasterDoc"):
OnPreDataItemDocFooterText(Record KVSKBADocumentHeaderBuffer, Record KVSKBADocumentLineBuffer, Boolean, Record Purchase Header, Codeunit KVSKBAMasterDoc) :
OnPostDataItemDocFooterText(Record KVSKBADocumentHeaderBuffer, Record KVSKBADocumentLineBuffer, Record Purchase Header, Codeunit KVSKBAMasterDoc) :
OnDocFooterFinished(Record KVSKBADocumentHeaderBuffer, Record Purchase Header, Codeunit KVSKBAMasterDoc) :
OnBeforeCheckForPageAndBlockBreak(Record KVSKBADocumentHeaderBuffer, Record Purchase Header, Record Purchase Line, Boolean, Boolean, Codeunit KVSKBAMasterDoc) :
[IntegrationEvent(false, false)]
local procedure OnBeforeCheckForPageAndBlockBreak(var DocumentHeaderBuffer: Record "KVSKBADocumentHeaderBuffer" temporary; var DocumentHeader: Record "Purchase Header"; var DocumentLine: Record "Purchase Line"; var skipLine: Boolean; var isHandled: Boolean; var MasterDoc: Codeunit "KVSKBAMasterDoc"):
OnBeforeAddDocumentLine(Record KVSKBADocumentHeaderBuffer, Record KVSKBADocumentLineBuffer, Record Purchase Header, Record Purchase Line, Codeunit KVSKBAMasterDoc) :
[IntegrationEvent(false, false)]
local procedure OnBeforeAddDocumentLine(var DocumentHeaderBuffer: Record "KVSKBADocumentHeaderBuffer" temporary; var DocumentLineBuffer: Record "KVSKBADocumentLineBuffer" temporary; var DocumentHeader: Record "Purchase Header"; var DocumentLine: Record "Purchase Line"; var MasterDoc: Codeunit "KVSKBAMasterDoc"):
OnAfterAddDocumentLine(Record KVSKBADocumentHeaderBuffer, Record KVSKBADocumentLineBuffer, Record Purchase Header, Record Purchase Line, Codeunit KVSKBAMasterDoc) :
[IntegrationEvent(false, false)]
local procedure OnAfterAddDocumentLine(var DocumentHeaderBuffer: Record "KVSKBADocumentHeaderBuffer" temporary; var DocumentLineBuffer: Record "KVSKBADocumentLineBuffer" temporary; var DocumentHeader: Record "Purchase Header"; var DocumentLine: Record "Purchase Line"; var MasterDoc: Codeunit "KVSKBAMasterDoc"):
OnBeforeInitByPurchaseLine(Record KVSKBADocumentLineBuffer, Record KVSKBADocumentHeaderBuffer, Record Purchase Header, Record Purchase Line, Codeunit KVSKBAMasterDoc) :
[IntegrationEvent(false, false)]
local procedure OnBeforeInitByPurchaseLine(var DocumentLineBuffer: Record "KVSKBADocumentLineBuffer" temporary; var DocumentHeaderBuffer: Record "KVSKBADocumentHeaderBuffer" temporary; var DocumentHeader: Record "Purchase Header"; var DocumentLine: Record "Purchase Line"; var MasterDoc: Codeunit "KVSKBAMasterDoc"):
OnAfterInitByPurchaseLine(Record KVSKBADocumentLineBuffer, Record KVSKBADocumentHeaderBuffer, Record Purchase Header, Record Purchase Line, Codeunit KVSKBAMasterDoc) :
[IntegrationEvent(false, false)]
local procedure OnAfterInitByPurchaseLine(var DocumentLineBuffer: Record "KVSKBADocumentLineBuffer" temporary; var DocumentHeaderBuffer: Record "KVSKBADocumentHeaderBuffer" temporary; var DocumentHeader: Record "Purchase Header"; var DocumentLine: Record "Purchase Line"; var MasterDoc: Codeunit "KVSKBAMasterDoc"):
OnBeforeAddItemAttributeInfo(Record KVSKBADocumentHeaderBuffer, Record KVSKBADocumentLineBuffer, Boolean, Record Purchase Header, Record Purchase Line, Codeunit KVSKBAMasterDoc) :
[IntegrationEvent(false, false)]
local procedure OnBeforeAddItemAttributeInfo(var DocumentHeaderBuffer: Record "KVSKBADocumentHeaderBuffer" temporary; var DocumentLineBuffer: Record "KVSKBADocumentLineBuffer" temporary; var isHandled: Boolean; var DocumentHeader: Record "Purchase Header"; var DocumentLine: Record "Purchase Line"; var MasterDoc: Codeunit "KVSKBAMasterDoc"):
OnAfterAddDocLineInfo(Record KVSKBADocumentHeaderBuffer, Record KVSKBADocumentLineBuffer, Record Purchase Header, Record Purchase Line, Codeunit KVSKBAMasterDoc) :
[IntegrationEvent(false, false)]
local procedure OnAfterAddDocLineInfo(var DocumentHeaderBuffer: Record "KVSKBADocumentHeaderBuffer" temporary; var DocumentLineBuffer: Record "KVSKBADocumentLineBuffer" temporary; var DocumentHeader: Record "Purchase Header"; var DocumentLine: Record "Purchase Line"; var MasterDoc: Codeunit "KVSKBAMasterDoc"):
OnPreDataItemHeadLineText(Record KVSKBADocumentHeaderBuffer, Record KVSKBADocumentLineBuffer, Boolean, Record Purchase Header, Record Purchase Line, Codeunit KVSKBAMasterDoc) :
[IntegrationEvent(true, false)]
local procedure OnPreDataItemHeadLineText(var DocumentHeaderBuffer: Record "KVSKBADocumentHeaderBuffer" temporary; var DocumentLineBuffer: Record "KVSKBADocumentLineBuffer" temporary; var isHandled: Boolean; var DocumentHeader: Record "Purchase Header"; var DocumentLine: Record "Purchase Line"; var MasterDoc: Codeunit "KVSKBAMasterDoc"):
OnPostDataItemHeadLineText(Record KVSKBADocumentHeaderBuffer, Record KVSKBADocumentLineBuffer, Record Purchase Header, Record Purchase Line, Codeunit KVSKBAMasterDoc) :
[IntegrationEvent(true, false)]
local procedure OnPostDataItemHeadLineText(var DocumentHeaderBuffer: Record "KVSKBADocumentHeaderBuffer" temporary; var DocumentLineBuffer: Record "KVSKBADocumentLineBuffer" temporary; var DocumentHeader: Record "Purchase Header"; var DocumentLine: Record "Purchase Line"; var MasterDoc: Codeunit "KVSKBAMasterDoc"):
OnPreDataItemFootLineText(Record KVSKBADocumentHeaderBuffer, Record KVSKBADocumentLineBuffer, Boolean, Record Purchase Header, Record Purchase Line, Codeunit KVSKBAMasterDoc) :
[IntegrationEvent(true, false)]
local procedure OnPreDataItemFootLineText(var DocumentHeaderBuffer: Record "KVSKBADocumentHeaderBuffer" temporary; var DocumentLineBuffer: Record "KVSKBADocumentLineBuffer" temporary; var isHandled: Boolean; var DocumentHeader: Record "Purchase Header"; var DocumentLine: Record "Purchase Line"; var MasterDoc: Codeunit "KVSKBAMasterDoc"):
OnPostDataItemFootLineText(Record KVSKBADocumentHeaderBuffer, Record KVSKBADocumentLineBuffer, Record Purchase Header, Record Purchase Line, Codeunit KVSKBAMasterDoc) :
[IntegrationEvent(true, false)]
local procedure OnPostDataItemFootLineText(var DocumentHeaderBuffer: Record "KVSKBADocumentHeaderBuffer" temporary; var DocumentLineBuffer: Record "KVSKBADocumentLineBuffer" temporary; var DocumentHeader: Record "Purchase Header"; var DocumentLine: Record "Purchase Line"; var MasterDoc: Codeunit "KVSKBAMasterDoc"):
OnCasePrintVatSpecificationOnCaseElse(Enum KVSKBAPrintVatSpecification, Record VAT Amount Line, Boolean) :
Summary: Raised in the else-branch of the VAT specification case statement, allowing subscribers to define custom suppression logic for non-standard KVSKBAPrintVatSpecification values.
[IntegrationEvent(false, false)]
local procedure OnCasePrintVatSpecificationOnCaseElse(PrintVatSpecification: Enum "KVSKBAPrintVatSpecification"; var TempVATAmountLine: Record "VAT Amount Line" temporary; var SkipVATSpecVerification: Boolean):
Parameters:
PrintVatSpecification: The current value of CompanyInfo.KVSKBAPrintVatSpecificonDocs that matched the else-branch.TempVATAmountLine: The temporary VAT amount line buffer. Can be filtered or modified by subscribers.SkipVATSpecVerification: Set to true to break the VATSpec data item (suppress the VAT specification block) for this custom value.
Remarks: Only raised when CompanyInfo.KVSKBAPrintVatSpecificonDocs does not match the OnlywithdiffVATIdentifier case. The VATSpec data item also breaks when IsHandled is set to true by OnPreDataItemVATSpec, or when the standard verification (count ≤ 1, VAT amount = 0) suppresses the block.
OnPreDataItemVATSpec(Record KVSKBADocumentHeaderBuffer, Record Purchase Header, Record VAT Amount Line, Boolean, Boolean, Codeunit KVSKBAMasterDoc) :
[IntegrationEvent(false, false)]
local procedure OnPreDataItemVATSpec(var KVSKBADocumentHeaderBuffer: Record "KVSKBADocumentHeaderBuffer" temporary; var DocumentHeader: Record "Purchase Header"; var TempVATAmountLine: Record "VAT Amount Line" temporary; var SkipVATSpecVerification: Boolean; var IsHandled: Boolean; var KVSKBAMasterDoc: Codeunit "KVSKBAMasterDoc"):
OnPreDataItemVATSpecLCY(Record KVSKBADocumentHeaderBuffer, Record Purchase Header, Record VAT Amount Line, Boolean, Boolean, Codeunit KVSKBAMasterDoc) :
[IntegrationEvent(false, false)]
local procedure OnPreDataItemVATSpecLCY(var KVSKBADocumentHeaderBuffer: Record "KVSKBADocumentHeaderBuffer" temporary; var DocumentHeader: Record "Purchase Header"; var TempVATAmountLine: Record "VAT Amount Line" temporary; var SkipVATSpecVerification: Boolean; var isHandled: Boolean; var KVSKBAMasterDoc: Codeunit "KVSKBAMasterDoc"):
OnBeforeSetLanguageFormatAddress(Record Purchase Header, Boolean) :
Summary: Raised before FormatAddress.SetLanguageCode is called with the return order's language code.
[IntegrationEvent(false, false)]
local procedure OnBeforeSetLanguageFormatAddress(DocHeader: Record "Purchase Header"; var IsHandled: Boolean):
Parameters:
DocHeader: The purchase header record (Return Order) currently being processed.IsHandled: Set to true to skip the default FormatAddress.SetLanguageCode call.
Remarks: Fired in the DocHeader OnAfterGetRecord trigger before address formatting begins. Setting a custom language code here affects how FormatAddress resolves country name translations and address block layouts for purchase return order documents.
OnBeforeResetLanguageFormatAddress(Record Purchase Header, Boolean) :
Summary: Raised before FormatAddress.SetLanguageCode is called with an empty string to reset the address language after heading creation.
[IntegrationEvent(false, false)]
local procedure OnBeforeResetLanguageFormatAddress(DocHeader: Record "Purchase Header"; var GlobalIsHandled: Boolean):
Parameters:
DocHeader: The purchase header record (Return Order) currently being processed.GlobalIsHandled: Set to true to skip the default FormatAddress.SetLanguageCode('') reset call.
Remarks: Fired in the DocHeader OnAfterGetRecord trigger after CreateDocumentHeading and OnAfterCreateDocumentHeading have run. Resetting the language ensures that subsequent FormatAddress calls elsewhere in the report use the system default rather than the document language.
OnAfterTransferTotalAmount(Record KVSKBADocumentHeaderBuffer, Record VAT Amount Line) :
Summary: Raised after all VAT total amounts have been transferred to the document header buffer in the RoundLoop OnPostDataItem trigger.
[IntegrationEvent(false, false)]
local procedure OnAfterTransferTotalAmount(var TempDocumentHeaderBuffer: Record "KVSKBADocumentHeaderBuffer" temporary; var TempVATAmountLine: Record "VAT Amount Line" temporary):
Parameters:
TempDocumentHeaderBuffer: The temporary document header buffer, already updated with VAT Amount, Total excl. VAT, Total incl. VAT, Total LCY, Payment Disc. on VAT, Total LineAmount, Inv. Disc. Amount, and VAT Amount Caption.TempVATAmountLine: The temporary VAT amount line buffer containing the accumulated totals.
Remarks: Fired before MasterDoc.UpdateDocHeader. Unlike PurchaseOrder, there are no prepayment totals and no shipment method or payment terms total rows added after this event for purchase return orders. Use this event to modify or extend the total fields on DocumentHeaderBuffer before they are committed to the master document.
Protected Variables
GlobalLogInteraction
Type: Boolean
GlobalPrintOnNotePaper
Type: Boolean
GlobalShowInternalInfo
Type: Boolean
GlobalNoOfCopies
Type: Integer