Annotation31

Annotation Content9

Audit Log1

Automation Blocker2

Configuration Changelog1

Connector6

Dedicated Engine7

Dedicated Engine Schema8

Delete Recommendation6

Document7

Document Relation6

Documents Download3

Email7

Email Template7

Email Thread4

Engine9

Engine Field7

Generic Engine2

Generic Engine Schema2

Hook12

Hook Run3

Hook Template2

Inbox6

Integration Credential6

Label7

Membership6

Organization11

Organization Group14

Page2

Queue15

Relation6

Rule6

Rules Execution Log1

Saved View6

Schema8

Suggested Edit6

Task1

Trigger6

Upload3

User13

User Role2

Workflow2

Workflow Activity2

Workflow Run3

Workflow Step2

Workspace6

Engine Field

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 <a href="https://knowledge-base.rossum.ai/docs/languages-supported-by-rossum">Languages Supported By Rossum</a>
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

get/api/v1/engine_fields/pre_trained_fields

Query parameters

engine_use_case'generic_ap' | 'coupa_line_level' | 'coupa_header_level'

Filter pre-trained fields by engine use case. If not specified, returns fields for generic_ap.

Response

Example response

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

Changes

No recorded changes to this endpoint across all 1 revision of this API.