INDEX | FIELD NAME | DESCRIPTION |
3
unstructured
DATATYPE | |||
Invoice specific fields | |||
1 | invoice_number |
the invoice number
✅
2
structured
structured communication message
→ InvoiceID: A unique identification of the Invoice to uniquely identify the Invoice within the business context, time-frame, operating systems and records of the Seller. | string | ||
2 | invoice_date | → IssueDate: The date when the Invoice was issued. Format "YYYY-MM-DD" | date |
3 | due_date | → DueDate: The date when the payment is due.Format "YYYY-MM-DD" | date |
Amount fields | |||
4 | amount_payable |
payable amount (if not already paid)
→ PayableAmount: The outstanding amount that is requested to be paid. Must be rounded to maximum 2 decimals. | float |
5 | gross_amount |
gross amount (including tax)
→ TaxInclusiveAmount: The total amount of the Invoice with VAT. Must be rounded to maximum 2 decimals. | float |
6 | net_amount |
amount (excluding tax)
→ TaxExclusiveAmount: The total amount of the Invoice without VAT. Must be rounded to maximum 2 decimals. | float |
7 | tax_amount |
tax amount
→ TaxAmount: The total VAT amount for the Invoice or the VAT total amount expressed in the accounting currency accepted or required in the country of the Seller. Must be rounded to maximum 2 decimals | float | ||
8 | tax_rate | tax rate | integer |
9 | line_items_with_detail | more information on fields in Line items fields supported | table |
10 | receipt_lines | receipt line items (includes amount |
10
IBAN
IBAN
✅
11
BIC
BIC
12
bank_account
IBAN + unstructured bank account numbers
13
invoice_date
date of the invoice
✅
14
due_date
invoice due date
✅
: float, description: string, and quantity: integer) | table | ||
Payment fields | |||
11 | IBAN | → PayeeFinancialAccountID: A unique identifier of the financial payment account, at a payment service provider, to which payment should be made. Such as IBAN or BBAN | alphanumeric |
12 | sender_IBAN | the IBAN of the sender | alphanumeric |
13 | receiver_IBAN | the IBAN of the receiver | alphanumeric |
14 | BIC | BIC | alphanumeric |
15 | bank_account | IBAN + unstructured bank account numbers | alphanumeric |
16 | payment_terms | payment terms for payment due date | string |
17
receiver_name
name of the receiver of the invoice
✅
18
country
the country of the invoice
✅
19
currency
the currency of the invoice
20
language
the language of the document
17 |
sender_name
name of the sender of the invoice
✅
structured | → PaymentID: A textual value used to establish a link between the payment and the Invoice, issued by the Seller. Used for creditor's critical reconciliation information. This information element helps the Seller to assign an incoming payment to the relevant payment process. | alphanumeric | |
18 | unstructured | → PaymentID: unstructured communication message | alphanumeric |
Party fields | |||
19 | sender_name | → SellerPartyName: A name by which the Seller is known, other than Seller name (also known as Business name). | string |
20 | receiver_name | → BuyerPartyName: A name by which the Buyer is known, other than Buyer name (also known as Business name). | string |
21 | VAT_number | → VATID: ALL vat numbers |
alphanumeric | |
22 | sender_VAT |
vat number of the sender of the invoice
→ SellerVATID: The VAT identifier of the Seller's tax representative party. | alphanumeric | |
23 | receiver_VAT | → BuyerVATID: The Buyer's VAT |
vat of the receiver of the invoice
✅
identifier (also known as Buyer VAT identification number). | alphanumeric | ||
24 | sender_company_number | → SellerLegalID: An identifier issued by an official registrar that identifies the Seller as a legal entity or person. | alphanumeric |
25 | receiver_company_number | → BuyerLegalID: An identifier issued by an official registrar that identifies the Buyer as a legal entity or person. | alphanumeric |
26 | registered_sender_name |
registered name of the sender
✅
26
Siret
→ SellerRegistrationName: The full formal name by which the Seller is registered in the national registry of legal entities or as a Taxable person or otherwise trades as a person or persons. | string |
27 | registered_receiver_name |
registered name of the sender
✅
→ BuyerRegistrationName: The full name of the Buyer. | string | ||
28 | country | → SellerCountry: A code that identifies the country. | string |
29 | country | → BuyerCountry: A code that identifies the country. | string |
30 | Siret | → [ see LegalID ]: Specific company registration number for France |
alphanumeric | ||
31 | Siret_commercial_name | → [ see PartyName ]: Commercial name from French siret database |
alphanumeric | ||
32 | Siret_legal_name | → [ see RegistrationName ]: Legal name from French siret database |
alphanumeric | |||
33 | kvk_number | → [ see LegalID ]: specific company registration number for the Netherlands | alphanumeric |
Address fields |
31
city (sender/receiver)
address city
✅
32
number (sender/receiver)
address number
✅
33
street (sender/receiver)
address street
✅
34
zip (sender/receiver)
address zip
✅
34 |
company_number (sender/receiver)
company registration number (currently supports: vat, siret, kvk, BelgIan + Spanish company numbers)
✅
sender_address | The whole address of the sender | string | |
35 | receiver_address | The whole address of the receiver | string |
36 | sender_address_line_1 | → SellerStreetName: The main address line in an address. | string |
37 | receiver_address_line_1 | → BuyerStreetName: The main address line in an address. | string |
38 | sender_address_line_2 | The additional/optional address line of the sender | string |
39 | receiver_address_line_2 | The additional/optional address line of the sender | string |
40 | sender_post_code | → SellerPostalZone: The identifier for an addressable group of properties according to the relevant postal service. | string |
41 | receiver_post_code | → BuyerPostalZone: The identifier for an addressable group of properties according to the relevant postal service. | string |
42 | sender_city | → SellerCityName: The common name of the city, town or village, where the Seller address is located. | string |
43 | receiver_city | → BuyerCityName: The common name of the city, town or village, where the Buyer's address is located. | string |
Other fields | |||
44 | currency | the currency of the invoice | string |
45 | language | the language of the document | string |
46 | url | the website url | string |
47 | sender_url | string | |
48 | receiver_url | string | |
49 | email_address | email address |
string | ||
50 | sender_email | string |
51 | receiver_email | string |
52 | phone_number | phone number |
string |
53 |
sender_ |
fax number
38
url
the website url
39
translation
translation of the document in English
phone | string | ||
54 | receiver_phone | string | |
55 | fax_number | fax number | string |
56 | signature | signature detection |
string | |||
57 | barcode | barcode detection | string |
58 | handwritten_text | handwritten_text detection |
string | |||
59 | logo | logo detection | string |