Kofax Brand Logo
Help for Kofax AP Agility Settings
  • Welcome
  • Overview
    • Invoice processing
      • Invoice processing document workflow
    • AP Agility workflow
  • Kofax AP Agility Work Queue
  • Kofax AP Agility Settings menu
    • Administration
      • Administration in an Azure environment
      • Workflow Variables
    • Organizations
      • Create New Organization window
      • Organization - Organization tab
      • Organization - Business Units tab
        • Business Unit: New or Edit
          • Role Assignments window
          • Approval Hierarchy window
          • Routing Options window
            • Routing Options window - Vendor Naming Groups tab
            • Routing Options window - Reason Codes tab
            • Routing Options window - Vendor Groups tab
            • Vendor Search window
          • Email Templates window
      • Organizations - Field Configuration tab
      • Variable - Edit window
    • IP Configuration
      • Global Settings
        • ASE Database Settings
          • ASE Database Settings - Edit window
        • Capture Profile Settings
          • Capture Profile Settings - Edit window
          • Capture Profile Settings - Copy From Profile window
        • Country Settings
        • Custom Extraction Profiles tabs
          • Analysis Profiles
            • Analysis Profile - Edit window
            • Analysis Profile - New window
          • Evaluation Profiles
            • Evaluation Profile - Edit window
            • Evaluation Profile - New window
          • Extraction Profiles
            • Extraction Profile - Edit window
            • Extraction Profile - New window
        • Custom Settings
          • Custom Settings - Edit window
          • Custom Settings - New window
        • Currency Settings
        • Database Connection
          • Database Connection Settings - Edit window
          • Database Connection Settings - New window
        • Document Type Formats
          • Document Type Format - Edit window
          • Document Type Format - New window
        • Error Message Settings
          • Error Message Settings - Edit window
        • Export Profile Settings
          • Export Profile Settings - Edit window
          • Export Profile Settings - Copy From Profile window
        • General Settings
        • Import Settings
        • Information Messages
          • Information Message Settings
            • Information Message Settings - Edit window
            • Information Message Settings - New window
          • Information Settings
        • Instruction Settings
          • Instruction Settings - Edit window
          • Instruction Settings - New window
        • Invalid Reasons
          • Invalid Reason Settings
            • Invalid Reason Type - Edit window
            • Invalid Reason Type - New window
          • Invalid Reason Text Settings
            • Invalid Reason Text Settings - Edit window
            • Invalid Reason Text Settings - New window
        • Organization Groups
          • Organization Group - New window
          • Organization Group - Edit window
        • Partition Settings
          • Employee Partition tab
            • Employee Partition - Edit window
            • Employee Partition - New window
          • PO Number Partition tab
            • PO Number Partition - Edit window
            • PO Number Partition - New window
          • Tax Partition tab
            • Tax Partition - Edit window
            • Tax Partition - New window
          • Vendor Partition tab
            • Vendor Partition - Edit window
            • Vendor Partition - New window
        • Roles and Permissions
          • Roles and Permissions window
        • Stored Procedure Settings
          • Stored Procedure Settings - Edit window
          • Stored Procedure Settings - New window
        • Substitution Rules
          • Substitution Rule - Edit window
          • Substitution Rule - New window
        • Tolerance Settings
          • Tolerance Settings - Edit window
          • Tolerance Settings - New window
      • Capture Profiles
        • Amount Settings
        • Bill-To Settings tabs
          • Bill-To Formats tab
            • Bill-To Formats - Edit window
            • Bill-To Formats - New window
          • Bill-To Settings tab
        • Company Code
        • Currency Settings
        • Date Settings
        • Document Type Settings
        • Extraction Settings
        • Field Settings
          • Field Settings - Edit window
          • Field Settings - New window
        • GL Code Determination
        • Invoice Number Settings
        • Invoice Type Settings
        • Line Item Table Settings
        • Line Pairing Settings
        • Material Number Settings
          • Material Number Settings - Edit window
          • Material Number Settings - New window
        • Misc Charge Settings tabs
          • Misc Charge Categories tab
            • Misc Charge Category - Edit window
            • Misc Charge Category - New window
          • Misc Charge Settings tab
        • Payment Method Settings
        • PO Number Settings tabs
          • PO Number Formats tab
            • PO Number Formats - Edit window
            • PO Number Formats - New window
          • PO Number Validation tab
        • SAP Configuration
        • Tax Rate Mapping
          • Tax Rate Mapping - Edit window
          • Tax Rate Mapping - New window
        • Tax Settings tabs
          • Tax Configuration tab
          • Tax Jurisdiction Codes tab
            • Tax Jurisdiction Code - Edit window
            • Tax Jurisdiction Code - New window
        • Unit Of Measure Settings tabs
          • Unit Of Measure Settings tab
          • Unit Of Measure Types tab
            • Unit Of Measure Type - Edit window
            • Unit Of Measure Type - New window
        • Vendor Settings
      • Invoice Export
        • CSV Export Settings
          • CSV Export Settings - Edit window
          • CSV Export Settings - New window
        • DB Export Settings tabs
          • DB Export Settings - Main tab
          • DB Export Settings - Header Table tab
            • DB Header Mapping - Edit window
            • DB Header Mapping - New window
          • DB Export Settings - Line Items Table tab
            • DB Line Item Mapping - Edit window
          • DB Export Settings - GL Items Table tab
            • DB GL Item Mapping - Edit window
          • DB Export Settings - Tax Table tab
            • DB Tax Mapping - Edit window
        • General Export Settings
        • Export to MarkView Settings
        • OCRXML File Export Settings
        • PDF Export Settings
        • Process Director Export Settings
        • Tiff Export Settings
        • XML Export Settings tabs
          • XML Export Settings - Main tab
          • XML Export Settings - Header Table tab
            • XML Header Mapping - Edit window
            • XML Header Mapping - New window
          • XML Export Settings - Line Items Table tab
            • XML Line Item Mapping - Edit window
          • XML Export Settings - GL Items Table tab
            • XML GL Item Mapping - Edit window
          • XML Export Settings - Tax Table tab
            • XML Tax Mapping - Edit window
      • Configuration Mangement
        • Create Migration Package
        • Import Migration Package
    • AP Configuration
    • ERP Connections
      • ERP Connections: New or Edit
    • GL Account Structures
      • GL Account Structure - New
      • Edit GL Account Structures
    • Email Notifications
  • Configure Kofax AP Agility
    • Manage IP Configuration
      • Access the Settings help
      • Save IP Configuration settings
      • Reload IP Configuration settings
      • Edit an existing entry
      • Add a new entry
      • Copy an entry
      • Delete an entry
      • Delete a field mapping in an export entry
      • Configuration management
        • Create a migration package
        • Import a migration package
    • Manage ERP integrations
      • Add an ERP connection
      • Web.config configuration changes
        • Configure the Agnostic ERP web.config entry
          • Exported invoice XML file structure
          • XSLT file for conversion from XML to CSV
        • Configure the PeopleSoft web.config entry
        • Configure the Dynamic AX web.config entry
        • Configure the Lawson web.config entry
        • Configure ERP databases
      • Configure ERP import job schedule
      • ERP import job status history
    • Manage organizations
      • Create a new organization based on a template
      • Add a new organization based on an existing organization
      • Edit an organization
      • Add a new business unit
      • Edit a business unit for an existing organization
      • Assign roles to a Business Unit
      • Edit a field configuration
      • Approval hierarchies for business units
        • Add an Approval Hierarchy level
        • Edit an approval hierarchy level
        • Delete an approval hierarchy level
      • Routing options for business units
        • Vendor naming groups
          • Add a vendor naming group
          • Edit a vendor naming group
          • Delete a vendor naming group
        • Reason codes
          • Add a reason code mapping
          • Edit a reason code mapping
          • Delete a reason code mapping
        • Vendor groups
          • Add a vendor group
          • Add vendors to a vendor group
          • Edit a vendor group
          • Edit the vendors in a vendor group
          • Delete a vendor from a vendor group
          • Delete a vendor group
      • Email Templates
        • Add an email template for a business unit
        • Edit an email template for a business unit
        • Delete an email template from a business unit
    • Manage users
      • Manage Invoice processing users
        • Resource groups
          • Resource group permissions
          • Organizations and organization groups
        • Manage user permissions in IP Configuration
          • Add Kofax TotalAgility Resources for invoice processing
          • Edit an existing user
        • Manage users in Kofax TotalAgility
          • Manage resource groups via Kofax TotalAgility
    • Manage Invoice processing
      • MarkView integration
        • Schedule import for MarkView data
        • Update PO Number Format for MarkView
      • Validation configuration
        • Invoice classification
        • Invoice CN classification
        • Database lookups
          • ASE databases
          • Kofax Search and Matching Server databases
            • KSMS BRWVendorMaster settings
            • KSMS BRWEmployeeMaster settings
            • KSMS CompanyAddressMaster settings
          • Restrict database searches by region
        • Information messages
        • Invalid Reason text
        • Validation form fields
          • Account Number
          • Alternate Payee
          • Australian Business Number
          • Bank Account / Bank Account Code
          • BIC
          • Bill-To Name
          • Company Code
          • Currency
          • Custom Fields
          • Delivery Date
          • Delivery Note
          • Discount
          • Document Type
          • Due Date
          • Employee ID
          • Employee Name
          • Exchange Rate / Local VAT Amount
          • Freight Amount
          • Harmonized Sales Tax
          • IBAN
          • ICMS Tax Amount
          • Invalid Reason
          • Invoice Code CN
          • Invoice Date
          • Invoice Number
          • Invoice Type
          • Line Item Detail
          • Mexican UUID Number
          • Misc. Amount
          • Password CN
          • Payment Order Reference Number / Subscriber Number
          • Payment Reference
          • PO Extension
          • PO Type
          • Provincial Sales Tax
          • Purchase Order Number
          • SubTotal
          • Tax Amount 1
          • Tax Fields
          • Total
          • Vendor ID / Site ID / Internal Vendor ID
          • Vendor VAT Registration Number / Bill-To VAT Registration Number
          • Withholding Tax Amount / ISR Retention (Mexico)
          • Your Ref
        • Document rejection
      • Extraction online learning
      • Line pairing
        • Line pairing for third-party freight invoices
        • Handle miscellaneous charges
          • Miscellaneous charge categories
          • Assign header fields to a Miscellaneous Charge Category
          • Assign line items to a Miscellaneous Charge Category
          • Post miscellaneous charges as a specific line type
          • Post miscellaneous charges as unplanned costs
          • Post miscellaneous charges to planned conditions
          • Post miscellaneous charges to a general ledger account
          • General ledger account code table
          • Third-party freight
        • Tax configuration for countries with tax jurisdictions
          • Basic tax configuration
          • Set the default purchase order tax code
          • Configure a state-dependent tax code
        • Tax configuration for countries with no tax jurisdictions
          • Tax table access sequence
          • Tax code validation
          • Tax table population
          • Tax code special cases
        • Unit of measure conversions
          • Configure the measurement conversion adjustments
          • Configure the percentage tolerance for measurements
          • Configure the unit of measure conversion table
          • Unit of measure triangulation
          • Configure the unit of measure aliases
        • GR-IV for non-SAP ERP databases
        • Line pairing for material invoices
        • Line pairing for service invoices
        • Line Pairing Correction activity
        • Line Pairing Correction decision
      • Custom scripts for invoice processing
        • Custom scripts in Transformation Designer
        • User Exits
          • ABNValidate
          • AbortSAPReadPO
          • AccountNumberValidate
          • AlternatePayeeValidate
          • AmountMiscPostEvaluate
          • CellTextFormatting
          • CheckBankAccount
          • CompanyCodeValidate
          • CreateSAPDocument
          • CSVFile
          • CSVFileLine
          • CustomExport
          • DBHeaderExport
          • DeliveryDateValidate
          • DocumentTypeValidate
          • DocumentValidate
          • DueDateValidate
          • EditDocumentWebLink
          • EmployeeIDValidate
          • ExportFailure
          • ExportSuccess
          • FilterEmployeeSearch
          • FilterVendorSearch
          • InvoiceDateValidate
          • InvoiceNumberValidate
          • LinePairingPOs
          • MexicanUUIDValidate
          • OCRXMLOutput
          • PONumberPostEvaluate
          • PONumberValidate
          • PopulateSAPAccountAssignment
          • PostClassify
          • PostExtract
          • PostLinePairing
          • POValidateStart
          • POVendorValidate
          • PreLinePairing
          • PreMaterialLinePairing
          • ReadPurchaseOrder
          • ReadSAPAccountAssignment
          • ReadVendorAddress
          • RejectPOForLinePairing
          • SAPArchiving
          • SAPConditions
          • SAPPostingFailure
          • SAPPostingRetry
          • SendToSAPProcessDirector
          • SendToSAPProcessDirectorGeneric
          • SetDocFlags
          • SetEntrySheetNumber
          • SetReferenceForEntrySheet
          • SetSAPPassword
          • SetTolerance
          • SetVendorCountry
          • TextFieldFormatting
          • ValueCheck
          • VoidDocumentExport
          • XMLOutput
        • Project data structures
          • AccountingData structure
          • Address structure
          • ClientData structure
          • CountryData structure
          • FieldSettings structure
          • LineData structure
          • POKey structure
          • TaxData structure
          • Tolerance structure
          • WithholdingTax data structure
        • API overview
          • Project context
          • API logs
          • Configuration access
          • Database access
          • SAP access
        • API troubleshooting
      • Project and field configurations
        • Activate and deactivate fields
          • Activate a field
          • Deactivate a field
        • Apply a country filter to a field
        • Alternative Payees
          • Activate the Alternate Payee field
          • Alternate Payee functionality
            • Configure Alternate Payee validation
            • Assign Permitted Payees to vendors
          • Automatic tax determination and validation
        • Configure the Custom Fields
          • Configure capture profiles and organizations for Custom Fields
          • Configure CEO extraction profile
          • Configure WEEE registration extraction profile
        • Configure the Invoice Type field
          • Invoice Type based on Purchase Order Number
          • Invoice Type without Purchase Order
          • Invoice Type from filename
        • Configure the Vendor ID field
          • Configure a Vendor and Site ID field
        • Configure the VAT number compliance check
          • Activate VAT compliance
          • Configure VAT extraction
          • Configure VAT compliance validation
          • Configure the VAT rate check
          • Configure cross-border EU VAT registration number checks
        • Document Variants
        • Intercompany vendors
          • Configure Intercompany classification
        • Purchase order number validations
          • Standard purchase order numbers
          • Configure purchase order number validations
          • Validate purchase order vendor against a document
          • Configure invoice currency to match purchase order
          • Configure padding for extracted PO numbers
          • Configure alternate PO number validation
          • Configure PO line item validation
            • Additional LPR table mappings
          • Configure database validations using stored procedures
          • Assign parameters to a purchase order header stored procedure
          • Purchase order stored procedures in Oracle
          • ReadPurchaseOrder user exit
          • Purchase order partitions
            • Register the PO data partition
            • Assign PO data partition ID to organization
            • Activate the PO data partition
            • Map partition ID column for purchase order line item data
          • JD Edwards purchase order numbers
            • Activate PO number validation for JD Edwards
            • Configure JD Edwards PO number format
          • PeopleSoft purchase order numbers
            • Activate PO validation for PeopleSoft
            • Configure PeopleSoft PO number format
          • Add leading zeros to PO numbers for JD Edwards and PeopleSoft
        • Straight through processing
        • Configure SAP
          • Configure a connection to SAP
          • SAP integration
          • BAPI calls
            • Configure BAPI calls using a direct login
          • Set up a SAP user ID
          • Troubleshoot SAP connection issues
        • Invoice Portal integration
          • Configure Invoice Portal Emails
          • Configure Kofax TotalAgility to poll for Invoice Portal emails
          • Configure XML handling to use Invoice Portal
      • Document export
        • Export configuration
        • Export to SAP
          • Activate the creation of SAP documents
          • Configure the creation of MM-LIV documents
          • Configure the creation of FI documents
          • Integrate with SAP workflows
          • Configure line pairing with SAP
          • Configure line pairing for material invoices with SAP
          • Configure unit of measure conversions
          • Configure line pairing for service invoices
          • Configure early archiving with SAP
          • Late archiving with SAP
            • Configure archiving to an external DMS using SAP
          • Configure SAP ArchiveLink
        • Export to Process Director
          • Configure output to Process Director
          • Process Director generic function
          • Invoice data passed to Process Director
          • Process Director and document archiving
            • Early archiving with Process Director (standard function)
            • Early archiving with Process Director (generic function)
            • Late archiving with Process Director
          • Process Director returned values
          • Process Director standard User Exit
          • Process Director generic function User Exit
        • Export to MarkView
        • Export to CSV
          • Add a CSV export file
          • Copy a CSV export file
          • Late archiving with Mobius
        • Export User Exits
        • Document Management system integration
        • Possible export failures
        • Export error handling
    • Manage AP Agility workflow
      • Manage email notifications and approvals
        • Configure Job Schedules for email notifications
        • Configure email approvals for an organization
          • Configure approval email body and subject
        • Workflow notifications
        • Configure Email Notifications
        • Send Email From address
      • Manage GL account segment structures
        • Add GL account structure
        • GL code history
          • GL code history retention
          • GL code history clean up
        • Delete GL account structure
        • Add segments to existing GL account structure
        • Modify segments in an existing GL account structure
        • Remove segments from an existing GL account structure
      • Duplicate invoice processing
      • AP Agility workflow validation process
      • Due date calculation
      • Discount due date calculation
      • Customizable workflow processes
        • Edit Workflow variables
        • Customize case reference for the Kofax AP Agility workflow
    • Configuration change audit
    • Export to Enterprise Content Management systems
      • Enable ECM export
      • Implement export to ECM
      • Configure the sample export process
        • Create CMIS document type
        • Create target export folder
        • Integration with CMIS repository
        • Configure temporary file folder
        • Configure the export process
    • Common logging
      • Configure the ErpConnectorService
      • Database logging for Azure
      • Clearing the log in the database
      • File logging for other installations
      • Log level settings

Your search for returned results.

Search tips

The search returns topics that contain terms you enter. If you type more than one term, an OR is assumed, which returns topics where any of the terms are found.

The search also uses fuzzy matching to account for partial words (such as install and installs). The results appear in order of relevance, based on how many search terms occur per topic. Exact matches are highlighted.

To refine the search, you can use the following operators:

  • Type + in front of words that must be included in the search or - in front of words to exclude. (Example: user +shortcut –group finds shortcut and user shortcut, but not group or user group.)
  • Use * as a wildcard for missing characters. The wildcard can be used anywhere in a search term. (Example: inst* finds installation and instructions.)
  • Type title: at the beginning of the search phrase to look only for topic titles. (Example: title:configuration finds the topic titled “Changing the software configuration.”)
  • For multi-term searches, you can specify a priority for terms in your search. Follow the term with ^ and a positive number that indicates the weight given that term. A higher number indicates more weight. (Example: shortcut^10 group gives shortcut 10 times the weight as group.)
  • To use fuzzy searching to account for misspellings, follow the term with ~ and a positive number for the number of corrections to be made. (Example: port~1 matches fort, post, or potr, and other instances where one correction leads to a match.)

Note that operators cannot be used as search terms: + - * : ~ ^ ' "

Welcome > Configure Kofax AP Agility > Manage Invoice processing > Custom scripts for invoice processing > API overview

API overview

The following sections provide suggestions on how to address several typical tasks using the Kofax AP Agility application programming interface (API).

  • Project context

  • API logs

  • Configuration access

  • Database access

  • SAP access