Statement Queue Schema
You may not need to do this!
If you purchased the platform via a reseller or directly from ERP-Apps, it is possible that the base schema may have been set up for you.
This is the required Rossum schema for a statement matching queue. It is structurally different to the invoice queue schema — it includes the statement line items, the matched/unmatched lines tables used by the matching engine, and the matching-related processing fields.
For general instructions on how to check, amend, or paste in a schema in Rossum, see Checking / Amending / Adding to the Schema JSON on the main queue schema page — the process is the same, just applied to your statement queue instead.
Required Schema
When configuring your statement 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": ["document_type"],
"constraints": { "required": false },
"default_value": "supplier_statement",
"category": "datapoint",
"id": "document_type",
"label": "Document Type",
"type": "enum",
"options": [
{ "value": "supplier_statement", "label": "Supplier Statement" },
{ "value": "hb_statement", "label": "Housing Benefit Statement" },
{ "value": "bank_statement", "label": "Bank Statement" },
{ "value": "other", "label": "Other" }
]
},
{
"rir_field_names": [],
"constraints": { "required": true },
"default_value": null,
"category": "datapoint",
"id": "date_from",
"label": "Date From",
"type": "date",
"format": "D/M/YYYY"
},
{
"rir_field_names": [],
"constraints": { "required": false },
"default_value": null,
"category": "datapoint",
"id": "date_to",
"label": "Date To",
"type": "date",
"format": "D/M/YYYY"
}
]
},
{
"category": "section",
"id": "vendor_section",
"label": "Vendor & Customer",
"children": [
{
"rir_field_names": [],
"constraints": { "required": true },
"default_value": null,
"category": "datapoint",
"id": "vendor_match",
"label": "Vendor ID",
"disable_prediction": true,
"type": "enum",
"can_export": true,
"ui_configuration": { "type": "manual", "edit": "enabled" },
"options": [],
"enum_value_type": "string"
}
]
},
{
"category": "section",
"id": "line_items_section",
"label": "Identified Line Items",
"children": [
{
"rir_field_names": ["line_items"],
"category": "multivalue",
"id": "line_items",
"label": "Line Item",
"children": {
"category": "tuple",
"id": "line_item",
"label": "Line Item",
"children": [
{ "constraints": { "required": true }, "category": "datapoint", "id": "item_transaction_number", "label": "Inv / Trans Number", "type": "string" },
{ "constraints": { "required": true }, "category": "datapoint", "id": "item_transaction_date", "label": "Transaction Date", "type": "date", "format": "D/M/YYYY" },
{ "rir_field_names": ["table_column_description"], "constraints": { "required": false }, "category": "datapoint", "id": "item_description", "label": "Description", "type": "string" },
{ "constraints": { "required": false }, "category": "datapoint", "id": "item_additional_reference", "label": "Reference", "type": "string" },
{ "constraints": { "required": false }, "category": "datapoint", "id": "item_debit_amount", "label": "Debit Amount", "type": "number", "format": "#,##0.#" },
{ "constraints": { "required": false }, "category": "datapoint", "id": "item_credit_amount", "label": "Credit Amount", "type": "number", "format": "#,##0.#" },
{ "constraints": { "required": false }, "category": "datapoint", "id": "item_balance_amount", "label": "Balance Amount", "type": "number", "format": "#,##0.#" }
]
}
}
]
},
{
"category": "section",
"id": "matching_section",
"label": "Matching",
"disable_prediction": true,
"children": [
{
"category": "multivalue",
"id": "unmatched_table",
"label": "Un-Matched Lines",
"children": {
"category": "tuple",
"id": "un_matched_line",
"label": "Unmatched Line",
"children": [
{ "constraints": { "required": false }, "category": "datapoint", "id": "um_manual_match_to", "label": "Manual Match", "disable_prediction": true, "type": "string", "can_export": true, "ui_configuration": { "type": "data", "edit": "enabled" } },
{ "constraints": { "required": false }, "default_value": "", "category": "datapoint", "id": "um_force_unmatch", "label": "Force Unmatch", "type": "enum", "can_export": true, "ui_configuration": { "type": "data", "edit": "enabled" }, "options": [ { "value": "", "label": "" }, { "value": "FORCE", "label": "Force Unmatch" } ] },
{ "constraints": { "required": false }, "hidden": true, "category": "datapoint", "id": "um_line_guid", "label": "Internal GUID", "type": "string", "can_export": true, "ui_configuration": { "type": "data", "edit": "disabled" } }
]
}
},
{
"category": "multivalue",
"id": "matched_table",
"label": "Matched Lines",
"children": {
"category": "tuple",
"id": "matched_line",
"label": "Matched Line",
"children": [
{ "constraints": { "required": true }, "category": "datapoint", "id": "ma_matched_to", "label": "Matched To", "type": "string", "can_export": true, "ui_configuration": { "type": "data", "edit": "disabled" } },
{ "constraints": { "required": true }, "category": "datapoint", "id": "ma_matched_by", "label": "Matched By", "type": "string", "can_export": true, "ui_configuration": { "type": "data", "edit": "disabled" } },
{ "constraints": { "required": false }, "default_value": "", "category": "datapoint", "id": "ma_force_unmatch", "label": "Force Unmatch", "type": "enum", "can_export": true, "ui_configuration": { "type": "data", "edit": "enabled" }, "options": [ { "value": "", "label": "" }, { "value": "FORCE", "label": "Force Unmatch" } ] },
{ "constraints": { "required": false }, "hidden": true, "category": "datapoint", "id": "ma_line_guid", "label": "Internal GUID", "type": "string", "can_export": true, "ui_configuration": { "type": "data", "edit": "disabled" } }
]
}
}
]
},
{
"category": "section",
"id": "erp_processing_section",
"label": "Processing",
"children": [
{ "constraints": { "required": true }, "category": "datapoint", "id": "company_id", "label": "ERP Company Id", "type": "string", "can_export": true },
{ "constraints": { "required": false }, "category": "datapoint", "id": "override_warnings", "label": "Override Warnings", "disable_prediction": true, "type": "enum", "can_export": true, "ui_configuration": { "type": "manual", "edit": "enabled" }, "options": [ { "value": "YES", "label": "YES" }, { "value": "NO", "label": "NO" } ], "enum_value_type": "string" },
{ "constraints": { "required": true }, "default_value": "1", "category": "datapoint", "id": "cache_behaviour", "label": "Caching Behaviour", "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" }
]
}
]
info
The fields above are a trimmed view of the full schema highlighting the parts unique to statement matching (the line items table, and the unmatched_table / matched_table matching grids). Your Rossum admin should obtain the complete, current schema file from ERP-Apps support to paste in directly, rather than typing this out by hand.
Notable fields
vendor_match— the supplier the statement has been matched to. This drives which transactions are pulled for matching, see the matching configuration.unmatched_table/matched_table— the grids shown in the Rossum screen for unmatched and matched lines respectively.um_manual_match_toandum_force_unmatch/ma_force_unmatchare editable by users to drive manual matching.company_id— required, used the same way as on the invoice schema to identify the ERP client/company for the statement.override_warnings— used in conjunction withelevateWarningsto allow export despite elevated warnings.