Custom Schemas
When you need to read something from a document that is not in the system schemas, you define your own.
When It Makes Sense
- A document from a single supplier with a non-standard layout.
- Industry specialties: weigh tickets, test reports, fuel cards.
- Fields that you need in your system and are not found elsewhere.
Keep in mind that a document from a custom schema cannot be sent to accounting or exported to accounting formats — those read fixed invoice fields. JSON, XML, YAML, CSV, Excel, and PDF remain. Only documents with the numeric field TotalAmount are counted in reports.
How It Is Defined
Using the editor in the Schemas tab. It is written in JSON Schema — an object with properties, each field having type and description, lists as array with items. Those familiar with the standard will not be surprised; those who are not can start from a template (invoice, invoice with VAT, receipt, delivery note, minimal) or from a copy of a system schema. Template fields have English names just like system schemas, so the validation form will find the label; field descriptions are in the interface language and can be overwritten.
References, allOf, oneOf, conditions, and similar constructs are not allowed by the editor; the schema must be a flat tree of fields. A copy of the system schema retains its model specification, so it recognizes the same as the template; using the Detach button will turn it into a regular custom schema.
Field Description Is a Guide for the Model
This is the most important thing on the entire page. The description is not only for humans; the model reads it too. The difference between "order number" and "order number, starts with Z- and has six digits, usually in the top right corner next to the barcode" is significant for success.
Limits
The number of fields is governed by the plan: 80 on Free and Starter, 160 on Business, 240 on Scale. Nested fields and item fields are also counted. Names and descriptions are sent to the model for every document, so a longer schema means more expensive processing.
Testing
The editor checks syntax continuously and will not allow saving until the schema is valid. You can only test it on an actual document: upload it with the selected schema, or select Process Again on a completed document. Both cost credits like regular processing.
Changes and Deletion
The modified schema applies to further processing. Documents that have already been processed retain data as it was created. A schema under which at least one document was recognized cannot be deleted — documents would lose their validation form.