Engine Field

Engine field objects define the data fields that an engine can extract from documents. Each field has a specific type (string, number, date, enum) and optional subtype for more precise data validation and formatting. Fields can be configured for tabular data extraction and support pre-trained field types for common document elements.

Engine field

Attribute

Type

Description

id*

read-only

integer

Engine Field object ID.

url*

read-only

URL

Engine Field object URL.

engine*

URL

Engine object URL.

name*

string

Name of the field. Only numbers, characters and underscores are allowed. The value must be unique across all fields for given engine.

label*

string

Human readable name of the field.

type*

"string" | "number" | "date" | "enum"

Type of the field.

subtype*

string | null

Subtype for more specific field validation. Possible values depend on the field type:

String subtypes:

null: Plain text without any constraints
alphanumeric: Only characters a-z, A-Z, and 0-9 (whitespace stripped). Example: A 123b → A123b.
numeric: Only numbers (whitespace stripped, useful for leading zeros). Example: 01 23 → 0123.
country_code: Two or three-letter country code (ISO 3166). Example: CZ or CZE.
currency_code: Three-letter currency code (ISO 4217). Example: USD.
iban: International Bank Account Number (up to 34 alphanumeric characters). Example: IE12BOFI90000112345678.
vat_number: VAT identification number (starts with country code, 2-13 characters). Example: CZ1234567890.

Number subtypes:

null: Plain number
integer: Whole number. Example: 10.0 → 10.
rate: Typically in range of 0-100%. Example: 10% → 10, 15,00 → 15.
amount: Financial notation (parenthesis for negative values). Example: (100) → -100, $10.5 → 10.5, ▲10 → -10.

Date subtypes:

null: Plain date
period_begin: Beginning of date period (fallback to first day of month)
period_end: End of date period (fallback to last day of month)

pre_trained_field_id*

string | null

Pre-trained field identifier for common document elements. See the pre_trained_fields endpoint for available values.

tabular*

boolean

Whether the field belongs to a multivalue row. Default is false. Must be in sync with all assigned schemas - tabular = true means that the field is a child of tabular multivalue.

Default: false

multiline*

"true" | "false"

Multiline configuration. Allowed values are:

true: Field's parent is of type tuple
false: Header field

List engine fields

Retrieve all engine field objects.

curl -X GET "https://example.rossum.app/api/v1/engine_fields?engine=https%3A%2F%2Fexample.rossum.app%2Fapi%2Fv1%2Fengines%2F8&used=true"

curl -X GET "https://example.rossum.app/api/v1/engine_fields?engine=https%3A%2F%2Fexample.rossum.app%2Fapi%2Fv1%2Fengines%2F8&used=true"

Example response showing multiple engine fields for an invoice processing engine.

{
  "pagination": {
    "total": 15,
    "total_pages": 1,
    "next": null,
    "previous": null
  },
  "results": [
    {
      "id": 3,
      "url": "https://example.rossum.app/api/v1/engine_fields/3",
      "engine": "https://example.rossum.app/api/v1/engines/8",
      "name": "document_id",
      "label": "DocumentID",
      "type": "string",
      "subtype": "string",
      "pre_trained_field_id": "document_id",
      "tabular": false,
      "multiline": "false"
    },
    {
      "id": 4,
      "url": "https://example.rossum.app/api/v1/engine_fields/4",
      "engine": "https://example.rossum.app/api/v1/engines/8",
      "name": "amount_total",
      "label": "Total Amount",
      "type": "number",
      "subtype": "amount",
      "pre_trained_field_id": "amount_total",
      "tabular": false,
      "multiline": "false"
    },
    {
      "id": 5,
      "url": "https://example.rossum.app/api/v1/engine_fields/5",
      "engine": "https://example.rossum.app/api/v1/engines/8",
      "name": "date_issue",
      "label": "Issue Date",
      "type": "date",
      "subtype": null,
      "pre_trained_field_id": "date_issue",
      "tabular": false,
      "multiline": "false"
    }
  ]
}

{
  "detail": "Bad Request.",
  "code": "bad_request"
}

{
  "detail": "Invalid token.",
  "code": "authentication_failed"
}

{
  "detail": "Access to the requested resource is forbidden.",
  "code": "access_forbidden"
}

{
  "detail": "Not found.",
  "code": "not_found"
}

{
  "detail": "Request was rate limited.",
  "code": "rate_limited",
  "url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}

{
  "detail": "Server error.",
  "code": "error"
}

{
  "detail": "Bad Gateway.",
  "code": "bad_gateway"
}

{
  "detail": "Service Unavailable.",
  "code": "service_unavailable"
}

{
  "detail": "Gateway timeout.",
  "code": "gateway_timeout"
}

Response

200OK

Attribute

Type

Description

pagination*

pagination

URL

URL for the next page of results. Contains an opaque signed cursor query parameter. Use this URL directly to fetch the next page — do not attempt to construct or modify the cursor value.

URL

URL for the previous page of results. Contains an opaque signed cursor query parameter. Use this URL directly to fetch the previous page — do not attempt to construct or modify the cursor value.

results*

list[engine_field]

id*

read-only

integer

Engine Field object ID.

url*

read-only

URL

Engine Field object URL.

engine*

URL

Engine object URL.

name*

string

Name of the field. Only numbers, characters and underscores are allowed. The value must be unique across all fields for given engine.

label*

string

Human readable name of the field.

type*

"string" | "number" | "date" | "enum"

Type of the field.

subtype*

string | null

Subtype for more specific field validation. Possible values depend on the field type:

String subtypes:

null: Plain text without any constraints
alphanumeric: Only characters a-z, A-Z, and 0-9 (whitespace stripped). Example: A 123b → A123b.
numeric: Only numbers (whitespace stripped, useful for leading zeros). Example: 01 23 → 0123.
country_code: Two or three-letter country code (ISO 3166). Example: CZ or CZE.
currency_code: Three-letter currency code (ISO 4217). Example: USD.
iban: International Bank Account Number (up to 34 alphanumeric characters). Example: IE12BOFI90000112345678.
vat_number: VAT identification number (starts with country code, 2-13 characters). Example: CZ1234567890.

Number subtypes:

null: Plain number
integer: Whole number. Example: 10.0 → 10.
rate: Typically in range of 0-100%. Example: 10% → 10, 15,00 → 15.
amount: Financial notation (parenthesis for negative values). Example: (100) → -100, $10.5 → 10.5, ▲10 → -10.

Date subtypes:

null: Plain date
period_begin: Beginning of date period (fallback to first day of month)
period_end: End of date period (fallback to last day of month)

pre_trained_field_id*

string | null

Pre-trained field identifier for common document elements. See the pre_trained_fields endpoint for available values.

tabular*

boolean

Whether the field belongs to a multivalue row. Default is false. Must be in sync with all assigned schemas - tabular = true means that the field is a child of tabular multivalue.

Default: false

multiline*

"true" | "false"

Multiline configuration. Allowed values are:

true: Field's parent is of type tuple
false: Header field

400Bad Request

Invalid input data.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

401Unauthorized

The username/password is invalid or token is invalid (e.g. expired).

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

403Forbidden

Insufficient permission, missing authentication, invalid CSRF token and similar issue.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

404Not Found

The specified resource was not found.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

429Too Many Requests

Request rate is too high, wait before sending more requests. See Rate Limiting for more details.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

url

read-only

string

Link to the rate limiting documentation

500Internal Server Error

Server failure while processing the request.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

502Bad Gateway

Invalid response from the upstream server.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

503Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

504

Upstream server could not complete the request in time.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

Create engine field

Create a new engine field object.

curl -X POST "https://example.rossum.app/api/v1/engine_fields" \
  -H "Content-Type: application/json" \
  -d '{
    "engine": "https://example.rossum.app/api/v1/engines/8",
    "name": "vendor_name",
    "label": "Vendor Name",
    "type": "string",
    "subtype": null,
    "pre_trained_field_id": "sender_name",
    "tabular": false,
    "multiline": "false"
  }'

curl -X POST "https://example.rossum.app/api/v1/engine_fields" \  -H "Content-Type: application/json" \  -d '{    "engine": "https://example.rossum.app/api/v1/engines/8",    "name": "vendor_name",    "label": "Vendor Name",    "type": "string",    "subtype": null,    "pre_trained_field_id": "sender_name",    "tabular": false,    "multiline": "false"  }'

Response after successfully creating a new engine field.

{
  "id": 10,
  "url": "https://example.rossum.app/api/v1/engine_fields/10",
  "engine": "https://example.rossum.app/api/v1/engines/8",
  "name": "vendor_name",
  "label": "Vendor Name",
  "type": "string",
  "subtype": null,
  "pre_trained_field_id": "sender_name",
  "tabular": false,
  "multiline": "false"
}

{
  "detail": "Bad Request.",
  "code": "bad_request"
}

{
  "detail": "Invalid token.",
  "code": "authentication_failed"
}

{
  "detail": "Access to the requested resource is forbidden.",
  "code": "access_forbidden"
}

{
  "detail": "Not found.",
  "code": "not_found"
}

{
  "detail": "Conflict.",
  "code": "conflict_status"
}

{
  "detail": "Payload Too Large.",
  "code": "payload_too_large"
}

{
  "detail": "Request was rate limited.",
  "code": "rate_limited",
  "url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}

{
  "detail": "Server error.",
  "code": "error"
}

{
  "detail": "Bad Gateway.",
  "code": "bad_gateway"
}

{
  "detail": "Service Unavailable.",
  "code": "service_unavailable"
}

{
  "detail": "Gateway timeout.",
  "code": "gateway_timeout"
}

Request Body

application/json

Attribute

Type

Description

engine*

URL

Engine object URL.

name*

string

Name of the field. Only numbers, characters and underscores are allowed. The value must be unique across all fields for given engine.

label*

string

Human readable name of the field.

type*

"string" | "number" | "date" | "enum"

Type of the field.

subtype

string | null

Subtype for more specific field validation. Possible values depend on the field type:

String subtypes:

null: Plain text without any constraints
alphanumeric: Only characters a-z, A-Z, and 0-9 (whitespace stripped). Example: A 123b → A123b.
numeric: Only numbers (whitespace stripped, useful for leading zeros). Example: 01 23 → 0123.
country_code: Two or three-letter country code (ISO 3166). Example: CZ or CZE.
currency_code: Three-letter currency code (ISO 4217). Example: USD.
iban: International Bank Account Number (up to 34 alphanumeric characters). Example: IE12BOFI90000112345678.
vat_number: VAT identification number (starts with country code, 2-13 characters). Example: CZ1234567890.

Number subtypes:

null: Plain number
integer: Whole number. Example: 10.0 → 10.
rate: Typically in range of 0-100%. Example: 10% → 10, 15,00 → 15.
amount: Financial notation (parenthesis for negative values). Example: (100) → -100, $10.5 → 10.5, ▲10 → -10.

Date subtypes:

null: Plain date
period_begin: Beginning of date period (fallback to first day of month)
period_end: End of date period (fallback to last day of month)

pre_trained_field_id

string | null

Pre-trained field identifier for common document elements. See the pre_trained_fields endpoint for available values.

tabular

boolean

Whether the field belongs to a multivalue row. Default is false. Must be in sync with all assigned schemas - tabular = true means that the field is a child of tabular multivalue.

Default: false

multiline

"true" | "false"

Multiline configuration. Allowed values are:

true: Field's parent is of type tuple
false: Header field

Response

201Created

Created

Attribute

Type

Description

id*

read-only

integer

Engine Field object ID.

url*

read-only

URL

Engine Field object URL.

engine*

URL

Engine object URL.

name*

string

Name of the field. Only numbers, characters and underscores are allowed. The value must be unique across all fields for given engine.

label*

string

Human readable name of the field.

type*

"string" | "number" | "date" | "enum"

Type of the field.

subtype*

string | null

Subtype for more specific field validation. Possible values depend on the field type:

String subtypes:

null: Plain text without any constraints
alphanumeric: Only characters a-z, A-Z, and 0-9 (whitespace stripped). Example: A 123b → A123b.
numeric: Only numbers (whitespace stripped, useful for leading zeros). Example: 01 23 → 0123.
country_code: Two or three-letter country code (ISO 3166). Example: CZ or CZE.
currency_code: Three-letter currency code (ISO 4217). Example: USD.
iban: International Bank Account Number (up to 34 alphanumeric characters). Example: IE12BOFI90000112345678.
vat_number: VAT identification number (starts with country code, 2-13 characters). Example: CZ1234567890.

Number subtypes:

null: Plain number
integer: Whole number. Example: 10.0 → 10.
rate: Typically in range of 0-100%. Example: 10% → 10, 15,00 → 15.
amount: Financial notation (parenthesis for negative values). Example: (100) → -100, $10.5 → 10.5, ▲10 → -10.

Date subtypes:

null: Plain date
period_begin: Beginning of date period (fallback to first day of month)
period_end: End of date period (fallback to last day of month)

pre_trained_field_id*

string | null

Pre-trained field identifier for common document elements. See the pre_trained_fields endpoint for available values.

tabular*

boolean

Whether the field belongs to a multivalue row. Default is false. Must be in sync with all assigned schemas - tabular = true means that the field is a child of tabular multivalue.

Default: false

multiline*

"true" | "false"

Multiline configuration. Allowed values are:

true: Field's parent is of type tuple
false: Header field

400Bad Request

Invalid input data.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

401Unauthorized

The username/password is invalid or token is invalid (e.g. expired).

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

403Forbidden

Insufficient permission, missing authentication, invalid CSRF token and similar issue.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

404Not Found

The specified resource was not found.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

409Conflict

Conflict

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

413

Payload too large (especially for files uploaded).

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

429Too Many Requests

Request rate is too high, wait before sending more requests. See Rate Limiting for more details.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

url

read-only

string

Link to the rate limiting documentation

500Internal Server Error

Server failure while processing the request.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

502Bad Gateway

Invalid response from the upstream server.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

503Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

504

Upstream server could not complete the request in time.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

Retrieve engine field

Retrieve an engine field object.

curl -X GET "https://example.rossum.app/api/v1/engine_fields/123"

curl -X GET "https://example.rossum.app/api/v1/engine_fields/123"

Example response showing a document ID field configuration.

{
  "id": 3,
  "url": "https://example.rossum.app/api/v1/engine_fields/3",
  "engine": "https://example.rossum.app/api/v1/engines/8",
  "name": "document_id",
  "label": "DocumentID",
  "type": "string",
  "subtype": "string",
  "pre_trained_field_id": "document_id",
  "tabular": false,
  "multiline": "false"
}

{
  "detail": "Bad Request.",
  "code": "bad_request"
}

{
  "detail": "Invalid token.",
  "code": "authentication_failed"
}

{
  "detail": "Access to the requested resource is forbidden.",
  "code": "access_forbidden"
}

{
  "detail": "Not found.",
  "code": "not_found"
}

{
  "detail": "Request was rate limited.",
  "code": "rate_limited",
  "url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}

{
  "detail": "Server error.",
  "code": "error"
}

{
  "detail": "Bad Gateway.",
  "code": "bad_gateway"
}

{
  "detail": "Service Unavailable.",
  "code": "service_unavailable"
}

{
  "detail": "Gateway timeout.",
  "code": "gateway_timeout"
}

Response

200OK

Attribute

Type

Description

id*

read-only

integer

Engine Field object ID.

url*

read-only

URL

Engine Field object URL.

engine*

URL

Engine object URL.

name*

string

Name of the field. Only numbers, characters and underscores are allowed. The value must be unique across all fields for given engine.

label*

string

Human readable name of the field.

type*

"string" | "number" | "date" | "enum"

Type of the field.

subtype*

string | null

Subtype for more specific field validation. Possible values depend on the field type:

String subtypes:

null: Plain text without any constraints
alphanumeric: Only characters a-z, A-Z, and 0-9 (whitespace stripped). Example: A 123b → A123b.
numeric: Only numbers (whitespace stripped, useful for leading zeros). Example: 01 23 → 0123.
country_code: Two or three-letter country code (ISO 3166). Example: CZ or CZE.
currency_code: Three-letter currency code (ISO 4217). Example: USD.
iban: International Bank Account Number (up to 34 alphanumeric characters). Example: IE12BOFI90000112345678.
vat_number: VAT identification number (starts with country code, 2-13 characters). Example: CZ1234567890.

Number subtypes:

null: Plain number
integer: Whole number. Example: 10.0 → 10.
rate: Typically in range of 0-100%. Example: 10% → 10, 15,00 → 15.
amount: Financial notation (parenthesis for negative values). Example: (100) → -100, $10.5 → 10.5, ▲10 → -10.

Date subtypes:

null: Plain date
period_begin: Beginning of date period (fallback to first day of month)
period_end: End of date period (fallback to last day of month)

pre_trained_field_id*

string | null

Pre-trained field identifier for common document elements. See the pre_trained_fields endpoint for available values.

tabular*

boolean

Whether the field belongs to a multivalue row. Default is false. Must be in sync with all assigned schemas - tabular = true means that the field is a child of tabular multivalue.

Default: false

multiline*

"true" | "false"

Multiline configuration. Allowed values are:

true: Field's parent is of type tuple
false: Header field

400Bad Request

Invalid input data.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

401Unauthorized

The username/password is invalid or token is invalid (e.g. expired).

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

403Forbidden

Insufficient permission, missing authentication, invalid CSRF token and similar issue.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

404Not Found

The specified resource was not found.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

429Too Many Requests

Request rate is too high, wait before sending more requests. See Rate Limiting for more details.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

url

read-only

string

Link to the rate limiting documentation

500Internal Server Error

Server failure while processing the request.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

502Bad Gateway

Invalid response from the upstream server.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

503Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

504

Upstream server could not complete the request in time.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

Partial update engine field

Update part of an engine field object.

curl -X PATCH "https://example.rossum.app/api/v1/engine_fields/123" \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Invoice ID"
  }'

curl -X PATCH "https://example.rossum.app/api/v1/engine_fields/123" \  -H "Content-Type: application/json" \  -d '{    "label": "Invoice ID"  }'

Response after successfully patching the engine field label.

{
  "id": 3,
  "url": "https://example.rossum.app/api/v1/engine_fields/3",
  "engine": "https://example.rossum.app/api/v1/engines/8",
  "name": "document_id",
  "label": "Invoice ID",
  "type": "string",
  "subtype": "string",
  "pre_trained_field_id": "document_id",
  "tabular": false,
  "multiline": "false"
}

{
  "detail": "Bad Request.",
  "code": "bad_request"
}

{
  "detail": "Invalid token.",
  "code": "authentication_failed"
}

{
  "detail": "Access to the requested resource is forbidden.",
  "code": "access_forbidden"
}

{
  "detail": "Not found.",
  "code": "not_found"
}

{
  "detail": "Conflict.",
  "code": "conflict_status"
}

{
  "detail": "Payload Too Large.",
  "code": "payload_too_large"
}

{
  "detail": "Request was rate limited.",
  "code": "rate_limited",
  "url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}

{
  "detail": "Server error.",
  "code": "error"
}

{
  "detail": "Bad Gateway.",
  "code": "bad_gateway"
}

{
  "detail": "Service Unavailable.",
  "code": "service_unavailable"
}

{
  "detail": "Gateway timeout.",
  "code": "gateway_timeout"
}

Request Body

application/json

Attribute

Type

Description

engine

URL

Engine object URL.

name

string

Name of the field. Only numbers, characters and underscores are allowed. The value must be unique across all fields for given engine.

label

string

Human readable name of the field.

type

"string" | "number" | "date" | "enum"

Type of the field.

subtype

string | null

Subtype for more specific field validation. Possible values depend on the field type:

String subtypes:

null: Plain text without any constraints
alphanumeric: Only characters a-z, A-Z, and 0-9 (whitespace stripped). Example: A 123b → A123b.
numeric: Only numbers (whitespace stripped, useful for leading zeros). Example: 01 23 → 0123.
country_code: Two or three-letter country code (ISO 3166). Example: CZ or CZE.
currency_code: Three-letter currency code (ISO 4217). Example: USD.
iban: International Bank Account Number (up to 34 alphanumeric characters). Example: IE12BOFI90000112345678.
vat_number: VAT identification number (starts with country code, 2-13 characters). Example: CZ1234567890.

Number subtypes:

null: Plain number
integer: Whole number. Example: 10.0 → 10.
rate: Typically in range of 0-100%. Example: 10% → 10, 15,00 → 15.
amount: Financial notation (parenthesis for negative values). Example: (100) → -100, $10.5 → 10.5, ▲10 → -10.

Date subtypes:

null: Plain date
period_begin: Beginning of date period (fallback to first day of month)
period_end: End of date period (fallback to last day of month)

pre_trained_field_id

string | null

Pre-trained field identifier for common document elements. See the pre_trained_fields endpoint for available values.

tabular

boolean

Whether the field belongs to a multivalue row. Default is false. Must be in sync with all assigned schemas - tabular = true means that the field is a child of tabular multivalue.

Default: false

multiline

"true" | "false"

Multiline configuration. Allowed values are:

true: Field's parent is of type tuple
false: Header field

Response

200OK

Attribute

Type

Description

id*

read-only

integer

Engine Field object ID.

url*

read-only

URL

Engine Field object URL.

engine*

URL

Engine object URL.

name*

string

Name of the field. Only numbers, characters and underscores are allowed. The value must be unique across all fields for given engine.

label*

string

Human readable name of the field.

type*

"string" | "number" | "date" | "enum"

Type of the field.

subtype*

string | null

Subtype for more specific field validation. Possible values depend on the field type:

String subtypes:

null: Plain text without any constraints
alphanumeric: Only characters a-z, A-Z, and 0-9 (whitespace stripped). Example: A 123b → A123b.
numeric: Only numbers (whitespace stripped, useful for leading zeros). Example: 01 23 → 0123.
country_code: Two or three-letter country code (ISO 3166). Example: CZ or CZE.
currency_code: Three-letter currency code (ISO 4217). Example: USD.
iban: International Bank Account Number (up to 34 alphanumeric characters). Example: IE12BOFI90000112345678.
vat_number: VAT identification number (starts with country code, 2-13 characters). Example: CZ1234567890.

Number subtypes:

null: Plain number
integer: Whole number. Example: 10.0 → 10.
rate: Typically in range of 0-100%. Example: 10% → 10, 15,00 → 15.
amount: Financial notation (parenthesis for negative values). Example: (100) → -100, $10.5 → 10.5, ▲10 → -10.

Date subtypes:

null: Plain date
period_begin: Beginning of date period (fallback to first day of month)
period_end: End of date period (fallback to last day of month)

pre_trained_field_id*

string | null

Pre-trained field identifier for common document elements. See the pre_trained_fields endpoint for available values.

tabular*

boolean

Whether the field belongs to a multivalue row. Default is false. Must be in sync with all assigned schemas - tabular = true means that the field is a child of tabular multivalue.

Default: false

multiline*

"true" | "false"

Multiline configuration. Allowed values are:

true: Field's parent is of type tuple
false: Header field

400Bad Request

Invalid input data.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

401Unauthorized

The username/password is invalid or token is invalid (e.g. expired).

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

403Forbidden

Insufficient permission, missing authentication, invalid CSRF token and similar issue.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

404Not Found

The specified resource was not found.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

409Conflict

Conflict

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

413

Payload too large (especially for files uploaded).

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

429Too Many Requests

Request rate is too high, wait before sending more requests. See Rate Limiting for more details.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

url

read-only

string

Link to the rate limiting documentation

500Internal Server Error

Server failure while processing the request.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

502Bad Gateway

Invalid response from the upstream server.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

503Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

504

Upstream server could not complete the request in time.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

Delete engine field

Delete engine field object.

curl -X DELETE "https://example.rossum.app/api/v1/engine_fields/123"

curl -X DELETE "https://example.rossum.app/api/v1/engine_fields/123"

Empty

{
  "detail": "Bad Request.",
  "code": "bad_request"
}

{
  "detail": "Invalid token.",
  "code": "authentication_failed"
}

{
  "detail": "Access to the requested resource is forbidden.",
  "code": "access_forbidden"
}

{
  "detail": "Not found.",
  "code": "not_found"
}

{
  "detail": "Conflict.",
  "code": "conflict_status"
}

{
  "detail": "Request was rate limited.",
  "code": "rate_limited",
  "url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}

{
  "detail": "Server error.",
  "code": "error"
}

{
  "detail": "Bad Gateway.",
  "code": "bad_gateway"
}

{
  "detail": "Service Unavailable.",
  "code": "service_unavailable"
}

{
  "detail": "Gateway timeout.",
  "code": "gateway_timeout"
}

Response

204No Content

No Content

No response body.

400Bad Request

Invalid input data.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

401Unauthorized

The username/password is invalid or token is invalid (e.g. expired).

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

403Forbidden

Insufficient permission, missing authentication, invalid CSRF token and similar issue.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

404Not Found

The specified resource was not found.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

409Conflict

Conflict

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

429Too Many Requests

Request rate is too high, wait before sending more requests. See Rate Limiting for more details.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

url

read-only

string

Link to the rate limiting documentation

500Internal Server Error

Server failure while processing the request.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

502Bad Gateway

Invalid response from the upstream server.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

503Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

504

Upstream server could not complete the request in time.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

Update engine field

Update engine field object.

curl -X PUT "https://example.rossum.app/api/v1/engine_fields/123" \
  -H "Content-Type: application/json" \
  -d '{
    "engine": "https://example.rossum.app/api/v1/engines/8",
    "name": "document_id",
    "label": "Invoice Number",
    "type": "string",
    "subtype": "alphanumeric",
    "pre_trained_field_id": "document_id",
    "tabular": false,
    "multiline": "false"
  }'

curl -X PUT "https://example.rossum.app/api/v1/engine_fields/123" \  -H "Content-Type: application/json" \  -d '{    "engine": "https://example.rossum.app/api/v1/engines/8",    "name": "document_id",    "label": "Invoice Number",    "type": "string",    "subtype": "alphanumeric",    "pre_trained_field_id": "document_id",    "tabular": false,    "multiline": "false"  }'

Response after successfully updating the engine field.

{
  "id": 3,
  "url": "https://example.rossum.app/api/v1/engine_fields/3",
  "engine": "https://example.rossum.app/api/v1/engines/8",
  "name": "document_id",
  "label": "Invoice Number",
  "type": "string",
  "subtype": "alphanumeric",
  "pre_trained_field_id": "document_id",
  "tabular": false,
  "multiline": "false"
}

{
  "detail": "Bad Request.",
  "code": "bad_request"
}

{
  "detail": "Invalid token.",
  "code": "authentication_failed"
}

{
  "detail": "Access to the requested resource is forbidden.",
  "code": "access_forbidden"
}

{
  "detail": "Not found.",
  "code": "not_found"
}

{
  "detail": "Conflict.",
  "code": "conflict_status"
}

{
  "detail": "Payload Too Large.",
  "code": "payload_too_large"
}

{
  "detail": "Request was rate limited.",
  "code": "rate_limited",
  "url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}

{
  "detail": "Server error.",
  "code": "error"
}

{
  "detail": "Bad Gateway.",
  "code": "bad_gateway"
}

{
  "detail": "Service Unavailable.",
  "code": "service_unavailable"
}

{
  "detail": "Gateway timeout.",
  "code": "gateway_timeout"
}

Request Body

application/json

Attribute

Type

Description

engine*

URL

Engine object URL.

name*

string

Name of the field. Only numbers, characters and underscores are allowed. The value must be unique across all fields for given engine.

label*

string

Human readable name of the field.

type*

"string" | "number" | "date" | "enum"

Type of the field.

subtype

string | null

Subtype for more specific field validation. Possible values depend on the field type:

String subtypes:

null: Plain text without any constraints
alphanumeric: Only characters a-z, A-Z, and 0-9 (whitespace stripped). Example: A 123b → A123b.
numeric: Only numbers (whitespace stripped, useful for leading zeros). Example: 01 23 → 0123.
country_code: Two or three-letter country code (ISO 3166). Example: CZ or CZE.
currency_code: Three-letter currency code (ISO 4217). Example: USD.
iban: International Bank Account Number (up to 34 alphanumeric characters). Example: IE12BOFI90000112345678.
vat_number: VAT identification number (starts with country code, 2-13 characters). Example: CZ1234567890.

Number subtypes:

null: Plain number
integer: Whole number. Example: 10.0 → 10.
rate: Typically in range of 0-100%. Example: 10% → 10, 15,00 → 15.
amount: Financial notation (parenthesis for negative values). Example: (100) → -100, $10.5 → 10.5, ▲10 → -10.

Date subtypes:

null: Plain date
period_begin: Beginning of date period (fallback to first day of month)
period_end: End of date period (fallback to last day of month)

pre_trained_field_id

string | null

Pre-trained field identifier for common document elements. See the pre_trained_fields endpoint for available values.

tabular

boolean

Whether the field belongs to a multivalue row. Default is false. Must be in sync with all assigned schemas - tabular = true means that the field is a child of tabular multivalue.

Default: false

multiline

"true" | "false"

Multiline configuration. Allowed values are:

true: Field's parent is of type tuple
false: Header field

Response

200OK

Attribute

Type

Description

id*

read-only

integer

Engine Field object ID.

url*

read-only

URL

Engine Field object URL.

engine*

URL

Engine object URL.

name*

string

Name of the field. Only numbers, characters and underscores are allowed. The value must be unique across all fields for given engine.

label*

string

Human readable name of the field.

type*

"string" | "number" | "date" | "enum"

Type of the field.

subtype*

string | null

Subtype for more specific field validation. Possible values depend on the field type:

String subtypes:

null: Plain text without any constraints
alphanumeric: Only characters a-z, A-Z, and 0-9 (whitespace stripped). Example: A 123b → A123b.
numeric: Only numbers (whitespace stripped, useful for leading zeros). Example: 01 23 → 0123.
country_code: Two or three-letter country code (ISO 3166). Example: CZ or CZE.
currency_code: Three-letter currency code (ISO 4217). Example: USD.
iban: International Bank Account Number (up to 34 alphanumeric characters). Example: IE12BOFI90000112345678.
vat_number: VAT identification number (starts with country code, 2-13 characters). Example: CZ1234567890.

Number subtypes:

null: Plain number
integer: Whole number. Example: 10.0 → 10.
rate: Typically in range of 0-100%. Example: 10% → 10, 15,00 → 15.
amount: Financial notation (parenthesis for negative values). Example: (100) → -100, $10.5 → 10.5, ▲10 → -10.

Date subtypes:

null: Plain date
period_begin: Beginning of date period (fallback to first day of month)
period_end: End of date period (fallback to last day of month)

pre_trained_field_id*

string | null

Pre-trained field identifier for common document elements. See the pre_trained_fields endpoint for available values.

tabular*

boolean

Whether the field belongs to a multivalue row. Default is false. Must be in sync with all assigned schemas - tabular = true means that the field is a child of tabular multivalue.

Default: false

multiline*

"true" | "false"

Multiline configuration. Allowed values are:

true: Field's parent is of type tuple
false: Header field

400Bad Request

Invalid input data.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

401Unauthorized

The username/password is invalid or token is invalid (e.g. expired).

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

403Forbidden

Insufficient permission, missing authentication, invalid CSRF token and similar issue.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

404Not Found

The specified resource was not found.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

409Conflict

Conflict

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

413

Payload too large (especially for files uploaded).

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

429Too Many Requests

Request rate is too high, wait before sending more requests. See Rate Limiting for more details.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

url

read-only

string

Link to the rate limiting documentation

500Internal Server Error

Server failure while processing the request.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

502Bad Gateway

Invalid response from the upstream server.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

503Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

504

Upstream server could not complete the request in time.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

List pre-trained fields

Get list of possible pre_trained_field_id fields that can be used when creating engine fields. The available fields depend on the engine_use_case query parameter.

generic_ap (default)

name	label	type	subtype	tabular	description
account_num	Bank Account	string	alphanumeric	False	Bank account number. Whitespaces are stripped.
bank_num	Sort Code	string	alphanumeric	False	Sort code. Numerical code of the bank.
iban	IBAN	string	iban	False	Bank account number in IBAN format.
bic	BIC/SWIFT	string	alphanumeric	False	Bank BIC or SWIFT code.
const_sym	Constant Symbol	string	alphanumeric	False	Statistical code on payment order.
spec_sym	Specific Symbol	string	alphanumeric	False	Payee id on the payment order, or similar.
var_sym	Variable symbol	string	numeric	False	In some countries used by the supplier to match the payment received against the invoice. Possible non-numeric characters are stripped.
terms	Terms	string		False	Payment terms as written on the document (e.g. "45 days", "upon receipt").
payment_method	Payment method	string		False	Payment method defined on a document (e.g. 'Cheque', 'Pay order', 'Before delivery')
customer_id	Customer Number	string	alphanumeric	False	The number by which the customer is registered in the system of the supplier. Whitespaces are stripped.
date_due	Date Due	date	period_end	False	The due date of the invoice.
date_issue	Issue Date	date	period_begin	False	Date of issue of the document.
date_uzp	Tax Point Date	date	period_end	False	The date of taxable event.
document_id	Document Identifier	string	alphanumeric	False	Document number. Whitespaces are stripped.
order_id	Order Number	string	alphanumeric	False	Purchase order identification (Order Numbers not captured as "sender_order_id"). Whitespaces are stripped.
recipient_address	Recipient Address	string		False	Address of the customer.
recipient_dic	Recipient Tax Number	string	vat_number	False	Tax identification number of the customer. Whitespaces are stripped.
recipient_ic	Recipient Company ID	string	vat_number	False	Company identification number of the customer. Possible non-numeric characters are stripped.
recipient_name	Recipient Name	string		False	Name of the customer.
recipient_vat_id	Recipient VAT Number	string	vat_number	False	Customer VAT Number
recipient_delivery_name	Recipient Delivery Name	string		False	Name of the recipient to whom the goods will be delivered.
recipient_delivery_address	Recipient Delivery Address	string		False	Address of the recipient where the goods will be delivered.
sender_address	Supplier Address	string		False	Address of the supplier.
sender_dic	Supplier Tax Number	string	vat_number	False	Tax identification number of the supplier. Whitespaces are stripped.
sender_ic	Supplier Company ID	string	vat_number	False	Business/organization identification number of the supplier. Possible non-numeric characters are stripped.
sender_name	Supplier Name	string		False	Name of the supplier.
sender_vat_id	Supplier VAT Number	string	vat_number	False	VAT identification number of the supplier.
sender_email	Supplier Email	string		False	Email of the sender.
sender_order_id	Supplier's Order ID	string		False	Internal order ID in the suppliers system.
delivery_note_id	Delivery Note ID	string		False	Delivery note ID defined on the invoice.
supply_place	Place of Supply	string		False	Place of supply (the name of the city or state where the goods will be supplied).
currency	Currency	enum		False	The currency which the invoice is to be paid in. Possible values: CZK, DKK, EUR, GBP, NOK, SEK, HUF, USD, AUD, INR, CHF, CNY, JPY, PLN, RON, RUB or other. May be also in lowercase.
document_type	Document Type	enum		False	Possible values: credit_note, debit_note, tax_invoice (most typical), proforma, receipt, delivery_note, order or other.
language	Language	enum		False	The language which the document was written in. Values are ISO 639-3 language codes, e.g.: eng, fra, deu, zho. See Languages Supported By Rossum
payment_method_type	Payment Method Type	enum		False	Payment method used for the transaction. Possible values: card, cash.
amount_due	Amount Due	number	amount	False	Final amount including tax to be paid after deducting all discounts and advances.
amount_rounding	Amount Rounding	number	amount	False	Remainder after rounding amount_total.
amount_total	Total Amount	number	amount	False	Subtotal over all items, including tax.
amount_paid	Amount paid	number	amount	False	Amount paid already.
amount_total_base	Tax Base Total	number	amount	False	Base amount for tax calculation.
amount_total_tax	Tax Total	number	amount	False	Total tax amount.
tax_detail_base	Tax Base	number	amount	True	Sum of tax bases for items with the same tax rate.
tax_detail_rate	Tax Rate	number	rate	True	One of the tax rates in the tax breakdown.
tax_detail_tax	Tax Amount	number	amount	True	Sum of taxes for items with the same tax rate.
tax_detail_total	Tax Total	number	amount	True	Total amount including tax for all items with the same tax rate.
tax_detail_code	Tax Code	string	alphanumeric	True	Text on document describing tax code of the tax rate (e.g. 'GST', 'CGST', 'DPH', 'TVA'). If multiple tax rates belong to one tax code on the document, the tax code will be assigned only to the first tax rate. (in future such tax code will be distributed to all matching tax rates.)
table_column_code	Item Code/ID	string	alphanumeric	True	Can be the SKU, EAN, a custom code (string of letters/numbers) or even just the line number.
table_column_description	Item Description	string		True	Line item description. Can be multi-line with details.
table_column_quantity	Item Quantity	number		True	Quantity of the item.
table_column_uom	Item Unit of Measure	string		True	Unit of measure of the item (kg, container, piece, gallon, ...).
table_column_rate	Item Rate	number	rate	True	Tax rate for the line item.
table_column_tax	Item Tax	number	amount	True	Tax amount for the line. Rule of thumb: tax = rate * amount_base.
table_column_amount_base	Amount Base	number	amount	True	Unit price without tax. (This is the primary unit price extracted.)
table_column_amount	Amount	number	amount	True	Unit price with tax. Rule of thumb: amount = amount_base + tax.
table_column_amount_total_base	Amount Total Base	number	amount	True	The total amount to be paid for all the items excluding the tax. Rule of thumb: amount_total_base = amount_base * quantity.
table_column_amount_total	Amount Total	number	amount	True	The total amount to be paid for all the items including the tax. Rule of thumb: amount_total = amount * quantity.
table_column_other	Other	string		True	Unrecognized data type.
barcode_qrcode	QR Code	string		False
barcode_ean2	EAN-2	string		False
barcode_ean5	EAN-5	string		False
barcode_ean8	EAN-8	string		False
barcode_ean13	EAN-13	string		False
barcode_code39	Code 39	string		False
barcode_code93	Code 93	string		False
barcode_code128	Code 128	string		False
barcode_isbn10	ISBN-10	string		False
barcode_isbn13	ISBN-13	string		False
barcode_upca	UPC-A	string		False
barcode_upce	UPC-E	string		False
barcode_databar	DataBar	string		False
barcode_databar_exp	DataBar Expanded	string		False
barcode_codabar	Codabar	string		False
barcode_pdf417	PDF417	string		False
barcode_sqcode	SQCode	string		False
barcode_i25	Interleaved 2 of 5	string		False

coupa_header_level

name	label	type	subtype	tabular	description
document_type	Document Type	enum		False	Possible values: credit_note, debit_note, tax_invoice (most typical), proforma, receipt, delivery_note, order or other.
document_id	Invoice Number	string	alphanumeric	False	The ID of the document.
date_issue	Invoice Date	date	period_begin	False	Date of issue of the document.
date_due	Due Date	date	period_end	False	The due date of the invoice.
terms	Payment Terms	string		False	Payment terms as written on the document (eg. "45 days", "upon receipt").
recipient_name	Customer Name	string		False	Name of the customer.
recipient_address	Customer Address	string		False	Address of the customer.
recipient_vat_id	Customer Tax Number	string	vat_number	False	Customer VAT Number
sender_name	Supplier Name	string		False	Name of the supplier.
sender_address	Supplier Address	string		False	Address of the supplier.
sender_vat_id	Supplier Tax Number	string	vat_number	False	VAT identification number of the supplier.
sender_remit_to_address	Supplier Remit to Address	string		False
iban	IBAN	string	iban	False	Bank account number in IBAN format.
bic	BIC/SWIFT	string	alphanumeric	False	Bank BIC or SWIFT code.
account_num	Account Number	string	alphanumeric	False	Bank account number.
bank_num	Bank Code	string	alphanumeric	False	Sort code. Numerical code of the bank.
original_document_id	Original Invoice Number	string		False
original_date_issue	Original Invoice Date	date		False
amount_total_base	Subtotal	number	amount	False	Base amount for tax calculation.
amount_total_tax	Tax Amount	number	amount	False	Total tax amount.
shipping_charge	Charges	number		False
amount_total	Amount Due	number	amount	False	Subtotal over all items, including tax.
currency	Currency	enum		False	The currency which the invoice is to be paid in. Possible values: CZK, DKK, EUR, GBP, NOK, SEK, HUF, USD, AUD, INR, CHF, CNY, JPY, PLN, RON, RUB or other. May be also in lowercase.
order_id	PO Number	string	alphanumeric	False	Purchase order identification.
contract_number	Contract Number	string		False
service_period	Service Period	string		False
sp_date_start	Service Period Start	date		False
sp_date_end	Service Period End	date		False
table_column_description	Description	string		True	Line item description. Can be multi-line with details.
table_column_quantity	Quantity	number		True	Quantity of the item.
table_column_amount_base	Unit Price Net	number		True	Unit price without tax.
table_column_total_base	Total Net	number		True
table_column_order_id	PO Number	string		True
table_column_code	Supplier Part Number	string		True	Can be the SKU, EAN, a custom code (string of letters/numbers) or even just the line number.
service_period_item_start	Service Period Item Start	date		True
service_period_item_end	Service Period Item End	date		True
service_period_item	Service Period Item	string		True

coupa_line_level

name	label	type	subtype	tabular	description
document_type	Document Type	enum		False	Possible values: credit_note, debit_note, tax_invoice (most typical), proforma, receipt, delivery_note, order or other.
document_id	Invoice Number	string	alphanumeric	False	The ID of the document.
date_issue	Invoice Date	date	period_begin	False	Date of issue of the document.
date_due	Due Date	date	period_end	False	The due date of the invoice.
terms	Payment Terms	string		False	Payment terms as written on the document (eg. "45 days", "upon receipt").
recipient_name	Customer Name	string		False	Name of the customer.
recipient_address	Customer Address	string		False	Address of the customer.
recipient_vat_id	Customer Tax Number	string	vat_number	False	Customer VAT Number
sender_name	Supplier Name	string		False	Name of the supplier.
sender_address	Supplier Address	string		False	Address of the supplier.
sender_vat_id	Supplier Tax Number	string	vat_number	False	VAT identification number of the supplier.
sender_remit_to_address	Supplier Remit to Address	string		False
iban	IBAN	string	iban	False	Bank account number in IBAN format.
bic	BIC/SWIFT	string	alphanumeric	False	Bank BIC or SWIFT code.
account_num	Account Number	string	alphanumeric	False	Bank account number.
bank_num	Bank Code	string	alphanumeric	False	Sort code. Numerical code of the bank.
original_document_id	Original Invoice Number	string		False
original_date_issue	Original Invoice Date	date		False
amount_total_base	Total Without Tax	number	amount	False	Base amount for tax calculation.
amount_total_tax	Tax Amount	number	amount	False	Total tax amount.
tax_rate	Tax Rate	number		False
charge_description	Charge Description	string		True
charge_tax	Charge Tax Amount	number		True
charge_tax_rate	Charge Tax Rate	number		True
charge_amount	Charge Amount	number		True
amount_total	Amount Due	number	amount	False	Subtotal over all items, including tax.
currency	Currency	enum		False	The currency which the invoice is to be paid in. Possible values: CZK, DKK, EUR, GBP, NOK, SEK, HUF, USD, AUD, INR, CHF, CNY, JPY, PLN, RON, RUB or other. May be also in lowercase.
order_id	PO Number	string	alphanumeric	False	Purchase order identification.
contract_number	Contract Number	string		False
service_period	Service Period	string		False
sp_date_start	Service Period Start	date		False
sp_date_end	Service Period End	date		False
table_column_description	Description	string		True	Line item description. Can be multi-line with details.
table_column_quantity	Quantity	number		True	Quantity of the item.
table_column_amount_base	Unit Price Net	number		True	Unit price without tax.
table_column_amount_total_base	Total Net	number	amount	True	The total amount to be paid for all the items excluding the tax. Rule of thumb: amount_total_base = amount_base * quantity.
table_column_rate	Tax Rate	number	rate	True	Tax rate for the line item.
table_column_tax	Tax Amount	number	amount	True	Tax amount for the line. Rule of thumb: tax = rate * amount_base.
table_column_order_id	PO Number	string		True
table_column_code	Supplier Part Number	string	alphanumeric	True	Can be the SKU, EAN, a custom code (string of letters/numbers) or even just the line number.
service_period_item	Service Period Item	string		True
service_period_item_start	Service Period Item Start	date		True
service_period_item_end	Service Period Item End	date		True

curl -X GET "https://example.rossum.app/api/v1/engine_fields/pre_trained_fields"

curl -X GET "https://example.rossum.app/api/v1/engine_fields/pre_trained_fields"

{
  "results": [
    {
      "name": "account_num",
      "label": "Bank Account",
      "section": "Identifiers",
      "type": "string",
      "subtype": "alphanumeric",
      "tabular": false,
      "multiline": "false",
      "description": "Bank account number. Whitespaces are stripped."
    }
  ]
}

{
  "detail": "Bad Request.",
  "code": "bad_request"
}

{
  "detail": "Invalid token.",
  "code": "authentication_failed"
}

{
  "detail": "Access to the requested resource is forbidden.",
  "code": "access_forbidden"
}

{
  "detail": "Not found.",
  "code": "not_found"
}

{
  "detail": "Request was rate limited.",
  "code": "rate_limited",
  "url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}

{
  "detail": "Server error.",
  "code": "error"
}

{
  "detail": "Bad Gateway.",
  "code": "bad_gateway"
}

{
  "detail": "Service Unavailable.",
  "code": "service_unavailable"
}

{
  "detail": "Gateway timeout.",
  "code": "gateway_timeout"
}

Response

200OK

Attribute

Type

Description

results

list[pre_trained_field]

name

string

Pre-trained field identifier.

label

string

Human readable name of the pre-trained field.

section

string

Category section of the pre-trained field.

type

"string" | "number" | "date" | "enum"

Field type.

subtype

string | null

Field subtype for more specific validation.

tabular

boolean

Whether the field is designed for tabular data.

multiline

"true" | "false"

Multiline configuration.

description

string

Detailed description of the pre-trained field.

400Bad Request

Invalid input data.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

401Unauthorized

The username/password is invalid or token is invalid (e.g. expired).

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

403Forbidden

Insufficient permission, missing authentication, invalid CSRF token and similar issue.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

404Not Found

The specified resource was not found.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

429Too Many Requests

Request rate is too high, wait before sending more requests. See Rate Limiting for more details.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

url

read-only

string

Link to the rate limiting documentation

500Internal Server Error

Server failure while processing the request.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

502Bad Gateway

Invalid response from the upstream server.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

503Service Unavailable

We're temporarily offline for maintenance. Please try again later.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error

504

Upstream server could not complete the request in time.

Attribute

Type

Description

detail

read-only

string

Detail of the error

code

read-only

string

Code of the error