Skip to main content

Rossum Queues

warning

Please note that if you are using our hosted solution, this step may already have been done for you. Please get in touch with support if you are unsure.

Sign up with Rossum

To continue you will need access to a Rossum document processing queue. If you are using our hosted solution this will be provided. If you are not using this, you will need to sign up for your own processing queue at Rossum and follow their documentation to create a queue.

Once you have a queue ready to process, your data needs to go somewhere, and that's where our solution comes in!

Queues / Clients / Entities

info

Please note that each Rossum queue is billable.

If you are a multi client system you may be wondering the best way to set the system up.

For a simple client set-up you should have a queue per client and set the client in the extension settings (the next step).

If you are using legal entities the most straightforward way to configure the system is to have a Rossum queue and extension per client and legal entity combination, then use the extension setup to configure your client parameter and add in the default legal entity coding into the relevant dim.

You may choose to just have a single queue per client and then handle the entity coding either in Unit4, or possibly by using the Customer Data that Rossum extracts, to identify your legal entity.

You could do this using Rossum formula fields or even writing your own extra Rossum extension to (See Rossum's documentation for more details).

Queue Schema

You may not need to do this!

If you purchased the platform via a reseller or directly from ERP-APPS, it is likely that we will have set up the base schema for you.

Checking the Schema JSON

You can check and amend the schema by going to settings > fields in Rossum, and then clicking on the edit JSON button in the top right hand corner of the page.

shows the edit JSON button

This will show you the schema which you can copy out and compare to the required schema (below). Note it is also in this window that you paste the schema below, if it does not match and then use the save button when it is activated.

shows the automation setting percentage within the Rossum system

Amending Fields

You are able to amend fields in the settings > fields window, without going into the JSON editor, this can be useful for adding in rossum formula or additional fields for example.

However care should be taken in this area as changing the schema and fields may have an impact on the processing of documents and may cause the microservice to fail.

Changing settings in the fields menu of Rossum will automatically change the underlying schema JSON for you.

Required Schema

When configuring your queue, we require the schema to contain these fields.

As mentioned above, this schema can be copied and pasted into the Rossum JSON editor (overwriting anything that may already exist)

If you require extra fields we would just ignore them during processing, but the configuration must contain at least the following:

[
{
"category": "section",
"id": "invoice_info_section",
"label": "Basic information",
"children": [
{
"rir_field_names": [
"invoice_type"
],
"constraints": {
"required": true
},
"default_value": null,
"category": "datapoint",
"id": "invoice_type",
"label": "Invoice type",
"description": "Possible values: credit_note, debit_note, tax_invoice (most typical), proforma, receipt, delivery_note or other.",
"hidden": false,
"disable_prediction": false,
"type": "enum",
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
},
"options": [
{
"value": "tax_invoice",
"label": "Tax Invoice"
},
{
"value": "credit_note",
"label": "Credit Note"
},
{
"value": "proforma",
"label": "Pro Forma Invoice"
},
{
"value": "debit_note",
"label": "Debit Note"
},
{
"value": "receipt",
"label": "Receipt"
},
{
"value": "other",
"label": "Other"
}
],
"enum_value_type": "string"
},
{
"rir_field_names": [
"language"
],
"constraints": {
"required": false
},
"default_value": null,
"category": "datapoint",
"id": "language",
"label": "Invoice language",
"hidden": true,
"type": "enum",
"can_export": false,
"options": [
{
"value": "eng",
"label": "EN"
},
{
"value": "deu",
"label": "DE"
},
{
"value": "ces",
"label": "CZ"
},
{
"value": "slk",
"label": "SK"
},
{
"value": "fra",
"label": "FR"
},
{
"value": "other",
"label": "other"
}
]
},
{
"rir_field_names": [
"invoice_id"
],
"constraints": {
"required": true
},
"default_value": null,
"category": "datapoint",
"id": "invoice_id",
"label": "Invoice number",
"description": "Invoice number.",
"hidden": false,
"disable_prediction": false,
"type": "string",
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
}
},
{
"rir_field_names": [
"order_id"
],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "order_id",
"label": "Order number",
"description": "Purchase order identification.",
"hidden": false,
"disable_prediction": false,
"type": "string",
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
}
},
{
"rir_field_names": [
"customer_id"
],
"constraints": {
"required": false
},
"default_value": null,
"category": "datapoint",
"id": "customer_id",
"label": "Customer ID",
"hidden": true,
"type": "string",
"can_export": false
},
{
"rir_field_names": [
"date_issue"
],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "date_issue",
"label": "Issue date",
"description": "Date of issue of the document.",
"hidden": false,
"disable_prediction": false,
"type": "date",
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
},
"format": "D/M/YYYY"
},
{
"rir_field_names": [
"date_due"
],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "date_due",
"label": "Due date",
"description": "The due date of the invoice.",
"hidden": false,
"disable_prediction": false,
"type": "date",
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
},
"format": "D/M/YYYY"
},
{
"rir_field_names": [
"date_uzp"
],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "date_uzp",
"label": "Tax Point Date",
"description": "The date of taxable event.",
"hidden": false,
"disable_prediction": false,
"type": "date",
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
},
"format": "D/M/YYYY"
}
],
"icon": null
},
{
"category": "section",
"id": "amounts_section",
"label": "VAT & Amounts",
"children": [
{
"rir_field_names": [
"amount_total_base"
],
"constraints": {
"required": false
},
"default_value": null,
"category": "datapoint",
"id": "amount_total_base",
"label": "Total Net",
"description": "Base amount for tax calculation.",
"hidden": false,
"disable_prediction": false,
"type": "number",
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
},
"format": "# ##0.#"
},
{
"rir_field_names": [
"amount_total_tax"
],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "amount_total_tax",
"label": "Total tax",
"description": "Total tax amount.",
"hidden": false,
"disable_prediction": false,
"type": "number",
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
},
"format": "# ##0.#"
},
{
"rir_field_names": [
"amount_total"
],
"constraints": {
"required": true
},
"default_value": null,
"category": "datapoint",
"id": "amount_total",
"label": "Total Amount",
"description": "Subtotal over all items, including tax.",
"hidden": false,
"disable_prediction": false,
"type": "number",
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
},
"format": "# ##0.#"
},
{
"rir_field_names": [
"amount_due"
],
"constraints": {
"required": false
},
"default_value": null,
"category": "datapoint",
"id": "amount_due",
"label": "Due Amount",
"description": "Final amount including tax to be paid after deducting all discounts and advances.",
"hidden": false,
"disable_prediction": false,
"type": "number",
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
},
"format": "# ##0.#"
},
{
"rir_field_names": [
"amount_rounding"
],
"constraints": {
"required": false
},
"default_value": null,
"category": "datapoint",
"id": "amount_rounding",
"label": "Amount Rounding",
"hidden": true,
"type": "number",
"can_export": false,
"format": "# ##0.#"
},
{
"rir_field_names": [
"amount_paid"
],
"constraints": {
"required": false
},
"default_value": null,
"category": "datapoint",
"id": "amount_paid",
"label": "Amount Paid",
"hidden": true,
"type": "number",
"can_export": false,
"format": "# ##0.#"
},
{
"rir_field_names": [
"currency"
],
"constraints": {
"required": false
},
"default_value": "gbp",
"category": "datapoint",
"id": "currency",
"label": "Currency",
"description": "The currency which the invoice is to be paid in. Possible values: czk, dkk, eur, gbp, nok, sek, usd or other.",
"hidden": false,
"disable_prediction": false,
"type": "enum",
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
},
"options": [
{
"value": "gbp",
"label": "GBP"
},
{
"value": "eur",
"label": "EUR"
},
{
"value": "usd",
"label": "USD"
},
{
"value": "czk",
"label": "CZK"
},
{
"value": "nok",
"label": "NOK"
},
{
"value": "sek",
"label": "SEK"
},
{
"value": "dkk",
"label": "DKK"
},
{
"value": "other",
"label": "Other"
}
],
"enum_value_type": "string"
},
{
"rir_field_names": [],
"category": "multivalue",
"id": "tax_details",
"label": "VAT",
"hidden": false,
"children": {
"rir_field_names": [
"tax_details"
],
"category": "tuple",
"id": "tax_detail",
"label": "VAT",
"hidden": false,
"children": [
{
"rir_field_names": [
"tax_detail_rate"
],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "tax_detail_rate",
"label": "VAT Rate",
"description": "One of the tax rates in the tax breakdown.",
"hidden": false,
"disable_prediction": false,
"type": "number",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
},
"format": "# ##0.#"
},
{
"rir_field_names": [
"tax_detail_base"
],
"constraints": {
"required": false
},
"default_value": null,
"category": "datapoint",
"id": "tax_detail_base",
"label": "VAT Base",
"description": "Sum of tax bases for items with the same tax rate.",
"hidden": false,
"disable_prediction": false,
"type": "number",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
},
"format": "# ##0.#"
},
{
"rir_field_names": [
"tax_detail_tax"
],
"constraints": {
"required": false
},
"default_value": null,
"category": "datapoint",
"id": "tax_detail_tax",
"label": "VAT Amount",
"description": "Sum of taxes for items with the same tax rate.",
"hidden": false,
"disable_prediction": false,
"type": "number",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
},
"format": "# ##0.#"
},
{
"rir_field_names": [
"tax_detail_total"
],
"constraints": {
"required": false
},
"default_value": null,
"category": "datapoint",
"id": "tax_detail_total",
"label": "VAT Total",
"description": "Total amount including tax for all items with the same tax rate.",
"hidden": false,
"disable_prediction": false,
"type": "number",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
},
"format": "# ##0.#"
}
]
},
"min_occurrences": null,
"max_occurrences": 4,
"default_value": null,
"show_grid_by_default": false
}
],
"icon": null
},
{
"category": "section",
"id": "vendor_section",
"label": "Vendor & Customer",
"children": [
{
"rir_field_names": [],
"constraints": {
"required": true
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "vendor_match",
"label": "Vendor ID",
"hidden": false,
"disable_prediction": true,
"type": "enum",
"can_export": true,
"ui_configuration": {
"type": "manual",
"edit": "enabled"
},
"options": [],
"enum_value_type": "string"
},
{
"rir_field_names": [],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "vendor_id_manual",
"label": "Vendor search",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_export": true,
"ui_configuration": {
"type": "manual",
"edit": "enabled"
}
},
{
"rir_field_names": [
"sender_name"
],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "sender_name",
"label": "Vendor Name",
"description": "Name of the supplier.",
"hidden": false,
"disable_prediction": false,
"type": "string",
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
}
},
{
"rir_field_names": [
"sender_address"
],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "sender_address",
"label": "Vendor address",
"description": "Address of the supplier.",
"hidden": false,
"disable_prediction": false,
"type": "string",
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
}
},
{
"rir_field_names": [
"sender_ic"
],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "sender_ic",
"label": "Vendor company ID",
"description": "Business/organization identification number of the supplier.",
"hidden": false,
"disable_prediction": false,
"type": "string",
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
}
},
{
"rir_field_names": [
"sender_vat_id",
"sender_dic"
],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "sender_vat_id",
"label": "Vendor VAT number",
"description": "VAT identification number of the supplier.",
"hidden": false,
"disable_prediction": false,
"type": "string",
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
}
},
{
"rir_field_names": [
"recipient_name"
],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "recipient_name",
"label": "Customer name",
"description": "Name of the customer.",
"hidden": false,
"disable_prediction": false,
"type": "string",
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
}
},
{
"rir_field_names": [
"recipient_address"
],
"constraints": {
"required": false
},
"default_value": null,
"category": "datapoint",
"id": "recipient_address",
"label": "Customer address",
"description": "Address of the customer.",
"hidden": false,
"disable_prediction": false,
"type": "string",
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
}
},
{
"rir_field_names": [
"recipient_ic"
],
"constraints": {
"required": false
},
"default_value": null,
"category": "datapoint",
"id": "recipient_ic",
"label": "Customer company ID",
"description": "Company identification number of the customer.",
"hidden": false,
"disable_prediction": false,
"type": "string",
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
}
},
{
"rir_field_names": [
"recipient_vat_id",
"recipient_dic"
],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "recipient_vat_id",
"label": "Customer VAT number",
"description": "Customer VAT Number.",
"hidden": false,
"disable_prediction": false,
"type": "string",
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
}
}
],
"icon": null
},
{
"category": "section",
"id": "payment_info_section",
"label": "Payment instructions",
"children": [
{
"rir_field_names": [
"account_num"
],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "account_num",
"label": "Account number",
"description": "Bank account number.",
"hidden": false,
"disable_prediction": false,
"type": "string",
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
}
},
{
"rir_field_names": [
"bank_num"
],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "bank_num",
"label": "Sort code",
"description": "Sort code. Numerical code of the bank.",
"hidden": false,
"disable_prediction": false,
"type": "string",
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
}
},
{
"rir_field_names": [
"iban"
],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "iban",
"label": "IBAN",
"description": "Bank account number in IBAN format.",
"hidden": false,
"disable_prediction": false,
"type": "string",
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
}
},
{
"rir_field_names": [
"bic"
],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "bic",
"label": "BIC/SWIFT",
"description": "Bank BIC or SWIFT code.",
"hidden": false,
"disable_prediction": false,
"type": "string",
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
}
},
{
"rir_field_names": [
"terms"
],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "terms",
"label": "Terms",
"description": "Payment terms as written on the document (eg. \"45 days\", \"upon receipt\").",
"hidden": false,
"disable_prediction": false,
"type": "string",
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
}
},
{
"rir_field_names": [
"payment_state"
],
"constraints": {
"required": false
},
"default_value": null,
"category": "datapoint",
"id": "payment_state",
"label": "Payment state",
"hidden": true,
"type": "enum",
"can_export": false,
"options": [
{
"value": "automatic",
"label": "automatic"
},
{
"value": "manual",
"label": "manual"
},
{
"value": "pending",
"label": "pending"
}
]
},
{
"rir_field_names": [
"const_sym"
],
"constraints": {
"required": false
},
"default_value": null,
"category": "datapoint",
"id": "const_sym",
"label": "Constant symbol",
"hidden": true,
"type": "string",
"can_export": false
},
{
"rir_field_names": [
"var_sym"
],
"constraints": {
"required": false
},
"default_value": null,
"category": "datapoint",
"id": "var_sym",
"label": "Payment reference",
"hidden": true,
"type": "string",
"can_export": false
},
{
"rir_field_names": [
"spec_sym"
],
"constraints": {
"required": false
},
"default_value": null,
"category": "datapoint",
"id": "spec_sym",
"label": "Specific symbol",
"hidden": true,
"type": "string",
"can_export": false
}
],
"icon": null
},
{
"category": "section",
"id": "other_section",
"label": "Other",
"children": [
{
"rir_field_names": [],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "notes",
"label": "Notes",
"type": "string"
},
{
"rir_field_names": [],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "local_status",
"label": "Status",
"hidden": false,
"disable_prediction": true,
"type": "enum",
"can_export": true,
"ui_configuration": {
"type": "manual",
"edit": "enabled"
},
"options": [
{
"value": "P",
"label": "Parked"
}
],
"enum_value_type": "string"
}
],
"icon": null
},
{
"category": "section",
"id": "line_items_section",
"label": "Line items",
"children": [
{
"rir_field_names": [],
"category": "multivalue",
"id": "line_items",
"label": "Line item",
"hidden": false,
"children": {
"rir_field_names": [],
"category": "tuple",
"id": "line_item",
"label": "Line item",
"children": [
{
"rir_field_names": [
"table_column_code"
],
"width": 50,
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "item_code",
"label": "Code",
"description": "Can be the SKU, EAN, a custom code (string of letters/numbers) or even just the line number.",
"hidden": false,
"disable_prediction": false,
"type": "string",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
}
},
{
"rir_field_names": [
"table_column_description"
],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "item_description",
"label": "Description",
"description": "Line item description. Can be multi-line with details.",
"hidden": false,
"disable_prediction": false,
"type": "string",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
}
},
{
"rir_field_names": [
"table_column_quantity"
],
"width": 5,
"constraints": {
"required": true
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "item_quantity",
"label": "Quantity",
"description": "Quantity of the item.",
"hidden": false,
"disable_prediction": false,
"type": "number",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
},
"format": "# ##0.#"
},
{
"rir_field_names": [
"table_column_uom"
],
"width": 5,
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "item_uom",
"label": "UOM",
"description": "Unit of measure of the item (kg, container, piece, gallon, ...).",
"hidden": false,
"disable_prediction": false,
"type": "string",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
}
},
{
"rir_field_names": [
"table_column_amount_base"
],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "item_amount_base",
"label": "Net Unit Price",
"description": "Unit price without tax.",
"hidden": false,
"disable_prediction": false,
"type": "number",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
},
"format": "# ##0.#",
"aggregations": {
"sum": {
"label": "Total"
}
}
},
{
"rir_field_names": [
"table_column_amount"
],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "item_amount",
"label": "Gross Unit Price",
"description": "Unit price with tax. Rule of thumb: amount = amount_base + tax.",
"hidden": false,
"disable_prediction": false,
"type": "number",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
},
"format": "# ##0.#",
"aggregations": {
"sum": {
"label": "Total"
}
}
},
{
"rir_field_names": [
"table_column_amount_total_base"
],
"constraints": {
"required": true
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "item_total_base",
"label": "Total Net",
"hidden": false,
"disable_prediction": false,
"type": "number",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
},
"format": "# ##0.#",
"aggregations": {
"sum": {
"label": "Total"
}
}
},
{
"rir_field_names": [
"table_column_rate"
],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "item_rate",
"label": "Tax Rate",
"description": "Tax rate for the line item.",
"hidden": false,
"disable_prediction": false,
"type": "number",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
},
"format": "# ##0.#"
},
{
"rir_field_names": [
"table_column_tax"
],
"constraints": {
"required": true
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "item_tax",
"label": "Total Tax",
"description": "Tax amount for the line. Rule of thumb: tax = rate * amount_base.",
"hidden": false,
"disable_prediction": false,
"type": "number",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
},
"format": "# ##0.#",
"aggregations": {
"sum": {
"label": "Total"
}
}
},
{
"rir_field_names": [
"table_column_amount_total"
],
"constraints": {
"required": true
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "item_amount_total",
"label": "Total Gross",
"description": "The total amount to be paid for all the items including the tax. Rule of thumb: amount_total = amount * quantity.",
"hidden": false,
"disable_prediction": false,
"type": "number",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "captured",
"edit": "enabled"
},
"format": "# ##0.#",
"aggregations": {
"sum": {
"label": "Total"
}
}
},
{
"rir_field_names": [
"table_column_other"
],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "item_other",
"label": "Other",
"type": "string"
},
{
"rir_field_names": [],
"width": 5,
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "item_order_id",
"label": "OrderId",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "enabled"
}
},
{
"rir_field_names": [],
"width": 5,
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "item_order_line_no",
"label": "Order Line",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "enabled"
}
},
{
"rir_field_names": [],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "line_guid",
"label": "line_guid",
"hidden": true,
"disable_prediction": true,
"type": "string",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "disabled"
}
}
]
},
"min_occurrences": null,
"max_occurrences": null,
"default_value": null,
"show_grid_by_default": false
},
{
"rir_field_names": [],
"category": "multivalue",
"id": "accounting_information",
"label": "Accounting Information",
"hidden": false,
"children": {
"rir_field_names": [],
"category": "tuple",
"id": "line_codes_tuple",
"label": "Line Coding",
"children": [
{
"rir_field_names": [],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "accounting_description",
"label": "Description",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "enabled"
}
},
{
"rir_field_names": [],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "account",
"label": "account",
"hidden": false,
"disable_prediction": true,
"type": "enum",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "enabled"
},
"options": [],
"enum_value_type": "string"
},
{
"rir_field_names": [],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "accounting_dimension_1",
"label": "Dim1",
"hidden": false,
"disable_prediction": true,
"type": "enum",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "enabled"
},
"options": [],
"enum_value_type": "string"
},
{
"rir_field_names": [],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "accounting_dimension_2",
"label": "Dim2",
"hidden": false,
"disable_prediction": true,
"type": "enum",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "enabled"
},
"options": [],
"enum_value_type": "string"
},
{
"rir_field_names": [],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "accounting_dimension_3",
"label": "Dim3",
"hidden": false,
"disable_prediction": true,
"type": "enum",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "enabled"
},
"options": [],
"enum_value_type": "string"
},
{
"rir_field_names": [],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "accounting_dimension_4",
"label": "Dim4",
"hidden": false,
"disable_prediction": true,
"type": "enum",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "enabled"
},
"options": [],
"enum_value_type": "string"
},
{
"rir_field_names": [],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "accounting_dimension_5",
"label": "Dim5",
"hidden": false,
"disable_prediction": true,
"type": "enum",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "enabled"
},
"options": [],
"enum_value_type": "string"
},
{
"rir_field_names": [],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "accounting_dimension_6",
"label": "Dim6",
"hidden": false,
"disable_prediction": true,
"type": "enum",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "enabled"
},
"options": [],
"enum_value_type": "string"
},
{
"rir_field_names": [],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "accounting_dimension_7",
"label": "Dim7",
"hidden": false,
"disable_prediction": true,
"type": "enum",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "enabled"
},
"options": [],
"enum_value_type": "string"
},
{
"rir_field_names": [],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "tax_code",
"label": "Tax Code",
"hidden": false,
"disable_prediction": true,
"type": "enum",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "enabled"
},
"options": [],
"enum_value_type": "string"
},
{
"rir_field_names": [],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "tax_system",
"label": "Tax System",
"hidden": false,
"disable_prediction": true,
"type": "enum",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "enabled"
},
"options": [],
"enum_value_type": "string"
},
{
"rir_field_names": [],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "line_guid_accounting",
"label": "line_guid",
"hidden": true,
"disable_prediction": true,
"type": "string",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "enabled"
}
}
]
},
"min_occurrences": null,
"max_occurrences": null,
"default_value": null,
"show_grid_by_default": false
}
],
"icon": null
},
{
"category": "section",
"id": "discovered_purchase_orders",
"label": "Purchase Order Details",
"description": "Details from Unit4 ERP",
"hidden": false,
"children": [
{
"rir_field_names": [],
"category": "multivalue",
"id": "discovered_po_lines",
"label": "Purchase Order Lines",
"hidden": false,
"children": {
"rir_field_names": [],
"category": "tuple",
"id": "discovered_po_lines_tuple",
"label": "Purchase Order Lines",
"children": [
{
"rir_field_names": [],
"width": 5,
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "discovered_po_line_order_id",
"label": "Order ID",
"description": "Order ID for line",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "disabled"
}
},
{
"rir_field_names": [],
"width": 3,
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "discovered_po_line_line_number",
"label": "Line Number",
"description": "Line Number for line",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "disabled"
}
},
{
"rir_field_names": [],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "discovered_po_line_product",
"label": "Product",
"description": "Product for line",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "disabled"
}
},
{
"rir_field_names": [],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "discovered_po_line_description",
"label": "Description",
"description": "Description for line",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "disabled"
}
},
{
"rir_field_names": [],
"width": 5,
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "discovered_po_line_order_quantity",
"label": "Order Qty",
"description": "Order Quantity for line",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "disabled"
}
},
{
"rir_field_names": [],
"width": 5,
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "discovered_po_line_unit_price",
"label": "Unit Price",
"description": "Unit Price for line",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "disabled"
}
},
{
"rir_field_names": [],
"width": 5,
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "discovered_po_line_order_amount",
"label": "Order Amount",
"description": "Order Amount for line",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "disabled"
}
},
{
"rir_field_names": [],
"width": 5,
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "discovered_po_line_grn_quantity",
"label": "GRN Qty",
"description": "GRN Quantity for line",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "disabled"
}
},
{
"rir_field_names": [],
"width": 5,
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "discovered_po_line_grn_amount",
"label": "GRN Amt",
"description": "GRN Amount for line",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "disabled"
}
},
{
"rir_field_names": [],
"width": 6,
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "discovered_po_line_registered_invoice_quantity",
"label": "Reg Inv Qty",
"description": "Registered Invoice Quantity for line",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "disabled"
}
},
{
"rir_field_names": [],
"width": 6,
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "discovered_po_line_registered_invoice_amount",
"label": "Reg Inv Amt",
"description": "Registered Invoice amount for line",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "disabled"
}
},
{
"rir_field_names": [],
"width": 6,
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "discovered_po_line_posted_invoice_amount",
"label": "Post Inv Amt",
"description": "Posted Invoice amount for line",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "disabled"
}
},
{
"rir_field_names": [],
"width": 6,
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "discovered_po_line_posted_invoice_quantity",
"label": "Post Inv Qty",
"description": "Posted Invoice quantity for line",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "disabled"
}
},
{
"rir_field_names": [],
"width": 6,
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "discovered_po_line_returned_invoice_amount",
"label": "Ret Inv Amt",
"description": "Returned Invoice amount for line",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "disabled"
}
},
{
"rir_field_names": [],
"width": 6,
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "discovered_po_line_returned_invoice_quantity",
"label": "Ret Inv Qty",
"description": "Returned Invoice quantity for line",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "disabled"
}
},
{
"rir_field_names": [],
"width": 3,
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "discovered_po_line_unit",
"label": "Unit",
"description": "Unit",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "disabled"
}
},
{
"rir_field_names": [],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "discovered_po_line_contract_id",
"label": "Contract ID",
"description": "Contract ID for line",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "disabled"
}
},
{
"rir_field_names": [],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "discovered_po_line_external_ref",
"label": "External Ref",
"description": "External Ref for line",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "disabled"
}
},
{
"rir_field_names": [],
"width": 1,
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "discovered_po_line_status",
"label": "Status",
"description": "Status for line",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "disabled"
}
},
{
"rir_field_names": [],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "discovered_po_line_currency",
"label": "Currency",
"description": "Currency for line",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_collapse": false,
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "disabled"
}
}
]
},
"min_occurrences": null,
"max_occurrences": null,
"default_value": null,
"show_grid_by_default": false
}
],
"icon": null
},
{
"category": "section",
"id": "erp_processing_section",
"label": "Processing",
"hidden": false,
"children": [
{
"rir_field_names": [],
"constraints": {
"required": true
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "company_id",
"label": "ERP Company Id",
"hidden": false,
"type": "string",
"can_export": true
},
{
"rir_field_names": [],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "iban_normalized",
"label": "iban_normalized",
"description": "iban_normalized",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_export": false,
"ui_configuration": {
"type": "formula",
"edit": "enabled"
},
"formula": "import re\nre.sub(r'[^a-zA-Z0-9]', '', default_to(field.iban, ''))"
},
{
"rir_field_names": [],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "tax_id_normalised",
"label": "tax_id_normalised",
"description": "tax_id_normalised",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_export": false,
"ui_configuration": {
"type": "formula",
"edit": "enabled"
},
"formula": "import re\n\nre.sub(r'[^a-zA-Z0-9]', '', default_to(field.sender_vat_id, ''))"
},
{
"rir_field_names": [],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "company_reg_normalised",
"label": "company_reg_normalised",
"description": "company_reg_normalised",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_export": false,
"ui_configuration": {
"type": "formula",
"edit": "enabled"
},
"formula": "import re\nre.sub(r'[^a-zA-Z0-9]', '', default_to(field.sender_ic, ''))"
},
{
"rir_field_names": [],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "saved_transaction_id",
"label": "ERP ID",
"description": "ERPx Transaction number or ERP7 EI02 number. Written after the document has been matched and saved to ERP",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "disabled"
}
},
{
"rir_field_names": [
"email_header:from"
],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "sender_email",
"label": "Sender Email",
"description": "Email the document was attached to",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "disabled"
}
},
{
"rir_field_names": [],
"constraints": {
"required": true
},
"score_threshold": 0,
"default_value": null,
"category": "datapoint",
"id": "erp_document_type",
"label": "erp_document_type",
"hidden": false,
"disable_prediction": true,
"type": "string",
"can_export": true,
"ui_configuration": {
"type": "data",
"edit": "disabled"
}
},
{
"rir_field_names": [],
"constraints": {
"required": false
},
"score_threshold": 0,
"default_value": "v1.0.0.1",
"category": "datapoint",
"id": "schema_version",
"label": "schema_version",
"hidden": true,
"disable_prediction": true,
"type": "string",
"can_export": false,
"ui_configuration": {
"type": "data",
"edit": "enabled"
}
},
{
"rir_field_names": [],
"constraints": {},
"score_threshold": 0,
"default_value": "1",
"category": "datapoint",
"id": "cache_behaviour",
"label": "Caching Behaviour",
"description": "Skipping caching will cause slow downs, but can be useful if the relevant data in ERP has been recently updated.",
"hidden": false,
"disable_prediction": true,
"type": "enum",
"can_export": true,
"ui_configuration": {
"type": "manual",
"edit": "enabled"
},
"options": [
{
"value": "1",
"label": "Use caching"
},
{
"value": "0",
"label": "Skip caches for this document"
}
],
"enum_value_type": "string"
}
],
"icon": null
}
]