Example scenarios

This section contains scenarios that should be used to improve understanding of the API and the system settings that are required before performing an integration. The scenarios are covered in different integration samples that can be downloaded as part of the SDK package. This table depicts the samples in which each capability is implemented, and points out the capabilities that are exposed in the Kofax AP Essentials API.

Services and capabilities Scenarios


Data capture AP automation
Uploading documents File-based integration External data verification Uploading master data Workflow integration
Operational management        
User management        
Customer account management          
User feedback          
Data extraction    
Header field extraction    
Line item extraction        
Auto-learning with external verification          
Document processing      
Verification of header fields      
Verification of line items          
Approval workflow          
Preliminary post          
Final post          
Correction workflow          
File upload        
Document download      
Master-data upload        
File upload          

Each scenario is described from a high level perspective for a general understanding. But they are also described on a step by step basis so the relevant configuration could be done in Kofax AP Essentials when the code should be run. The steps where the code is to be run is marked with a green arrow ().


This scenario demonstrates how to authenticate a user in Kofax AP Essentials. In addition to logging on, it also retrieves the current user (the user you are logged in with). The scenario uses the Authentication and Users API services.

Authentication tokens are saved in a cookie and expire after 30 minutes of inactivity. Therefore, your integration does not need to re-authenticate for every API operation. You only need to authenticate if your integration has not made a request for over 30 minutes.

  1. Make sure that a customer account has been created and that you have created an admin user.
  2. Log in to Kofax AP Essentials using the API code and make sure that the current user is retrieved.
    const string ApiKey = "<enter your API key>";
    const string ServiceUri = @"https://services.readsoftonline.com"; // European system
    const string UserName = "<enter your username>";
    const string Password = "<enter your password>";
    // Authenticate
    var config = ClientConfiguration.Create(Guid.Parse(ApiKey), new Uri(ServiceUri));
    var authClient = new AuthenticationServiceClient(config);
    var credentials = new AuthenticationCredentials
     AuthenticationType = AuthenticationType.SetCookie,
     UserName = UserName,
     Password = Password
    var authenticationResult = authClient.Authenticate(credentials);
    if (authenticationResult.Status != AuthenticationStatus.Success)
     Console.WriteLine("Error logging in");
    // Get current user info
    var userClient = new UserServiceClient(config);
    var user = userClient.GetCurrentUser();
    Console.WriteLine("Hello {0}!", user.FullName);

Uploading documents

Scan Diagram

This scenario demonstrates how to upload documents to Kofax AP Essentials. A customer can use this scenario, for example, to upload scanned documents to Kofax AP Essentials. In this case, the integration is installed on a scanning workstation where the locally scanned documents are accessed.

The scenario uses the Authentication and Files API services.

  1. Make sure that a customer account has been created and that you have created a customer user.
  2. Scan a document to a local folder.

    Use the API code to upload a document to Kofax AP Essentials using a customer user login.

  3. Log in to Kofax AP Essentials and check that a document has been uploaded properly.
    // Upload a file (SelectedFilePath)
    // Requires CurrentCustomer, SelectedBuyer and SelectedDocumentType to be set
    ClientConfiguration config = Authenticate();
    var stream = File.Open(SelectedFilePath, FileMode.Open, FileAccess.Read, FileShare.Read);
    var fileClient = new FileServiceClient(config);
    var result = fileClient.UploadImage2(
     Path.GetFileName(SelectedFilePath), CurrentCustomer.Id, String.Empty,
     SelectedBuyer.Id, SelectedDocumentType.SystemName,
     "OneDocumentPerFile", stream); // alternatively: "MultipleDocumentsPerFile"
    if (result.Value)
     Console.WriteLine("File uploaded successfully!");
     Console.WriteLine("Error uploading image");

File-based integration

File-based Integration Diagram

This scenario gives a basic understanding of how Kofax AP Essentials works with the data-capture process. Typically, a partner integrator uses Kofax AP Essentials to integrate with an on-premise solution that is installed locally at the customer site. This scenario uses the Authentication, Files and Documents API services.

File upload

Kofax AP Essentials works with batches to keep documents together, since files can contain multiple documents.

File uploading takes place at the scan workstation where documents are scanned to the local folders. The local folders are checked at a regular intervals. If any files are found in the folders, they are uploaded to Kofax AP Essentials. After the file enters Kofax AP Essentials, a batch is created with one or more documents, and it is ready for interpretation and verification.

Document download

After a document has been verified by a user, the document is sent to the ERP system. This is handled by the ERP system integration server, where the integration software has been installed.

  1. Make sure that a customer account has been created and that you have created a customer user. You must also configure one document type with header fields that are configured in the Extraction service.
  2. Set the target system to API.
  3. Scan a document to a local folder.
  4. Use the API code to upload a document to Kofax AP Essentials using a customer user login.
  5. Log in to Kofax AP Essentials Office and verify the document and its header-field information.
  6. Use the API code to download the document (and send it to the ERP system you choose).
    public void DownloadOutputDocumentsReadyForExport(ClientConfiguration clientConfig)
     var client = new DocumentServiceClient(clientConfig);
     var documents = client.GetOutputDocumentsByCurrentCustomer();
     foreach (var docRef in documents)
     if (docRef.OutputOperation == OutputOperationType.Export)
     // Download image and xml
     DownloadOutputDocument(client, docRef);
     // Report document as downloaded
     client.DocumentStatus(docRef.DocumentId, new OutputResult{Status = OutputStatus.Success});
     catch (Exception ex)
     // Report error back to Online
     string errorMessage = string.Format("Error processing document: {0}", ex.Message);
     var rejectedInfo = new OutputResult
     { Status = OutputStatus.RejectDocument, Message = errorMessage };
     client.DocumentStatus(docRef.DocumentId, rejectedInfo);
    private static void DownloadOutputDocument(DocumentServiceClient docClient, DocumentReference docRef)
     string documentBasePath = Path.Combine(Settings.Default.DownloadFolder, docRef.DocumentId);
     string contentType = string.Empty;
     // Download image file
     var imageStream = docClient.GetDocumentOutputImage(docRef.DocumentId, response =>
     { contentType = response.ContentType; });
     using (imageStream)
     string imageFileExtension = GetFileExtensionFromContentType(contentType);
     string imageFilePath = Path.ChangeExtension(documentBasePath, imageFileExtension);
     WriteStreamToFile(imageStream, imageFilePath);
     // Download xml file
     var documentDataStream = docClient.GetDocumentOutputData(docRef.DocumentId,
     new MetaDataCollection(), response => { contentType = response.ContentType; });
     using (documentDataStream)
     string documentDataExtension = GetFileExtensionFromContentType(contentType);
     string documentDataFilePath = Path.ChangeExtension(documentBasePath, documentDataExtension);
     WriteStreamToFile(documentDataStream, documentDataFilePath);
    private static string GetFileExtensionFromContentType(string contentType)
    { ... }
    private static void WriteStreamToFile(Stream stream, string filePath)
    { ... }

External data verification

External Verification Diagram

This scenario demonstrates how to integrate external data verification with Kofax AP Essentials. Normally, data verification is performed in Kofax AP Essentials Office, where you can verify each field with help from the auto-complete functionality and draw on the image so the data is interpreted. Kofax AP Essentials also provides automatic learning functionality. After a document has been verified, the document template is relearned using feedback from the user. For example, if the user draws a field on the invoice, Kofax AP Essentials relearns the template using the new field location. This improves data capture performance the next time the same supplier invoice enters Kofax AP Essentials.

If verification is performed outside of Kofax AP Essentials, you can use the API to send validated data back to Kofax AP Essentials, so you do not lose the auto-learning benefits. You can do this by using a specific API method call in the Document API service, which is shown in this example.

All data that is used during verification must be sent back to Kofax AP Essentials. Data that is confirmed by the user (whether modified or not) must be sent back through the API. Kofax AP Essentials uses the modified and unmodified data to automatically learn field positions on the invoice. On the other hand, data that has not been confirmed by a user should not be sent back to Kofax AP Essentials because it is not confirmed to be correct, and the automatic learning process might be mislead by sending back incorrect data.

This scenario uses the Authentication and Documents API service.

Feedback of external verification data

In this scenario, a partner is developing an external application that will be the only interface for the end users. The external application has a user interface that can create new customers and customer users. During document processing, the documents are sent to Kofax AP Essentials via email from the end customers or their suppliers. After the document is interpreted by Kofax AP Essentials, they are downloaded by the integration component and presented to the end user through the external application. The end user can see the document image and fill in fields where the interpreted data (if any) is present. After manual verification, the integration component takes the verified field values and sends them back to Kofax AP Essentials so the auto-learning step is triggered. The end user can also send user feedback.

  1. Make sure that a partner account has been created with an administrator user.
  2. Make sure the partner account has only one document type (with line items) selected and that this type is selected as the default document type.
  3. Make sure that API is the only target system enabled for the partner account.
  4. Enable the Process control service and select Never in the Data verification settings. This allows documents to bypass verification, since the scenario uses external verification.
  5. Create a customer using the integration component.
  6. Send a document to Kofax AP Essentials through email. After the file is uploaded, the file is prepared (by different image enhancements) and the field data is extracted.
  7. Use the API code to download a document and send it to the external verification application.
  8. Use the API code to verify the document in the external verification application and create user feedback.
  9. Use the API code to send the verified data to Kofax AP Essentials, so auto-learning process can take place. At the same time, send the external user feedback to Kofax AP Essentials in order to inform the system that interpretation enhancements must be performed.
  10. To make sure that the auto-learning step was performed: Send another document (from the same supplier) to Kofax AP Essentials via email. Check if the document interpretation was enhanced by the feedback that was sent previously.
    private void ApproveCurrentDocument()
     if (CurrentDocument == null)
     throw new Exception("No document downloaded");
     var docClient = new DocumentServiceClient(_authorizationManager.Configuration);
     // Update document with data from our UI
     // You are allowed to change:
     // - Field values
     // - Field positions (If you have a UI that allows for users to 
     // rubber-band new values)
     // - Supplier name
     var doc = CurrentDocument.DocumentModel;
     var supplier = doc.GetSupplierParty();
     supplier.Name = CurrentDocument.SupplierName;
     var invoiceNumField = doc.GetHeaderField("invoicenumber");
     if (invoiceNumField != null)
     invoiceNumField.Text = CurrentDocument.InvoiceNumber;
     invoiceNumField.Position = "0,0,0,0"; // left, top, width, height
     // (Tip: you can use the .net class RectangleConverter
     // (For example ConvertToInvariantString) to convert rects to strings and vice versa)
     var amountField = doc.GetHeaderField("invoicetotalvatincludedamount");
     if (amountField != null)
     amountField.Text = CurrentDocument.TotalAmount;
     amountField.Position = "0,0,0,0";
     // Send document back for auto-learning purposes
     docClient.LearnDocument(doc.Id, doc);
     // Mark document as downloaded
     docClient.DocumentStatus(doc.Id, new OutputResult { Status = OutputStatus.Success });
     // Pass along to next system, e.g. an ERP system
     // ...
     UpdateUserMessage("Document approved");
     CurrentDocument = null;
     catch (Exception ex)
     UpdateUserMessage("Error approving document: " + ex.Message);

Uploading master data

This example shows how to upload master data. Two code samples are provided: one for uploading supplier master and one for uploading customer master data. The API services used in this scenario are Authentication, Documents and Master data.

Integration Diagram

In this case, a partner integrator wants to implement autocomplete functionality by connecting fields to master data. During verification, the master data provides autocomplete functionality to connected fields. For example, when master data is connected to the supplier field or customer field, depending on which document process you use, users can easily select the correct supplier/customer from a list. Selecting values from a list is less prone to errors and more efficient and than entering values manually. However, manually exporting master data from the ERP system and uploading it to Kofax AP Essentials on a regular basis can be tedious, so we will demonstrate how to automate this task using the API.

Master data upload

Master data is retrieved from the ERP system and uploaded to Kofax AP Essentials, where it is available during verification. Typically, the integration software runs on the integration server and synchronizes the master-data once or twice per day. This limits the load on the ERP system but still offers the data to be available reasonably fast.

  1. Make sure that a customer account has been created and that you have created a user. You must also configure one document type with header fields connected to master data (configured in the Extraction service).
  2. Set the target system to API and make sure that the Master data service is activated.
  3. Use the API code to synchronize the master data, so all available suppliers/customers are uploaded to Kofax AP Essentials.
  4. Send or upload a document to Kofax AP Essentials.
  5. Verify the document. Make sure that the imported suppliers/customers are available for selection during verification.

    Code example: Uploading supplier master data

    This code example demonstrates how to upload supplier master data to Kofax AP Essentials.

    public void UploadMasterData(ClientConfiguration clientConfig)
     var accountClient = new AccountServiceClient(clientConfig);
     var currentCustomer = accountClient.GetCurrentCustomer();
     // If IsMasterDataOnCustomerLevel is set, this customer has buyers but wants
     // to manage master data on the customer level. In other words, share
     // master data between buyers. In that case, we upload directly to the customer.
     // If IsMasterDataOnCustomerLevel is not set and the customer has buyers, we
     // upload data to specific buyers.
     var userConfig = accountClient.GetUserConfiguration(currentCustomer.Id);
     var buyers = accountClient.GetCurrentUserBuyers();
     bool hasBuyers = (buyers.Count > 1 || (buyers.Count == 1 && buyers.First().Id != currentCustomer.Id));
     bool uploadToBuyers = !userConfig.IsMasterDataOnCustomerLevel && hasBuyers;
     var masterDataClient = new MasterDataServiceClient(clientConfig);
     if (uploadToBuyers)
     foreach (var buyer in buyers)
    private void UploadMasterDataToOrganization(string organizationId, string erpClientId, MasterDataServiceClient masterDataClient)
     var erpClient = new FakeERPClient.ErpClient(erpClientId);
     var erpSuppliers = erpClient.GetAllSuppliers();
     var onlineSuppliers = from erpSupplier in erpSuppliers select ToOnlineSupplier(erpSupplier);
     masterDataClient.SetSuppliers(organizationId, new SupplierCollection(onlineSuppliers));
    private Supplier ToOnlineSupplier(FakeERPClient.Supplier erpSupplier)
     return new Supplier
     SupplierNumber = erpSupplier.Number,
     Name = erpSupplier.Name

Workflow integration

This scenario describes how to coordinate the Workflow service with an ERP integration. This scenario applies if a partner wants to integrate with the ERP system with the Kofax AP Essentials workflow service, so they can offer a solution to their customers to handle their approval workflows. In this case, Kofax AP Essentials supports a two-step procedure for transferring data to the ERP system:

  • The registration step, where a preliminary registration of the document takes place in the ERP system. This occurs directly after data verification.
  • The final posting step, where the data can be updated with any corrections that have taken place during the approval workflow steps.

Two-step integration

The same document downloading methods are used in the API as previous examples. The difference between the two steps is the status of the document. During the first step, the document has the status, register, while in the second step, the document has the status, post.


This scenario also uses Kofax AP Essentials Storage, where the documents are stored. The main benefit is having Kofax AP Essentials store all processing information, such as data and history, in one place, together with the document image. This is useful for customers that do not have access to the ERP system, but still want to have one place to store their documents. Storage also has support for file uploading, with or without a connection to existing documents.

Storage Diagram
  1. Make sure that a customer account has been created and that you have created a user. You must also configure one document type with header fields that are configured in the Extraction service.
  2. Enable the Workflow service and create at least one workflow, and enable the Storage service. Let the user have the approval admin role and set the privileges to access the Manage and Storage views.

    Send or upload a document to Kofax AP Essentials and verify the document. Make sure to select a supplier that have been uploaded to Kofax AP Essentials as master data.

  3. Use the API code to download a document with registration status and do a preliminary posting (registration) to the fake ERP system.

    Approve the invoice in the approval workflow.

  4. Use the API code to download a document the second time; this time with the post status. Do a final posing (post) of the document to the fake ERP system.
  5. Check that the voucher has been created properly in the fake ERP system.
  6. Check if you can find the document in Kofax AP Essentials Storage.
  7. Try to upload a file as an attachment to the existing document.
     if (documentReference.OutputOperation == OutputOperationType.Register)
     // "Register" document
     var regResult = RegisterInvoice(documentServiceClient, documentReference);
     // Report registration result
     documentServiceClient.DocumentStatus(documentReference.DocumentId, regResult);
     else if (documentReference.OutputOperation == OutputOperationType.Post)
     // Download image
     string localImageTempPath = DownloadImage(documentServiceClient, documentReference);
     // Post Voucher to ERP system based on the document data
     string voucherId = CreateVoucher(documentServiceClient,
     // Report document as posted
     string message = string.Format("Voucher {0} posted successfully in FakeERP.", voucherId);
     documentServiceClient.DocumentStatus(documentReference.DocumentId, new OutputResult
     Status = OutputStatus.Success,
     Message = message
    catch (Exception ex)
     string errorMessage = string.Format("Error processing document: {0}", ex.Message);
     var rejectedInfo = new OutputResult
     Status = OutputStatus.RejectDocument,
     Message = errorMessage
     documentServiceClient.DocumentStatus(documentReference.DocumentId, rejectedInfo);