Zetadocs SDK API

<< Click to Display Table of Contents >>

Navigation:  Zetadocs SDK Guide >

Zetadocs SDK API

Welcome to the Zetadocs API browser – your one-stop shop for all Zetadocs-based APIs from Equisys. 

 

For examples of collections management go to the OnBeforeDevliery event and for examples of Autolinking go to the OnBeforeCapture event.

 

Important: This SDK provides a supported set of APIs, methods, and codeunits. Use of any internal or undocumented components outside of the SDK is not supported and may lead to unexpected behavior. We strongly recommend working only with the interfaces and methods documented here.

 

Event name

Runs

OnBeforeDelivery

Before an email is sent, this event will happen on the Batch Server.

OnBeforeCapture

When a user clicks on the Auto Linking Button, before attempting to Manually Link a document.

OnBeforeArchive

Before archiving documents to SharePoint Online with Zetadocs, includes archiving on Zetadocs send; archiving with the Factbox and archiving from a Documents Queue.

OnAfterGenerateSendResults

Runs after any Zetadocs System/Customer/Vendor rules have been applied to the email.

OnAfterZetadocsDelivery

Runs after the whole Delivery and/or Archiving process has been completed.

OnAddDefaultsToReviewLine

Runs after the key line fields (e.g. "Type" & "No.") have been modified. This event provides methods to access and update the Zetadocs Review line (e.g. to populate default information like the Tax/VAT groups and dimensions, or ensure a product code is still existent).

OnAfterCapture

Runs after the whole Zetadocs Capture process has been completed. It provides methods to access the individual "Capture Results" for each document being processed.

OnAfterGenerateCaptureResults

Runs after generating the record to associate the documents in the Document Queue, after archiving the document against the record, and before posting or deleting from the Document Queue.

OnEnumConversion

Runs prior to creation of the new Business Central invoice, to configure the mapping between Zetadocs enums and Business Central enums.

OnLookupReviewLine

Runs when the user triggers the Business Central OnLookup method (e.g. Line "No." or "Item Variant" fields). The field being looked up is specified in the lookup context.

OnValidateReviewLine

Runs after the fields of the Zetadocs Review line have been modified. It provides methods to access and update the Zetadocs Review line. This method is intended to ensure the validity of data and to raise an error if required. It also offers the possibility to consolidate the data instead.

OnBeforeReviewDisplay

Runs just before the Zetadocs Review page is displayed. It provides methods to access and update the Zetadocs Review Header and Zetadocs Review Lines. Note it will not be run if there are saved changes for the record from a previous visit to the Zetadocs Review page.

OnBeforeCreatePurchaseHeader

Runs just before the Purchase Header is created. It provides methods to access and update the Purchase Header and access the Zetadocs Review Header and Lines.

OnBeforeCreatePurchaseLine

Runs just before the Purchase Line is created. It provides methods to access and update the Purchase Line and access the Zetadocs Review Header and Lines.

OnBeforeDocumentQueueDisplay

Runs foreach item in the Document Queue before the Document Queue page is displayed. It provides methods to access and update the Document Queue Item.

OnAfterCreatePurchaseLine

Runs just after the Purchase Line is created. It provides methods to access and update the Purchase Line and access the Zetadocs Review Header and Lines.

OnAfterCreatePurchaseHeader

Runs just after the Purchase Header is created. It provides methods to access and update the Purchase Header and access the Zetadocs Review Header and Lines.

OnAfterCreatePurchaseRecord

Runs just after the Purchase Record has been created. It provides methods to access the created Purchase Header and Zetadocs Review Header and Lines.

Zetadocs Server Send

The Zetadocs Server Send codeunit exposes procedures that allow you to deliver emails of Business Central reports with all editions of Zetadocs. Zetadocs Delivery can be automated and scheduled with Zetadocs Delivery Plus.

Zetadocs Interface

The Zetadocs Interface Codeunit exposes procedures that allow you to use the Zetadocs functionality.