Interface ExecutionStrategy

Execution strategies are customer-configurable plans on how to process a specific case.

interface ExecutionStrategy {
    XLSXFileUploads?: {
        active?: boolean;
        remarks?: string;
        sheetName?: string;
        strategy?: "asLineItemList" | "asPDF";
    };
    alias?: string;
    automated?: boolean;
    customerId?: string;
    customs?: {
        GRN?: string;
        GRNAccessCode?: string;
        LRN?: string;
        declarantRepresentative?: StakeholderModel;
    };
    dakosySubmission?: {
        active?: boolean;
    };
    dataExtraction?: {
        active?: boolean;
        annotationRemarks?: string;
        classification?: {
            automateMinConfidence?: number;
            automateOnMinConfidence?: boolean;
        };
        classifyUsingDexter?: boolean;
        engine?: "default" | "dexter_experimental" | "llm";
        engineSpecification?: string;
        exportOnConfirmedStrategy?: boolean;
        llmOptions?: {
            classificationRemarks?: string;
            extractionRemarks?: {
                documentType?: DigicustDocumentType;
                engine?: string;
                ignore?: boolean;
                ignoreLineItems?: boolean;
                modelId?: string;
                remarks?: string;
                sendToFallbackEngine?: boolean;
            }[];
            onlyConsiderFirstAndLastPage?: boolean;
        };
        overrideQueues?: {
            documentType: string;
            queue: number;
        }[];
        promptRemarks?: string;
        queueMapping?: {
            documentType: DigicustDocumentType;
            queueId: string;
        }[];
        requireHumanAnnotation?: boolean;
        requireManualClassification?: boolean;
    };
    dataIntegration?: {
        active?: boolean;
        createNewCaseForEveryWaybillNumber?: {
            active?: boolean;
        };
        createNewCustomsCaseForEveryXItems?: {
            active?: boolean;
            aggregated?: boolean;
            threshold?: number;
        };
        createNewCustomsCaseForInvoice?: {
            active?: boolean;
        };
        createNewCustomsCasesAsDetectedInExcel?: {
            active?: boolean;
        };
        createNewCustomsCasesAsMentionedInEmail?: {
            active?: boolean;
        };
        createNewCustomsCasesPerRecipient?: {
            active?: boolean;
        };
        createNewCustomsCasesPerWaybillContainer?: {
            active?: boolean;
        };
        masterDataIntegrationAutomation?: {
            autoSetPropertiesToUserEdited?: boolean;
            createMaterialMasterData?: boolean;
            createStakeholderMasterData?: boolean;
            createTariffNumberMasterData?: boolean;
            materialIntegrationOptions?: {
                additionalProperties?: {
                    propagateTags?: boolean;
                    updateCASNumbers?: boolean;
                    updateGrossWeight?: boolean;
                    updateNetWeight?: boolean;
                    updateUnitOfMeasurement?: boolean;
                };
                documentCodeIntegration?: {
                    persistNegativeCodings?: boolean;
                };
                historyManagement?: {
                    enabledHistories?: {
                        countryOfOrigin?: boolean;
                        prices?: boolean;
                    };
                    maxHistoryEntries?: number;
                    trackRecipients?: boolean;
                };
                persistCustomsTariffNumbersForMaterialBasedMasterData?: boolean;
                persistItemDescriptions?: boolean;
            };
            tariffNumberMatchingOptions?: {
                useCountryOfOrigin?: boolean;
                useDeclarant?: boolean;
                useDestinationCountry?: boolean;
                useRecipientOrImporter?: boolean;
                useShipper?: boolean;
            };
            updateAutomaticallyCreatedMaterials?: boolean;
            updateAutomaticallyCreatedStakeholders?: boolean;
            updateAutomaticallyCreatedTariffNumbers?: boolean;
            updateManuallyCreatedMaterials?: boolean;
            updateManuallyCreatedStakeholders?: boolean;
            updateManuallyCreatedTariffNumbers?: boolean;
        };
        requireUserInput?: "false" | "true" | "masterDataOrUserInput";
    };
    dataNormalization?: {
        active?: boolean;
        addAllInvoicesIfNoItemSpecificInvoiceIsFound?: boolean;
        additionalCostsStrategy?: "ignore" | "equalDistribution" | "addToFirstItem" | "splitToAllItems" | "splitToAllItemsByNetWeight" | "splitToAllItemsByTotalValue";
        aggregateGrossWeightFromInvoicesWithPackageInformationOnly?: boolean;
        aggregatePalletsAndOtherPackages?: boolean;
        allowDateInOrderNumber?: boolean;
        alwaysAssumeThousandsForQuantity?: boolean;
        alwaysAssumeThousandsForWeights?: boolean;
        alwaysAssumeThreeDigitDecimalForWeights?: boolean;
        assumeOriginFromDepartureCountry?: boolean;
        assumeOriginFromHead?: boolean;
        autoDeductFreightCostsFromStatisticalValue?: boolean;
        calculateLineItemWeight?: "byQuantity" | "byTotalValue";
        calculatePackagesFromWeightInformationInDescription?: boolean;
        calculateWeight?: {
            grossWeightFromNetWeight?: number | false;
            netWeightFromGrossWeight?: number | false;
        };
        checkTradePreferenceForWording?: boolean;
        customsTariffNumberMappingJsonAta?: string;
        customsTariffNumberNormalizationSettings?: CustomsTariffNumberNormalizationSettings;
        defaultInvoiceType?: "tax_invoice" | "proforma";
        defaultLicensePlate?: false | "german";
        descriptionFormatString?: string;
        descriptionFormatStringGPT?: string;
        descriptionFormatStringJsonAta?: string;
        disableAutomaticMaterialCreation?: boolean;
        disableAutomaticStakeholderCreation?: boolean;
        disableInvoiceReferenceAggregation?: boolean;
        doNotAssumeOriginFromPreference?: boolean;
        documentCodeEnrichment?: {
            add3LNAQualifiers?: boolean;
            addNegativeCodings?: boolean;
            blacklistCodes?: string[];
            noLineItemDocumentCodes?: boolean;
        };
        eliminateArticleNumberFromDescription?: boolean;
        emailSenderAsRepresentativeEmail?: boolean;
        enforcePackageType?: PackageType;
        forceInvoiceNumberToLRN?: boolean;
        forceInvoiceNumberToReferenceNumberUCR?: boolean;
        forceInvoiceNumberToRegistrationNumberExternal?: boolean;
        forcePackagesToFirstLineItem?: boolean;
        forceTotalValueToFirstLineItem?: boolean;
        forceTotalValueToStatisticalValue?: boolean;
        foreignFreightCostRate?: number;
        freightCostCalculation?: {
            active?: boolean;
            maximumFreightCost?: Money;
            minimumFreightCost?: Money;
            packagePrice?: Money;
            priority?: "fallback" | "override";
            relativeFreightCostMultiplier?: number;
            strategy?: "default" | "austriaWeightDependent" | "packageDependent" | "distanceDependent" | "relative" | "containerSizeDependent";
        };
        guaranteeValueCalculation?: "includeVAT19%" | "excludeVAT";
        guaranteeValueCalculationStrategy?: "default" | "assume25%" | "assume26%";
        guaranteeValueStrategy?: "headerFromInvoices" | "headerFromInvoiceHeader" | "lineItems" | "fromGlobalHead";
        ignoreLineItemsFromInvoice?: boolean;
        ignoreLineItemsFromTransitDeclaration?: boolean;
        ignoreLineItemsWithNoValue?: boolean;
        ignoreLineItemsWithoutInvoice?: boolean;
        ignoreTotalValueFromProformaInvoices?: boolean;
        keepPackageItemsWithCustomsTariffNumber?: boolean;
        lineItemGrossWeightStrategy?: "default" | "forceToFirstLineItem";
        lineItemMergeSettings?: LineItemMergeSettings;
        maxGuaranteeValue?: Money;
        normalizeEmailDocuments?: boolean;
        normalizeEmailDocumentsOptions?: {
            prioritizeCustomsTariffNumberFromEmail?: boolean;
            prioritizeGoodsDescriptionFromEmail?: boolean;
            remarks?: string;
        };
        omitLineItemDescription?: boolean;
        preferConsigneeFromEmail?: boolean;
        preferPackagesFromHead?: boolean;
        preferWeightFromHead?: boolean;
        removeStakeholderContactInformation?: {
            active?: boolean;
        };
        searchForItemDescriptionOnInternet?: {
            active?: boolean;
        };
        specializedDescriptionAggregationJsonAta?: string;
        statisticalValueAdditionDeductionOnlyToFirstLineItem?: boolean;
        statisticalValueRounding?: "noRounding" | "roundOff" | "roundUp" | "roundToNearest";
        translateLineItemDescriptions?: {
            active?: boolean;
            destinationLanguage?: string;
        };
        useQuantityAsPackageCount?: boolean;
        useSpecializedDescriptionAggregation?: boolean;
        waybillCodePreference?: "singleCode" | "seperateCodes" | "dependentOnPreferences";
    };
    dataValidation?: {
        active?: boolean;
        fraudDetection?: boolean;
    };
    defaultClassification?: DigicustDocumentType;
    defaultProcedureMode?: ProcedureMode;
    doNotSendProcessedNotification?: boolean;
    doNotSendUploadNotification?: boolean;
    events?: Event[];
    flags?: {
        [key: string]: string;
    };
    forceReference?: false | "invoiceNumber";
    forceReferenceJSONata?: string;
    handleXLSXFileUploads?: boolean;
    hsClassification?: {
        active?: boolean;
        research?: boolean;
    };
    id?: string;
    importViaSFTP?: {
        active?: boolean;
        sftp-dns-name?: string;
        sftp-inbound?: string;
        sftp-login-name?: string;
        sftp-outbound?: string;
        sftp-password?: string;
        sftp-port?: string;
    };
    isCondensed?: boolean;
    isProcessWithDextor?: boolean;
    masterDataUse?: {
        useCountryOfOriginFromMasterData?: boolean;
    };
    matchingEngine?: {
        materialMatching?: {
            disableMaterialNumberMatching?: boolean;
            disableTariffNumberMatching?: boolean;
            disabled?: boolean;
            materialEnrichmentMergeConfig?: MaterialEnrichmentMergeConfig;
            sendMasterDataDescriptionOnly?: boolean;
            sendMasterDataTariffNumberOnly?: boolean;
            tariffNumberMatchingConfiguration?: {
                matchShipperCountry?: boolean;
                stakeholderFilters?: ("shipper" | "carrier" | "declarant" | "consignee" | "recipient" | "beneficiary" | "applicant" | "importer" | "exporter" | "buyer" | "agent" | "broker" | "warehouse" | "obligater")[];
            };
        };
    };
    mergeMultipleUploads?: boolean;
    moduleId?: string;
    procedureCode?: string;
    projectId?: string;
    pseudonymization?: {
        active?: boolean;
        interval?: number;
        time?: number;
    };
    referenceInEmail?: boolean;
    ruleSettings?: {
        sortLineItemsBeforeAnnotating?: "position" | "customsTariffNumber";
    };
    ruleSystem?: "default" | "chained";
    rules?: Rule[];
    submission?: Submission;
    subscriptionId?: string;
    uploadWidgets?: UploadWidget[];
    userInputTemplates?: UserInputTemplate[];
    whitelistedImportEmails?: string[];
}

Properties

XLSXFileUploads? alias? automated? customerId? customs? dakosySubmission? dataExtraction? dataIntegration? dataNormalization? dataValidation? defaultClassification? defaultProcedureMode? doNotSendProcessedNotification? doNotSendUploadNotification? events? flags? forceReference? forceReferenceJSONata? handleXLSXFileUploads? hsClassification? id? importViaSFTP? isCondensed? isProcessWithDextor? masterDataUse? matchingEngine? mergeMultipleUploads? moduleId? procedureCode? projectId? pseudonymization? referenceInEmail? ruleSettings? ruleSystem? rules? submission? subscriptionId? uploadWidgets? userInputTemplates? whitelistedImportEmails?

Properties

Optional XLSXFileUploads

XLSXFileUploads?: {
    active?: boolean;
    remarks?: string;
    sheetName?: string;
    strategy?: "asLineItemList" | "asPDF";
}

Type declaration

  • Optional active?: boolean
  • Optional remarks?: string
  • Optional sheetName?: string
  • Optional strategy?: "asLineItemList" | "asPDF"

Optional alias

alias?: string

Optional automated

automated?: boolean

Optional customerId

customerId?: string

Optional customs

customs?: {
    GRN?: string;
    GRNAccessCode?: string;
    LRN?: string;
    declarantRepresentative?: StakeholderModel;
}

Type declaration

  • Optional GRN?: string
  • Optional GRNAccessCode?: string
  • Optional LRN?: string
  • Optional declarantRepresentative?: StakeholderModel

Optional dakosySubmission

dakosySubmission?: {
    active?: boolean;
}

Type declaration

  • Optional active?: boolean

Deprecated

Optional dataExtraction

dataExtraction?: {
    active?: boolean;
    annotationRemarks?: string;
    classification?: {
        automateMinConfidence?: number;
        automateOnMinConfidence?: boolean;
    };
    classifyUsingDexter?: boolean;
    engine?: "default" | "dexter_experimental" | "llm";
    engineSpecification?: string;
    exportOnConfirmedStrategy?: boolean;
    llmOptions?: {
        classificationRemarks?: string;
        extractionRemarks?: {
            documentType?: DigicustDocumentType;
            engine?: string;
            ignore?: boolean;
            ignoreLineItems?: boolean;
            modelId?: string;
            remarks?: string;
            sendToFallbackEngine?: boolean;
        }[];
        onlyConsiderFirstAndLastPage?: boolean;
    };
    overrideQueues?: {
        documentType: string;
        queue: number;
    }[];
    promptRemarks?: string;
    queueMapping?: {
        documentType: DigicustDocumentType;
        queueId: string;
    }[];
    requireHumanAnnotation?: boolean;
    requireManualClassification?: boolean;
}

Type declaration

  • Optional active?: boolean
  • Optional annotationRemarks?: string
  • Optional classification?: {
        automateMinConfidence?: number;
        automateOnMinConfidence?: boolean;
    }
    • Optional automateMinConfidence?: number

      Value between 1 (very confident) to 0 (no confidence)

    • Optional automateOnMinConfidence?: boolean

      Defines whether a classification shall be assumed correct if a specific confidence level is reached

  • Optional classifyUsingDexter?: boolean

    Whether to classify using dexter classification or let user manually classify

  • Optional engine?: "default" | "dexter_experimental" | "llm"
  • Optional engineSpecification?: string
  • Optional exportOnConfirmedStrategy?: boolean
  • Optional llmOptions?: {
        classificationRemarks?: string;
        extractionRemarks?: {
            documentType?: DigicustDocumentType;
            engine?: string;
            ignore?: boolean;
            ignoreLineItems?: boolean;
            modelId?: string;
            remarks?: string;
            sendToFallbackEngine?: boolean;
        }[];
        onlyConsiderFirstAndLastPage?: boolean;
    }
    • Optional classificationRemarks?: string
    • Optional extractionRemarks?: {
          documentType?: DigicustDocumentType;
          engine?: string;
          ignore?: boolean;
          ignoreLineItems?: boolean;
          modelId?: string;
          remarks?: string;
          sendToFallbackEngine?: boolean;
      }[]
    • Optional onlyConsiderFirstAndLastPage?: boolean
  • Optional overrideQueues?: {
        documentType: string;
        queue: number;
    }[]

    for rossum

  • Optional promptRemarks?: string
  • Optional queueMapping?: {
        documentType: DigicustDocumentType;
        queueId: string;
    }[]
  • Optional requireHumanAnnotation?: boolean
  • Optional requireManualClassification?: boolean

Optional dataIntegration

dataIntegration?: {
    active?: boolean;
    createNewCaseForEveryWaybillNumber?: {
        active?: boolean;
    };
    createNewCustomsCaseForEveryXItems?: {
        active?: boolean;
        aggregated?: boolean;
        threshold?: number;
    };
    createNewCustomsCaseForInvoice?: {
        active?: boolean;
    };
    createNewCustomsCasesAsDetectedInExcel?: {
        active?: boolean;
    };
    createNewCustomsCasesAsMentionedInEmail?: {
        active?: boolean;
    };
    createNewCustomsCasesPerRecipient?: {
        active?: boolean;
    };
    createNewCustomsCasesPerWaybillContainer?: {
        active?: boolean;
    };
    masterDataIntegrationAutomation?: {
        autoSetPropertiesToUserEdited?: boolean;
        createMaterialMasterData?: boolean;
        createStakeholderMasterData?: boolean;
        createTariffNumberMasterData?: boolean;
        materialIntegrationOptions?: {
            additionalProperties?: {
                propagateTags?: boolean;
                updateCASNumbers?: boolean;
                updateGrossWeight?: boolean;
                updateNetWeight?: boolean;
                updateUnitOfMeasurement?: boolean;
            };
            documentCodeIntegration?: {
                persistNegativeCodings?: boolean;
            };
            historyManagement?: {
                enabledHistories?: {
                    countryOfOrigin?: boolean;
                    prices?: boolean;
                };
                maxHistoryEntries?: number;
                trackRecipients?: boolean;
            };
            persistCustomsTariffNumbersForMaterialBasedMasterData?: boolean;
            persistItemDescriptions?: boolean;
        };
        tariffNumberMatchingOptions?: {
            useCountryOfOrigin?: boolean;
            useDeclarant?: boolean;
            useDestinationCountry?: boolean;
            useRecipientOrImporter?: boolean;
            useShipper?: boolean;
        };
        updateAutomaticallyCreatedMaterials?: boolean;
        updateAutomaticallyCreatedStakeholders?: boolean;
        updateAutomaticallyCreatedTariffNumbers?: boolean;
        updateManuallyCreatedMaterials?: boolean;
        updateManuallyCreatedStakeholders?: boolean;
        updateManuallyCreatedTariffNumbers?: boolean;
    };
    requireUserInput?: "false" | "true" | "masterDataOrUserInput";
}

Type declaration

  • Optional active?: boolean
  • Optional createNewCaseForEveryWaybillNumber?: {
        active?: boolean;
    }
    • Optional active?: boolean
  • Optional createNewCustomsCaseForEveryXItems?: {
        active?: boolean;
        aggregated?: boolean;
        threshold?: number;
    }
    • Optional active?: boolean
    • Optional aggregated?: boolean
    • Optional threshold?: number
  • Optional createNewCustomsCaseForInvoice?: {
        active?: boolean;
    }
    • Optional active?: boolean
  • Optional createNewCustomsCasesAsDetectedInExcel?: {
        active?: boolean;
    }
    • Optional active?: boolean
  • Optional createNewCustomsCasesAsMentionedInEmail?: {
        active?: boolean;
    }
    • Optional active?: boolean
  • Optional createNewCustomsCasesPerRecipient?: {
        active?: boolean;
    }
    • Optional active?: boolean
  • Optional createNewCustomsCasesPerWaybillContainer?: {
        active?: boolean;
    }
    • Optional active?: boolean
  • Optional masterDataIntegrationAutomation?: {
        autoSetPropertiesToUserEdited?: boolean;
        createMaterialMasterData?: boolean;
        createStakeholderMasterData?: boolean;
        createTariffNumberMasterData?: boolean;
        materialIntegrationOptions?: {
            additionalProperties?: {
                propagateTags?: boolean;
                updateCASNumbers?: boolean;
                updateGrossWeight?: boolean;
                updateNetWeight?: boolean;
                updateUnitOfMeasurement?: boolean;
            };
            documentCodeIntegration?: {
                persistNegativeCodings?: boolean;
            };
            historyManagement?: {
                enabledHistories?: {
                    countryOfOrigin?: boolean;
                    prices?: boolean;
                };
                maxHistoryEntries?: number;
                trackRecipients?: boolean;
            };
            persistCustomsTariffNumbersForMaterialBasedMasterData?: boolean;
            persistItemDescriptions?: boolean;
        };
        tariffNumberMatchingOptions?: {
            useCountryOfOrigin?: boolean;
            useDeclarant?: boolean;
            useDestinationCountry?: boolean;
            useRecipientOrImporter?: boolean;
            useShipper?: boolean;
        };
        updateAutomaticallyCreatedMaterials?: boolean;
        updateAutomaticallyCreatedStakeholders?: boolean;
        updateAutomaticallyCreatedTariffNumbers?: boolean;
        updateManuallyCreatedMaterials?: boolean;
        updateManuallyCreatedStakeholders?: boolean;
        updateManuallyCreatedTariffNumbers?: boolean;
    }

    Controls master data integration automation settings

    • Optional autoSetPropertiesToUserEdited?: boolean

      Immediately confirm master data entries that were created automatically (in technical terms: mark them as user-edited)

    • Optional createMaterialMasterData?: boolean

      Enable creation of material master data that does not exist yet

    • Optional createStakeholderMasterData?: boolean

      Enable creation of stakeholder master data that does not exist yet

    • Optional createTariffNumberMasterData?: boolean

      Enable creation of tariff number master data that does not exist yet

    • Optional materialIntegrationOptions?: {
          additionalProperties?: {
              propagateTags?: boolean;
              updateCASNumbers?: boolean;
              updateGrossWeight?: boolean;
              updateNetWeight?: boolean;
              updateUnitOfMeasurement?: boolean;
          };
          documentCodeIntegration?: {
              persistNegativeCodings?: boolean;
          };
          historyManagement?: {
              enabledHistories?: {
                  countryOfOrigin?: boolean;
                  prices?: boolean;
              };
              maxHistoryEntries?: number;
              trackRecipients?: boolean;
          };
          persistCustomsTariffNumbersForMaterialBasedMasterData?: boolean;
          persistItemDescriptions?: boolean;
      }

      General integration options for both material and tariffNumber based master data

      • Optional additionalProperties?: {
            propagateTags?: boolean;
            updateCASNumbers?: boolean;
            updateGrossWeight?: boolean;
            updateNetWeight?: boolean;
            updateUnitOfMeasurement?: boolean;
        }

        Controls how additional material properties are handled

        • Optional propagateTags?: boolean

          If true, material tags from items will be added to existing tags If false, tags will not be propagated Default: false

        • Optional updateCASNumbers?: boolean

          If true, CAS numbers from items will update material CAS numbers Default: true

        • Optional updateGrossWeight?: boolean

          If true, gross weights from items will update material gross weight Default: true

        • Optional updateNetWeight?: boolean

          If true, net weights from items will update material net weight Default: true

        • Optional updateUnitOfMeasurement?: boolean

          If true, units of measurement from items will update material UoM Default: true

      • Optional documentCodeIntegration?: {
            persistNegativeCodings?: boolean;
        }

        Controls document code integration from different sources.

        • Optional persistNegativeCodings?: boolean
      • Optional historyManagement?: {
            enabledHistories?: {
                countryOfOrigin?: boolean;
                prices?: boolean;
            };
            maxHistoryEntries?: number;
            trackRecipients?: boolean;
        }

        Controls how history data is configured and managed

        • Optional enabledHistories?: {
              countryOfOrigin?: boolean;
              prices?: boolean;
          }

          Controls which historical data should be tracked

          • Optional countryOfOrigin?: boolean

            Track country of origin changes over time

          • Optional prices?: boolean

            Track price changes over time with associated quantity info

        • Optional maxHistoryEntries?: number

          Maximum number of entries to keep in each history. Default: 10

        • Optional trackRecipients?: boolean

          If true, recipients will be tracked in the history with NO limit(!). Needs to be true for useRecipientOrImporter to work for matching

      • Optional persistCustomsTariffNumbersForMaterialBasedMasterData?: boolean

        This is always persisted for tariff number based master data, but needs to be explicitly enabled for material based master data

      • Optional persistItemDescriptions?: boolean

        If any descriptions were found in the shipment item, they will be persisted in the master data If update mode is active, the descriptions will be replaced on each update (except if the new description is empty)

    • Optional tariffNumberMatchingOptions?: {
          useCountryOfOrigin?: boolean;
          useDeclarant?: boolean;
          useDestinationCountry?: boolean;
          useRecipientOrImporter?: boolean;
          useShipper?: boolean;
      }

      Matching options for tariff number master data, effectively which properties from the shipment will be used to match the tariff number These properties from the shipment (and item) will also be automatically persisted in the master data, each combination of these properties will be a separate master data entry

      • Optional useCountryOfOrigin?: boolean
      • Optional useDeclarant?: boolean
      • Optional useDestinationCountry?: boolean
      • Optional useRecipientOrImporter?: boolean
      • Optional useShipper?: boolean
    • Optional updateAutomaticallyCreatedMaterials?: boolean

      Enable updates of fields in automatically created materials

    • Optional updateAutomaticallyCreatedStakeholders?: boolean

      Enable updates of fields in automatically created stakeholders

    • Optional updateAutomaticallyCreatedTariffNumbers?: boolean

      Enable updates of fields in automatically created tariff numbers

    • Optional updateManuallyCreatedMaterials?: boolean

      Enable updates of fields in manually created materials

    • Optional updateManuallyCreatedStakeholders?: boolean

      Enable updates of fields in manually created stakeholders

    • Optional updateManuallyCreatedTariffNumbers?: boolean

      Enable updates of fields in manually created tariff numbers

  • Optional requireUserInput?: "false" | "true" | "masterDataOrUserInput"

Optional dataNormalization

dataNormalization?: {
    active?: boolean;
    addAllInvoicesIfNoItemSpecificInvoiceIsFound?: boolean;
    additionalCostsStrategy?: "ignore" | "equalDistribution" | "addToFirstItem" | "splitToAllItems" | "splitToAllItemsByNetWeight" | "splitToAllItemsByTotalValue";
    aggregateGrossWeightFromInvoicesWithPackageInformationOnly?: boolean;
    aggregatePalletsAndOtherPackages?: boolean;
    allowDateInOrderNumber?: boolean;
    alwaysAssumeThousandsForQuantity?: boolean;
    alwaysAssumeThousandsForWeights?: boolean;
    alwaysAssumeThreeDigitDecimalForWeights?: boolean;
    assumeOriginFromDepartureCountry?: boolean;
    assumeOriginFromHead?: boolean;
    autoDeductFreightCostsFromStatisticalValue?: boolean;
    calculateLineItemWeight?: "byQuantity" | "byTotalValue";
    calculatePackagesFromWeightInformationInDescription?: boolean;
    calculateWeight?: {
        grossWeightFromNetWeight?: number | false;
        netWeightFromGrossWeight?: number | false;
    };
    checkTradePreferenceForWording?: boolean;
    customsTariffNumberMappingJsonAta?: string;
    customsTariffNumberNormalizationSettings?: CustomsTariffNumberNormalizationSettings;
    defaultInvoiceType?: "tax_invoice" | "proforma";
    defaultLicensePlate?: false | "german";
    descriptionFormatString?: string;
    descriptionFormatStringGPT?: string;
    descriptionFormatStringJsonAta?: string;
    disableAutomaticMaterialCreation?: boolean;
    disableAutomaticStakeholderCreation?: boolean;
    disableInvoiceReferenceAggregation?: boolean;
    doNotAssumeOriginFromPreference?: boolean;
    documentCodeEnrichment?: {
        add3LNAQualifiers?: boolean;
        addNegativeCodings?: boolean;
        blacklistCodes?: string[];
        noLineItemDocumentCodes?: boolean;
    };
    eliminateArticleNumberFromDescription?: boolean;
    emailSenderAsRepresentativeEmail?: boolean;
    enforcePackageType?: PackageType;
    forceInvoiceNumberToLRN?: boolean;
    forceInvoiceNumberToReferenceNumberUCR?: boolean;
    forceInvoiceNumberToRegistrationNumberExternal?: boolean;
    forcePackagesToFirstLineItem?: boolean;
    forceTotalValueToFirstLineItem?: boolean;
    forceTotalValueToStatisticalValue?: boolean;
    foreignFreightCostRate?: number;
    freightCostCalculation?: {
        active?: boolean;
        maximumFreightCost?: Money;
        minimumFreightCost?: Money;
        packagePrice?: Money;
        priority?: "fallback" | "override";
        relativeFreightCostMultiplier?: number;
        strategy?: "default" | "austriaWeightDependent" | "packageDependent" | "distanceDependent" | "relative" | "containerSizeDependent";
    };
    guaranteeValueCalculation?: "includeVAT19%" | "excludeVAT";
    guaranteeValueCalculationStrategy?: "default" | "assume25%" | "assume26%";
    guaranteeValueStrategy?: "headerFromInvoices" | "headerFromInvoiceHeader" | "lineItems" | "fromGlobalHead";
    ignoreLineItemsFromInvoice?: boolean;
    ignoreLineItemsFromTransitDeclaration?: boolean;
    ignoreLineItemsWithNoValue?: boolean;
    ignoreLineItemsWithoutInvoice?: boolean;
    ignoreTotalValueFromProformaInvoices?: boolean;
    keepPackageItemsWithCustomsTariffNumber?: boolean;
    lineItemGrossWeightStrategy?: "default" | "forceToFirstLineItem";
    lineItemMergeSettings?: LineItemMergeSettings;
    maxGuaranteeValue?: Money;
    normalizeEmailDocuments?: boolean;
    normalizeEmailDocumentsOptions?: {
        prioritizeCustomsTariffNumberFromEmail?: boolean;
        prioritizeGoodsDescriptionFromEmail?: boolean;
        remarks?: string;
    };
    omitLineItemDescription?: boolean;
    preferConsigneeFromEmail?: boolean;
    preferPackagesFromHead?: boolean;
    preferWeightFromHead?: boolean;
    removeStakeholderContactInformation?: {
        active?: boolean;
    };
    searchForItemDescriptionOnInternet?: {
        active?: boolean;
    };
    specializedDescriptionAggregationJsonAta?: string;
    statisticalValueAdditionDeductionOnlyToFirstLineItem?: boolean;
    statisticalValueRounding?: "noRounding" | "roundOff" | "roundUp" | "roundToNearest";
    translateLineItemDescriptions?: {
        active?: boolean;
        destinationLanguage?: string;
    };
    useQuantityAsPackageCount?: boolean;
    useSpecializedDescriptionAggregation?: boolean;
    waybillCodePreference?: "singleCode" | "seperateCodes" | "dependentOnPreferences";
}

Type declaration

  • Optional active?: boolean
  • Optional addAllInvoicesIfNoItemSpecificInvoiceIsFound?: boolean
  • Optional additionalCostsStrategy?: "ignore" | "equalDistribution" | "addToFirstItem" | "splitToAllItems" | "splitToAllItemsByNetWeight" | "splitToAllItemsByTotalValue"

    Determines how to deal with additional costs like shipping costs, packing, ...

  • Optional aggregateGrossWeightFromInvoicesWithPackageInformationOnly?: boolean
  • Optional aggregatePalletsAndOtherPackages?: boolean

    Determines whether or not to aggregate (sum up) pallets together with other package types

  • Optional allowDateInOrderNumber?: boolean
  • Optional alwaysAssumeThousandsForQuantity?: boolean
  • Optional alwaysAssumeThousandsForWeights?: boolean
  • Optional alwaysAssumeThreeDigitDecimalForWeights?: boolean
  • Optional assumeOriginFromDepartureCountry?: boolean
  • Optional assumeOriginFromHead?: boolean
  • Optional autoDeductFreightCostsFromStatisticalValue?: boolean

    If true, the freight costs will be deducted from the statistical value

  • Optional calculateLineItemWeight?: "byQuantity" | "byTotalValue"
  • Optional calculatePackagesFromWeightInformationInDescription?: boolean
  • Optional calculateWeight?: {
        grossWeightFromNetWeight?: number | false;
        netWeightFromGrossWeight?: number | false;
    }
    • Optional grossWeightFromNetWeight?: number | false
    • Optional netWeightFromGrossWeight?: number | false
  • Optional checkTradePreferenceForWording?: boolean

    Determines whether trade preference shall be invalidated if wording or spelling is wrong

  • Optional customsTariffNumberMappingJsonAta?: string

    Custom formatting for transforming the (autofixed) customs tariff number into a new tariff number. Default to empty (no mapping used).

    The input JSON object has the same structure as the descriptionFormatStringJsonAta:

    { "tariffNumber": "1234567890", "quantity": 1234, "tariffNumberDescription": "Einrichtungen, Maschinen, Apparate und Geräte zur Kälteerzeugung", "lineItemDescription": "Orsiro Mission 2.5/9 PTCA-Stents ", "lineItemDescriptionShort": "Orsiro Mission PTCA-Stents ", "materialDescription": "PCTA-Stents", "enrichedDescription": "PCTA-Stents", "enrichedDescriptionShort": "Stents", "preferMaterialMasterData": false, "materialMatched": true, "useCustomsTariffNumberDescription": true, "useLineItemDescriptionShortening": true, "materialMatchedByTariffNumber": true, "materialMatchedByMaterialNr": false }

  • Optional customsTariffNumberNormalizationSettings?: CustomsTariffNumberNormalizationSettings
  • Optional defaultInvoiceType?: "tax_invoice" | "proforma"
  • Optional defaultLicensePlate?: false | "german"
  • Optional descriptionFormatString?: string

    Custom formattings for the resulting description of line items. For more complex conditional formattings, use the JSONAta property instead.

    Possible variables are:

    • {line-item-description} - The normalized line-item-description from the document. Should always contain a value.
    • {line-item-description-short} - The GPT shortened line-item-description. Shortening is only applied if the line-item-description contains more than 4 words, otherwise it will be the original line-item-description
    • {material-description} - The material-description from the matched material masterdata (either by material-nr or tariff-nr). Empty if no material is matched, or matching is disabled.
    • {enriched-description} - Contains the material-description if it is not empty, or the line-item-description as a fallback value.
    • {enriched-description-short} - Contains the material-description if it is not empty, or the shortened-line-item-description as a fallback value.
    • {tariff-number-description} - The description of the matched tariff number. If no tariff number is matched or matching is disabled this will be empty.

    All these variables can be combined with an optional separator to include after the variable. This separator will only be printed if the variable is not empty. Format: {variable}[separator]

    Examples: {tariff-number-description}[ - ]{enriched-description} {tariff-number-description}[ - ]{enriched-description-short} {tariff-number-description}[ - ]{line-item-description} {material-description}[ - ]{line-item-description} {enriched-description-short}

  • Optional descriptionFormatStringGPT?: string

    Custom formattings for the resulting description of line items as a GPT prompt.

    { "tariffNumber": "1234567890", "quantity": 1234, "tariffNumberDescription": "Einrichtungen, Maschinen, Apparate und Geräte zur Kälteerzeugung", "lineItemDescription": "Orsiro Mission 2.5/9 PTCA-Stents ", "lineItemDescriptionShort": "Orsiro Mission PTCA-Stents ", "materialDescription": "PCTA-Stents", "enrichedDescription": "PCTA-Stents", "enrichedDescriptionShort": "Stents", "preferMaterialMasterData": false, "materialMatched": true, "useCustomsTariffNumberDescription": true, "useLineItemDescriptionShortening": true, "materialMatchedByTariffNumber": true, "materialMatchedByMaterialNr": false }

  • Optional descriptionFormatStringJsonAta?: string

    Custom formattings for the resulting description of line items as a JSONAta query. The result must be a string, not an object. The "simpler" descriptionFormatString will be ignored if this is set.

    The input JSON object looks like this:

    { "tariffNumber": "1234567890", "quantity": 1234, "tariffNumberDescription": "Einrichtungen, Maschinen, Apparate und Geräte zur Kälteerzeugung", "lineItemDescription": "Orsiro Mission 2.5/9 PTCA-Stents ", "lineItemDescriptionShort": "Orsiro Mission PTCA-Stents ", "materialDescription": "PCTA-Stents", "enrichedDescription": "PCTA-Stents", "enrichedDescriptionShort": "Stents", "preferMaterialMasterData": false, "materialMatched": true, "useCustomsTariffNumberDescription": true, "useLineItemDescriptionShortening": true, "materialMatchedByTariffNumber": true, "materialMatchedByMaterialNr": false }

    Examples:

    • Built-In Standard formatting depending on various state variables: useCustomsTariffNumberDescription and ( preferMaterialMasterData = false or materialMatched = false ) and $exists(tariffNumberDescription) and $string(tariffNumberDescription) != "" ? tariffNumberDescription & " - " & ( useLineItemDescriptionShortening = true and materialMatched = false ? (($exists(lineItemDescriptionShort) and $string(lineItemDescriptionShort) != "") ? lineItemDescriptionShort: lineItemDescription) : ( materialMatched = true ? materialDescription : ( useLineItemDescriptionShortening = true ? lineItemDescriptionShort : lineItemDescription ) ) ) : enrichedDescription

      Example Result with JSON input from above: "Einrichtungen, Maschinen, Apparate und Geräte zur Kälteerzeugung - PCTA-Stents"

    • Static formatting for customer preferring combined material and line-item descriptions: $exists(materialDescription) and $string(materialDescription) != "" ? materialDescription & ' - ' & lineItemDescription : lineItemDescription

      Example Result with JSON input from above: "PCTA-Stents - Orsiro Mission 2.5/9 PTCA-Stents"

  • Optional disableAutomaticMaterialCreation?: boolean

    Deprecated

  • Optional disableAutomaticStakeholderCreation?: boolean

    Deprecated

  • Optional disableInvoiceReferenceAggregation?: boolean

    Disables the aggregation of invoice documents with a single "reference", as is the default behavior.

  • Optional doNotAssumeOriginFromPreference?: boolean

    Default: Assume origin from preference. Set to true to mitigate this behavior

  • Optional documentCodeEnrichment?: {
        add3LNAQualifiers?: boolean;
        addNegativeCodings?: boolean;
        blacklistCodes?: string[];
        noLineItemDocumentCodes?: boolean;
    }
    • Optional add3LNAQualifiers?: boolean
    • Optional addNegativeCodings?: boolean
    • Optional blacklistCodes?: string[]
    • Optional noLineItemDocumentCodes?: boolean
  • Optional eliminateArticleNumberFromDescription?: boolean
  • Optional emailSenderAsRepresentativeEmail?: boolean
  • Optional enforcePackageType?: PackageType
  • Optional forceInvoiceNumberToLRN?: boolean
  • Optional forceInvoiceNumberToReferenceNumberUCR?: boolean
  • Optional forceInvoiceNumberToRegistrationNumberExternal?: boolean
  • Optional forcePackagesToFirstLineItem?: boolean
  • Optional forceTotalValueToFirstLineItem?: boolean
  • Optional forceTotalValueToStatisticalValue?: boolean
  • Optional foreignFreightCostRate?: number

    Between 0 and 1

  • Optional freightCostCalculation?: {
        active?: boolean;
        maximumFreightCost?: Money;
        minimumFreightCost?: Money;
        packagePrice?: Money;
        priority?: "fallback" | "override";
        relativeFreightCostMultiplier?: number;
        strategy?: "default" | "austriaWeightDependent" | "packageDependent" | "distanceDependent" | "relative" | "containerSizeDependent";
    }
    • Optional active?: boolean
    • Optional maximumFreightCost?: Money
    • Optional minimumFreightCost?: Money
    • Optional packagePrice?: Money

      if strategy = packageDependent

    • Optional priority?: "fallback" | "override"
    • Optional relativeFreightCostMultiplier?: number

      If strategy === relative then goods value is multiplied by this multiplier to receive freight costs

    • Optional strategy?: "default" | "austriaWeightDependent" | "packageDependent" | "distanceDependent" | "relative" | "containerSizeDependent"
  • Optional guaranteeValueCalculation?: "includeVAT19%" | "excludeVAT"
  • Optional guaranteeValueCalculationStrategy?: "default" | "assume25%" | "assume26%"
  • Optional guaranteeValueStrategy?: "headerFromInvoices" | "headerFromInvoiceHeader" | "lineItems" | "fromGlobalHead"
  • Optional ignoreLineItemsFromInvoice?: boolean
  • Optional ignoreLineItemsFromTransitDeclaration?: boolean
  • Optional ignoreLineItemsWithNoValue?: boolean
  • Optional ignoreLineItemsWithoutInvoice?: boolean
  • Optional ignoreTotalValueFromProformaInvoices?: boolean
  • Optional keepPackageItemsWithCustomsTariffNumber?: boolean
  • Optional lineItemGrossWeightStrategy?: "default" | "forceToFirstLineItem"
  • Optional lineItemMergeSettings?: LineItemMergeSettings

    Optional – if absent the merger operates in legacy mode. Safe to add to existing JSON without breaking old clients.

  • Optional maxGuaranteeValue?: Money
  • Optional normalizeEmailDocuments?: boolean

    Determines whether or not data from incoming emails are extracted and normalized.

    Default

    false
  • Optional normalizeEmailDocumentsOptions?: {
        prioritizeCustomsTariffNumberFromEmail?: boolean;
        prioritizeGoodsDescriptionFromEmail?: boolean;
        remarks?: string;
    }
    • Optional prioritizeCustomsTariffNumberFromEmail?: boolean
    • Optional prioritizeGoodsDescriptionFromEmail?: boolean
    • Optional remarks?: string
  • Optional omitLineItemDescription?: boolean

    When set to true, line item descriptions will be omitted from the final goods description (if possible, if no other description is available it will be used).

  • Optional preferConsigneeFromEmail?: boolean
  • Optional preferPackagesFromHead?: boolean
  • Optional preferWeightFromHead?: boolean
  • Optional removeStakeholderContactInformation?: {
        active?: boolean;
    }
    • Optional active?: boolean
  • Optional searchForItemDescriptionOnInternet?: {
        active?: boolean;
    }
    • Optional active?: boolean
  • Optional specializedDescriptionAggregationJsonAta?: string

    Experimental: Use specialized formatting for aggregated descriptions. This will be used if useSpecializedDescriptionAggregation is set to true. If not set, uses the default descriptionFormatStringJsonAta and aggregation algorithm. The input for this JSONAta query is an array of lineItemContexts.

  • Optional statisticalValueAdditionDeductionOnlyToFirstLineItem?: boolean
  • Optional statisticalValueRounding?: "noRounding" | "roundOff" | "roundUp" | "roundToNearest"
  • Optional translateLineItemDescriptions?: {
        active?: boolean;
        destinationLanguage?: string;
    }
    • Optional active?: boolean
    • Optional destinationLanguage?: string
  • Optional useQuantityAsPackageCount?: boolean
  • Optional useSpecializedDescriptionAggregation?: boolean

    Enables experimental feature to use specialized description aggregation for line items, summing up quantities and concatenating lineItemDescriptions with "-" in the special "aggregated.aggregatedDescriptions" map (otherwise this property will remain empty or undefined).

  • Optional waybillCodePreference?: "singleCode" | "seperateCodes" | "dependentOnPreferences"

Optional dataValidation

dataValidation?: {
    active?: boolean;
    fraudDetection?: boolean;
}

Type declaration

  • Optional active?: boolean
  • Optional fraudDetection?: boolean

Optional defaultClassification

defaultClassification?: DigicustDocumentType

Optional defaultProcedureMode

defaultProcedureMode?: ProcedureMode

Optional doNotSendProcessedNotification

doNotSendProcessedNotification?: boolean

Optional doNotSendUploadNotification

doNotSendUploadNotification?: boolean

Optional events

events?: Event[]

Optional flags

flags?: {
    [key: string]: string;
}

Type declaration

  • [key: string]: string

Optional forceReference

forceReference?: false | "invoiceNumber"

Optional forceReferenceJSONata

forceReferenceJSONata?: string

Optional handleXLSXFileUploads

handleXLSXFileUploads?: boolean

Optional hsClassification

hsClassification?: {
    active?: boolean;
    research?: boolean;
}

Type declaration

  • Optional active?: boolean
  • Optional research?: boolean

Optional id

id?: string

Optional importViaSFTP

importViaSFTP?: {
    active?: boolean;
    sftp-dns-name?: string;
    sftp-inbound?: string;
    sftp-login-name?: string;
    sftp-outbound?: string;
    sftp-password?: string;
    sftp-port?: string;
}

Type declaration

  • Optional active?: boolean
  • Optional sftp-dns-name?: string
  • Optional sftp-inbound?: string
  • Optional sftp-login-name?: string
  • Optional sftp-outbound?: string
  • Optional sftp-password?: string
  • Optional sftp-port?: string

Optional isCondensed

isCondensed?: boolean

Optional isProcessWithDextor

isProcessWithDextor?: boolean

Deprecated

Optional masterDataUse

masterDataUse?: {
    useCountryOfOriginFromMasterData?: boolean;
}

Type declaration

  • Optional useCountryOfOriginFromMasterData?: boolean

Optional matchingEngine

matchingEngine?: {
    materialMatching?: {
        disableMaterialNumberMatching?: boolean;
        disableTariffNumberMatching?: boolean;
        disabled?: boolean;
        materialEnrichmentMergeConfig?: MaterialEnrichmentMergeConfig;
        sendMasterDataDescriptionOnly?: boolean;
        sendMasterDataTariffNumberOnly?: boolean;
        tariffNumberMatchingConfiguration?: {
            matchShipperCountry?: boolean;
            stakeholderFilters?: ("shipper" | "carrier" | "declarant" | "consignee" | "recipient" | "beneficiary" | "applicant" | "importer" | "exporter" | "buyer" | "agent" | "broker" | "warehouse" | "obligater")[];
        };
    };
}

Type declaration

  • Optional materialMatching?: {
        disableMaterialNumberMatching?: boolean;
        disableTariffNumberMatching?: boolean;
        disabled?: boolean;
        materialEnrichmentMergeConfig?: MaterialEnrichmentMergeConfig;
        sendMasterDataDescriptionOnly?: boolean;
        sendMasterDataTariffNumberOnly?: boolean;
        tariffNumberMatchingConfiguration?: {
            matchShipperCountry?: boolean;
            stakeholderFilters?: ("shipper" | "carrier" | "declarant" | "consignee" | "recipient" | "beneficiary" | "applicant" | "importer" | "exporter" | "buyer" | "agent" | "broker" | "warehouse" | "obligater")[];
        };
    }
    • Optional disableMaterialNumberMatching?: boolean
    • Optional disableTariffNumberMatching?: boolean
    • Optional disabled?: boolean
    • Optional materialEnrichmentMergeConfig?: MaterialEnrichmentMergeConfig
    • Optional sendMasterDataDescriptionOnly?: boolean
    • Optional sendMasterDataTariffNumberOnly?: boolean
    • Optional tariffNumberMatchingConfiguration?: {
          matchShipperCountry?: boolean;
          stakeholderFilters?: ("shipper" | "carrier" | "declarant" | "consignee" | "recipient" | "beneficiary" | "applicant" | "importer" | "exporter" | "buyer" | "agent" | "broker" | "warehouse" | "obligater")[];
      }
      • Optional matchShipperCountry?: boolean
      • Optional stakeholderFilters?: ("shipper" | "carrier" | "declarant" | "consignee" | "recipient" | "beneficiary" | "applicant" | "importer" | "exporter" | "buyer" | "agent" | "broker" | "warehouse" | "obligater")[]

Optional mergeMultipleUploads

mergeMultipleUploads?: boolean

Optional moduleId

moduleId?: string

Optional procedureCode

procedureCode?: string

Optional projectId

projectId?: string

Optional pseudonymization

pseudonymization?: {
    active?: boolean;
    interval?: number;
    time?: number;
}

Type declaration

  • Optional active?: boolean
  • Optional interval?: number
  • Optional time?: number

Optional referenceInEmail

referenceInEmail?: boolean

Optional ruleSettings

ruleSettings?: {
    sortLineItemsBeforeAnnotating?: "position" | "customsTariffNumber";
}

Type declaration

  • Optional sortLineItemsBeforeAnnotating?: "position" | "customsTariffNumber"

    Sort line items before applying line item rules with annotateOnlyFirstLineItem. This influences which ones of these line items will be annotated. Default value: position

Optional ruleSystem

ruleSystem?: "default" | "chained"

Optional rules

rules?: Rule[]

Optional submission

submission?: Submission

Optional subscriptionId

subscriptionId?: string

Optional uploadWidgets

uploadWidgets?: UploadWidget[]

Optional userInputTemplates

userInputTemplates?: UserInputTemplate[]

Optional whitelistedImportEmails

whitelistedImportEmails?: string[]

Settings

Member Visibility

Theme

On This Page

XLSXFileUploadsaliasautomatedcustomerIdcustomsdakosySubmissiondataExtractiondataIntegrationdataNormalizationdataValidationdefaultClassificationdefaultProcedureModedoNotSendProcessedNotificationdoNotSendUploadNotificationeventsflagsforceReferenceforceReferenceJSONatahandleXLSXFileUploadshsClassificationidimportViaSFTPisCondensedisProcessWithDextormasterDataUsematchingEnginemergeMultipleUploadsmoduleIdprocedureCodeprojectIdpseudonymizationreferenceInEmailruleSettingsruleSystemrulessubmissionsubscriptionIduploadWidgetsuserInputTemplateswhitelistedImportEmails