Codeunit ArchiveManagement

ID 5063
Namespace: Microsoft.Utilities

Properties

Name Value
Permissions tableData "Purch. Comment Line" = r, tableData "Purchase Header Archive" = ri, tableData "Purchase Line Archive" = ri, tableData "Purch. Comment Line Archive" = ri, tabledata "Sales Comment Line" = r, tabledata "Sales Header Archive" = ri, tabledata "Sales Line Archive" = ri, tabledata "Sales Comment Line Archive" = ri

Methods

AutoArchiveSalesDocument

procedure AutoArchiveSalesDocument(var SalesHeader: Record "Sales Header")

Parameters

Name Type Description
SalesHeader Table Microsoft.Sales.Document."Sales Header"

AutoArchivePurchDocument

procedure AutoArchivePurchDocument(var PurchaseHeader: Record "Purchase Header")

Parameters

Name Type Description
PurchaseHeader Table Microsoft.Purchases.Document."Purchase Header"

ArchiveSalesDocument

procedure ArchiveSalesDocument(var SalesHeader: Record "Sales Header")

Parameters

Name Type Description
SalesHeader Table Microsoft.Sales.Document."Sales Header"

ArchivePurchDocument

procedure ArchivePurchDocument(var PurchHeader: Record "Purchase Header")

Parameters

Name Type Description
PurchHeader Table Microsoft.Purchases.Document."Purchase Header"

StoreSalesDocument

procedure StoreSalesDocument(var SalesHeader: Record "Sales Header", InteractionExist: Boolean)

Parameters

Name Type Description
SalesHeader Table Microsoft.Sales.Document."Sales Header"
InteractionExist Boolean

StorePurchDocument

procedure StorePurchDocument(var PurchHeader: Record "Purchase Header", InteractionExist: Boolean)

Parameters

Name Type Description
PurchHeader Table Microsoft.Purchases.Document."Purchase Header"
InteractionExist Boolean

RestoreSalesDocument

procedure RestoreSalesDocument(var SalesHeaderArchive: Record "Sales Header Archive")

Parameters

Name Type Description
SalesHeaderArchive Table Microsoft.Sales.Archive."Sales Header Archive"

GetNextOccurrenceNo

procedure GetNextOccurrenceNo(TableId: Integer, DocType: Option, DocNo: Code[20]): Integer

Parameters

Name Type Description
TableId Integer
DocType Option
DocNo Code[20]

Returns

Type Description
Integer

GetNextVersionNo

procedure GetNextVersionNo(TableId: Integer, DocType: Option, DocNo: Code[20], DocNoOccurrence: Integer): Integer

Parameters

Name Type Description
TableId Integer
DocType Option
DocNo Code[20]
DocNoOccurrence Integer

Returns

Type Description
Integer

SalesDocArchiveGranule

procedure SalesDocArchiveGranule(): Boolean

Returns

Type Description
Boolean

PurchaseDocArchiveGranule

procedure PurchaseDocArchiveGranule(): Boolean

Returns

Type Description
Boolean

StorePurchDocumentComments

procedure StorePurchDocumentComments(DocType: Option, DocNo: Code[20], DocNoOccurrence: Integer, VersionNo: Integer)

Parameters

Name Type Description
DocType Option
DocNo Code[20]
DocNoOccurrence Integer
VersionNo Integer

ArchSalesDocumentNoConfirm

procedure ArchSalesDocumentNoConfirm(var SalesHeader: Record "Sales Header")

Parameters

Name Type Description
SalesHeader Table Microsoft.Sales.Document."Sales Header"

ArchPurchDocumentNoConfirm

procedure ArchPurchDocumentNoConfirm(var PurchHeader: Record "Purchase Header")

Parameters

Name Type Description
PurchHeader Table Microsoft.Purchases.Document."Purchase Header"

RoundSalesDeferralsForArchive

procedure RoundSalesDeferralsForArchive(SalesHeader: Record "Sales Header", var SalesLine: Record "Sales Line")

Parameters

Name Type Description
SalesHeader Table Microsoft.Sales.Document."Sales Header"
SalesLine Table Microsoft.Sales.Document."Sales Line"

RoundPurchaseDeferralsForArchive

procedure RoundPurchaseDeferralsForArchive(PurchaseHeader: Record "Purchase Header", var PurchaseLine: Record "Purchase Line")

Parameters

Name Type Description
PurchaseHeader Table Microsoft.Purchases.Document."Purchase Header"
PurchaseLine Table Microsoft.Purchases.Document."Purchase Line"

Events

OnAfterAutoArchivePurchDocument

[IntegrationEvent(False,False)]
local procedure OnAfterAutoArchivePurchDocument(var PurchaseHeader: Record "Purchase Header")

Parameters

Name Type Description
PurchaseHeader Table Microsoft.Purchases.Document."Purchase Header"

OnAfterAutoArchiveSalesDocument

[IntegrationEvent(False,False)]
local procedure OnAfterAutoArchiveSalesDocument(var SalesHeader: Record "Sales Header")

Parameters

Name Type Description
SalesHeader Table Microsoft.Sales.Document."Sales Header"

OnAfterStoreSalesDocument

[IntegrationEvent(False,False)]
local procedure OnAfterStoreSalesDocument(var SalesHeader: Record "Sales Header", var SalesHeaderArchive: Record "Sales Header Archive")

Parameters

Name Type Description
SalesHeader Table Microsoft.Sales.Document."Sales Header"
SalesHeaderArchive Table Microsoft.Sales.Archive."Sales Header Archive"

OnAfterStoreSalesLineArchive

[IntegrationEvent(False,False)]
local procedure OnAfterStoreSalesLineArchive(var SalesHeader: Record "Sales Header", var SalesLine: Record "Sales Line", var SalesHeaderArchive: Record "Sales Header Archive", var SalesLineArchive: Record "Sales Line Archive")

Parameters

Name Type Description
SalesHeader Table Microsoft.Sales.Document."Sales Header"
SalesLine Table Microsoft.Sales.Document."Sales Line"
SalesHeaderArchive Table Microsoft.Sales.Archive."Sales Header Archive"
SalesLineArchive Table Microsoft.Sales.Archive."Sales Line Archive"

OnAfterStorePurchDocument

[IntegrationEvent(False,False)]
local procedure OnAfterStorePurchDocument(var PurchaseHeader: Record "Purchase Header", var PurchaseHeaderArchive: Record "Purchase Header Archive")

Parameters

Name Type Description
PurchaseHeader Table Microsoft.Purchases.Document."Purchase Header"
PurchaseHeaderArchive Table Microsoft.Purchases.Archive."Purchase Header Archive"

OnAfterStorePurchLineArchive

[IntegrationEvent(False,False)]
local procedure OnAfterStorePurchLineArchive(var PurchHeader: Record "Purchase Header", var PurchLine: Record "Purchase Line", var PurchHeaderArchive: Record "Purchase Header Archive", var PurchLineArchive: Record "Purchase Line Archive")

Parameters

Name Type Description
PurchHeader Table Microsoft.Purchases.Document."Purchase Header"
PurchLine Table Microsoft.Purchases.Document."Purchase Line"
PurchHeaderArchive Table Microsoft.Purchases.Archive."Purchase Header Archive"
PurchLineArchive Table Microsoft.Purchases.Archive."Purchase Line Archive"

OnAfterRestoreSalesDocument

[IntegrationEvent(False,False)]
local procedure OnAfterRestoreSalesDocument(var SalesHeader: Record "Sales Header", var SalesHeaderArchive: Record "Sales Header Archive")

Parameters

Name Type Description
SalesHeader Table Microsoft.Sales.Document."Sales Header"
SalesHeaderArchive Table Microsoft.Sales.Archive."Sales Header Archive"

OnAfterRestoreSalesLine

[IntegrationEvent(False,False)]
local procedure OnAfterRestoreSalesLine(var SalesHeader: Record "Sales Header", var SalesLine: Record "Sales Line", var SalesHeaderArchive: Record "Sales Header Archive", var SalesLineArchive: Record "Sales Line Archive")

Parameters

Name Type Description
SalesHeader Table Microsoft.Sales.Document."Sales Header"
SalesLine Table Microsoft.Sales.Document."Sales Line"
SalesHeaderArchive Table Microsoft.Sales.Archive."Sales Header Archive"
SalesLineArchive Table Microsoft.Sales.Archive."Sales Line Archive"

OnAfterRestoreSalesLines

[IntegrationEvent(False,False)]
local procedure OnAfterRestoreSalesLines(var SalesHeader: Record "Sales Header", var SalesLine: Record "Sales Line", var SalesHeaderArchive: Record "Sales Header Archive", var SalesLineArchive: Record "Sales Line Archive")

Parameters

Name Type Description
SalesHeader Table Microsoft.Sales.Document."Sales Header"
SalesLine Table Microsoft.Sales.Document."Sales Line"
SalesHeaderArchive Table Microsoft.Sales.Archive."Sales Header Archive"
SalesLineArchive Table Microsoft.Sales.Archive."Sales Line Archive"

OnAfterSalesHeaderArchiveInsert

[IntegrationEvent(False,False)]
local procedure OnAfterSalesHeaderArchiveInsert(var SalesHeaderArchive: Record "Sales Header Archive", SalesHeader: Record "Sales Header")

Parameters

Name Type Description
SalesHeaderArchive Table Microsoft.Sales.Archive."Sales Header Archive"
SalesHeader Table Microsoft.Sales.Document."Sales Header"

OnAfterPurchHeaderArchiveInsert

[IntegrationEvent(False,False)]
local procedure OnAfterPurchHeaderArchiveInsert(var PurchaseHeaderArchive: Record "Purchase Header Archive", PurchaseHeader: Record "Purchase Header")

Parameters

Name Type Description
PurchaseHeaderArchive Table Microsoft.Purchases.Archive."Purchase Header Archive"
PurchaseHeader Table Microsoft.Purchases.Document."Purchase Header"

OnAfterTransferFromArchToSalesHeader

[IntegrationEvent(False,False)]
local procedure OnAfterTransferFromArchToSalesHeader(var SalesHeader: Record "Sales Header", var SalesHeaderArchive: Record "Sales Header Archive")

Parameters

Name Type Description
SalesHeader Table Microsoft.Sales.Document."Sales Header"
SalesHeaderArchive Table Microsoft.Sales.Archive."Sales Header Archive"

OnAfterTransferFromArchToSalesLine

[IntegrationEvent(False,False)]
local procedure OnAfterTransferFromArchToSalesLine(var SalesLine: Record "Sales Line", var SalesLineArchive: Record "Sales Line Archive")

Parameters

Name Type Description
SalesLine Table Microsoft.Sales.Document."Sales Line"
SalesLineArchive Table Microsoft.Sales.Archive."Sales Line Archive"

OnBeforeAutoArchiveSalesDocument

[IntegrationEvent(False,False)]
local procedure OnBeforeAutoArchiveSalesDocument(var SalesHeader: Record "Sales Header", var IsHandled: Boolean)

Parameters

Name Type Description
SalesHeader Table Microsoft.Sales.Document."Sales Header"
IsHandled Boolean

OnBeforeAutoArchivePurchDocument

[IntegrationEvent(False,False)]
local procedure OnBeforeAutoArchivePurchDocument(var PurchaseHeader: Record "Purchase Header", var IsHandled: Boolean)

Parameters

Name Type Description
PurchaseHeader Table Microsoft.Purchases.Document."Purchase Header"
IsHandled Boolean

OnBeforeArchivePurchDocument

[IntegrationEvent(False,False)]
local procedure OnBeforeArchivePurchDocument(var PurchaseHeader: Record "Purchase Header", var IsHandled: Boolean)

Parameters

Name Type Description
PurchaseHeader Table Microsoft.Purchases.Document."Purchase Header"
IsHandled Boolean

OnBeforeSalesHeaderInsert

[IntegrationEvent(False,False)]
local procedure OnBeforeSalesHeaderInsert(var SalesHeader: Record "Sales Header", SalesHeaderArchive: Record "Sales Header Archive")

Parameters

Name Type Description
SalesHeader Table Microsoft.Sales.Document."Sales Header"
SalesHeaderArchive Table Microsoft.Sales.Archive."Sales Header Archive"

OnBeforeRestoreSalesDocument

[IntegrationEvent(False,False)]
local procedure OnBeforeRestoreSalesDocument(var SalesHeaderArchive: Record "Sales Header Archive", var IsHandled: Boolean)

Parameters

Name Type Description
SalesHeaderArchive Table Microsoft.Sales.Archive."Sales Header Archive"
IsHandled Boolean

OnBeforeCheckIfDocumentIsPartiallyPosted

[IntegrationEvent(False,False)]
local procedure OnBeforeCheckIfDocumentIsPartiallyPosted(var SalesHeaderArchive: Record "Sales Header Archive", var DoCheck: Boolean)

Parameters

Name Type Description
SalesHeaderArchive Table Microsoft.Sales.Archive."Sales Header Archive"
DoCheck Boolean

OnBeforeGetNextVersionNo

[IntegrationEvent(False,False)]
local procedure OnBeforeGetNextVersionNo(TableId: Integer, DocType: Option, DocNo: Code[20], DocNoOccurrence: Integer, var VersionNo: Integer, var IsHandled: Boolean)

Parameters

Name Type Description
TableId Integer
DocType Option
DocNo Code[20]
DocNoOccurrence Integer
VersionNo Integer
IsHandled Boolean

OnBeforeSalesHeaderArchiveInsert

[IntegrationEvent(False,False)]
local procedure OnBeforeSalesHeaderArchiveInsert(var SalesHeaderArchive: Record "Sales Header Archive", SalesHeader: Record "Sales Header")

Parameters

Name Type Description
SalesHeaderArchive Table Microsoft.Sales.Archive."Sales Header Archive"
SalesHeader Table Microsoft.Sales.Document."Sales Header"

OnBeforeSalesLineArchiveInsert

[IntegrationEvent(False,False)]
local procedure OnBeforeSalesLineArchiveInsert(var SalesLineArchive: Record "Sales Line Archive", SalesLine: Record "Sales Line")

Parameters

Name Type Description
SalesLineArchive Table Microsoft.Sales.Archive."Sales Line Archive"
SalesLine Table Microsoft.Sales.Document."Sales Line"

OnBeforePurchHeaderArchiveInsert

[IntegrationEvent(False,False)]
local procedure OnBeforePurchHeaderArchiveInsert(var PurchaseHeaderArchive: Record "Purchase Header Archive", PurchaseHeader: Record "Purchase Header")

Parameters

Name Type Description
PurchaseHeaderArchive Table Microsoft.Purchases.Archive."Purchase Header Archive"
PurchaseHeader Table Microsoft.Purchases.Document."Purchase Header"

OnBeforePurchLineArchiveInsert

[IntegrationEvent(False,False)]
local procedure OnBeforePurchLineArchiveInsert(var PurchaseLineArchive: Record "Purchase Line Archive", PurchaseLine: Record "Purchase Line")

Parameters

Name Type Description
PurchaseLineArchive Table Microsoft.Purchases.Archive."Purchase Line Archive"
PurchaseLine Table Microsoft.Purchases.Document."Purchase Line"

OnBeforeStoreSalesDocument

[IntegrationEvent(False,False)]
local procedure OnBeforeStoreSalesDocument(var SalesHeader: Record "Sales Header", var IsHandled: Boolean)

Parameters

Name Type Description
SalesHeader Table Microsoft.Sales.Document."Sales Header"
IsHandled Boolean

OnGetNextOccurrenceNo

[IntegrationEvent(False,False)]
local procedure OnGetNextOccurrenceNo(TableId: Integer, DocType: Option, DocNo: Code[20], var OccurenceNo: Integer)

Parameters

Name Type Description
TableId Integer
DocType Option
DocNo Code[20]
OccurenceNo Integer

OnGetNextVersionNo

[IntegrationEvent(False,False)]
local procedure OnGetNextVersionNo(TableId: Integer, DocType: Option, DocNo: Code[20], DocNoOccurrence: Integer, var VersionNo: Integer)

Parameters

Name Type Description
TableId Integer
DocType Option
DocNo Code[20]
DocNoOccurrence Integer
VersionNo Integer

OnRestoreDocumentOnAfterDeleteSalesHeader

[IntegrationEvent(False,False)]
local procedure OnRestoreDocumentOnAfterDeleteSalesHeader(var SalesHeader: Record "Sales Header")

Parameters

Name Type Description
SalesHeader Table Microsoft.Sales.Document."Sales Header"

OnRestoreDocumentOnBeforeDeleteSalesHeader

[IntegrationEvent(False,False)]
local procedure OnRestoreDocumentOnBeforeDeleteSalesHeader(var SalesHeader: Record "Sales Header", var SkipDeletingLinks: Boolean)

Parameters

Name Type Description
SalesHeader Table Microsoft.Sales.Document."Sales Header"
SkipDeletingLinks Boolean

OnRestoreSalesLinesOnAfterCalcShouldValidateQuantity

[IntegrationEvent(False,False)]
local procedure OnRestoreSalesLinesOnAfterCalcShouldValidateQuantity(var SalesLine: Record "Sales Line", var SalesLineArchive: Record "Sales Line Archive", var ShouldValidateQuantity: Boolean)

Parameters

Name Type Description
SalesLine Table Microsoft.Sales.Document."Sales Line"
SalesLineArchive Table Microsoft.Sales.Archive."Sales Line Archive"
ShouldValidateQuantity Boolean

OnRestoreSalesDocumentOnAfterSalesHeaderInsert

[IntegrationEvent(False,False)]
local procedure OnRestoreSalesDocumentOnAfterSalesHeaderInsert(var SalesHeader: Record "Sales Header", var SalesHeaderArchive: Record "Sales Header Archive")

Parameters

Name Type Description
SalesHeader Table Microsoft.Sales.Document."Sales Header"
SalesHeaderArchive Table Microsoft.Sales.Archive."Sales Header Archive"

OnRestoreSalesLinesOnAfterSalesLineInsert

[IntegrationEvent(False,False)]
local procedure OnRestoreSalesLinesOnAfterSalesLineInsert(var SalesLine: Record "Sales Line", var SalesLineArchive: Record "Sales Line Archive")

Parameters

Name Type Description
SalesLine Table Microsoft.Sales.Document."Sales Line"
SalesLineArchive Table Microsoft.Sales.Archive."Sales Line Archive"

OnRestoreSalesLinesOnAfterSalesLineArchiveSetFilters

[IntegrationEvent(False,False)]
local procedure OnRestoreSalesLinesOnAfterSalesLineArchiveSetFilters(var SalesLineArchive: Record "Sales Line Archive", var SalesHeaderArchive: Record "Sales Header Archive", SalesHeader: Record "Sales Header")

Parameters

Name Type Description
SalesLineArchive Table Microsoft.Sales.Archive."Sales Line Archive"
SalesHeaderArchive Table Microsoft.Sales.Archive."Sales Header Archive"
SalesHeader Table Microsoft.Sales.Document."Sales Header"

OnRestoreSalesLinesOnBeforeSalesLineInsert

[IntegrationEvent(False,False)]
local procedure OnRestoreSalesLinesOnBeforeSalesLineInsert(var SalesLine: Record "Sales Line", var SalesLineArchive: Record "Sales Line Archive")

Parameters

Name Type Description
SalesLine Table Microsoft.Sales.Document."Sales Line"
SalesLineArchive Table Microsoft.Sales.Archive."Sales Line Archive"

OnRestoreSalesLinesOnAfterValidateQuantity

[IntegrationEvent(False,False)]
local procedure OnRestoreSalesLinesOnAfterValidateQuantity(var SalesLine: Record "Sales Line", var SalesLineArchive: Record "Sales Line Archive")

Parameters

Name Type Description
SalesLine Table Microsoft.Sales.Document."Sales Line"
SalesLineArchive Table Microsoft.Sales.Archive."Sales Line Archive"

OnStorePurchDocumentCommentsOnBeforePurchCommentLineArchInsert

[IntegrationEvent(False,False)]
local procedure OnStorePurchDocumentCommentsOnBeforePurchCommentLineArchInsert(var PurchCommentLineArchive: Record "Purch. Comment Line Archive", PurchCommentLine: Record "Purch. Comment Line")

Parameters

Name Type Description
PurchCommentLineArchive Table Microsoft.Purchases.Archive."Purch. Comment Line Archive"
PurchCommentLine Table Microsoft.Purchases.Comment."Purch. Comment Line"

OnStoreSalesDocumentCommentsOnBeforeSalesCommentLineArchInsert

[IntegrationEvent(False,False)]
local procedure OnStoreSalesDocumentCommentsOnBeforeSalesCommentLineArchInsert(var SalesCommentLineArchive: Record "Sales Comment Line Archive", SalesCommentLine: Record "Sales Comment Line")

Parameters

Name Type Description
SalesCommentLineArchive Table Microsoft.Sales.Archive."Sales Comment Line Archive"
SalesCommentLine Table Microsoft.Sales.Comment."Sales Comment Line"

OnBeforeStorePurchDocument

[IntegrationEvent(False,False)]
local procedure OnBeforeStorePurchDocument(var PurchHeader: Record "Purchase Header", var IsHandled: Boolean)

Parameters

Name Type Description
PurchHeader Table Microsoft.Purchases.Document."Purchase Header"
IsHandled Boolean

OnBeforeArchiveSalesDocument

[IntegrationEvent(False,False)]
local procedure OnBeforeArchiveSalesDocument(var SalesHeader: Record "Sales Header", var IsHandled: Boolean)

Parameters

Name Type Description
SalesHeader Table Microsoft.Sales.Document."Sales Header"
IsHandled Boolean

OnRestoreDeferralsOnAfterGetDeferralHeaderArchive

[IntegrationEvent(False,False)]
local procedure OnRestoreDeferralsOnAfterGetDeferralHeaderArchive(DeferralHeaderArchive: Record "Deferral Header Archive", var DeferralHeader: Record "Deferral Header")

Parameters

Name Type Description
DeferralHeaderArchive Table Microsoft.Finance.Deferral."Deferral Header Archive"
DeferralHeader Table Microsoft.Finance.Deferral."Deferral Header"

OnBeforeArchPurchDocumentNoConfirm

[IntegrationEvent(False,False)]
local procedure OnBeforeArchPurchDocumentNoConfirm(var PurchaseHeader: Record "Purchase Header", var IsHandled: Boolean)

Parameters

Name Type Description
PurchaseHeader Table Microsoft.Purchases.Document."Purchase Header"
IsHandled Boolean

OnBeforeArchSalesDocumentNoConfirm

[IntegrationEvent(False,False)]
local procedure OnBeforeArchSalesDocumentNoConfirm(var SalesHeader: Record "Sales Header", var IsHandled: Boolean)

Parameters

Name Type Description
SalesHeader Table Microsoft.Sales.Document."Sales Header"
IsHandled Boolean

OnRestoreSalesLineCommentsOnBeforeInsertSalesCommentLine

[IntegrationEvent(False,False)]
local procedure OnRestoreSalesLineCommentsOnBeforeInsertSalesCommentLine(var SalesCommentLine: Record "Sales Comment Line")

Parameters

Name Type Description
SalesCommentLine Table Microsoft.Sales.Comment."Sales Comment Line"

OnRestoreSalesDocumentOnBeforeSalesHeaderValidateFields

[IntegrationEvent(False,False)]
local procedure OnRestoreSalesDocumentOnBeforeSalesHeaderValidateFields(var SalesHeader: Record "Sales Header", SalesHeaderArchive: Record "Sales Header Archive")

Parameters

Name Type Description
SalesHeader Table Microsoft.Sales.Document."Sales Header"
SalesHeaderArchive Table Microsoft.Sales.Archive."Sales Header Archive"

See also