Skip to content

Commit d641212

Browse files
Merge pull request #272692 from laujan/246472-update-invoice-extraction-data-fields
update fields
2 parents 5958001 + cce81c7 commit d641212

File tree

1 file changed

+51
-52
lines changed

1 file changed

+51
-52
lines changed

articles/ai-services/document-intelligence/concept-invoice.md

Lines changed: 51 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: laujan
66
manager: nitinme
77
ms.service: azure-ai-document-intelligence
88
ms.topic: conceptual
9-
ms.date: 02/29/2024
9+
ms.date: 04/18/2024
1010
ms.author: lajanuar
1111
ms.custom: references_regions
1212
---
@@ -188,63 +188,62 @@ See how data, including customer information, vendor details, and line items, is
188188
## Field extraction
189189

190190
|Name| Type | Description | Standardized output |
191-
|:-----|:----|:----|:---:|
192-
| CustomerName | String | Invoiced customer| |
193-
| CustomerId | String | Customer reference ID | |
194-
| PurchaseOrder | String | Purchase order reference number | |
195-
| InvoiceId | String | ID for this specific invoice (often "Invoice Number") | |
196-
| InvoiceDate | Date | Date the invoice was issued | yyyy-mm-dd|
197-
| DueDate | Date | Date payment for this invoice is due | yyyy-mm-dd|
198-
| VendorName | String | Vendor name | |
199-
| VendorTaxId | String | The taxpayer number associated with the vendor | |
200-
| VendorAddress | String | Vendor mailing address| |
201-
| VendorAddressRecipient | String | Name associated with the VendorAddress | |
202-
| CustomerAddress | String | Mailing address for the Customer | |
203-
| CustomerTaxId | String | The taxpayer number associated with the customer | |
204-
| CustomerAddressRecipient | String | Name associated with the CustomerAddress | |
205-
| BillingAddress | String | Explicit billing address for the customer | |
206-
| BillingAddressRecipient | String | Name associated with the BillingAddress | |
207-
| ShippingAddress | String | Explicit shipping address for the customer | |
208-
| ShippingAddressRecipient | String | Name associated with the ShippingAddress | |
209-
| PaymentTerm | String | The terms of payment for the invoice | |
210-
|Sub​Total| Number | Subtotal field identified on this invoice | Integer |
211-
| TotalTax | Number | Total tax field identified on this invoice | Integer |
212-
| InvoiceTotal | Number (USD) | Total new charges associated with this invoice | Integer |
213-
| AmountDue | Number (USD) | Total Amount Due to the vendor | Integer |
214-
| ServiceAddress | String | Explicit service address or property address for the customer | |
215-
| ServiceAddressRecipient | String | Name associated with the ServiceAddress | |
216-
| RemittanceAddress | String | Explicit remittance or payment address for the customer | |
217-
| RemittanceAddressRecipient | String | Name associated with the RemittanceAddress | |
218-
| ServiceStartDate | Date | First date for the service period (for example, a utility bill service period) | yyyy-mm-dd |
219-
| ServiceEndDate | Date | End date for the service period (for example, a utility bill service period) | yyyy-mm-dd|
220-
| PreviousUnpaidBalance | Number | Explicit previously unpaid balance | Integer |
221-
| CurrencyCode | String | The currency code associated with the extracted amount | |
222-
| KVKNumber(NL-only) | String | A unique identifier for businesses registered in the Netherlands|12345678|
223-
| PaymentDetails | Array | An array that holds Payment Option details such as `IBAN`,`SWIFT`, `BPay(AU)` | |
224-
| TotalDiscount | Number | The total discount applied to an invoice | Integer |
225-
| TaxItems | Array | AN array that holds added tax information such as `CGST`, `IGST`, and `SGST`. This line item is currently only available for the Germany (`de`), Spain (`es`), Portugal (`pt`), and English Canada (`en-CA`) locales| |
226-
227-
### Line items
191+
|:-----|:----|:----|:----|
192+
| CustomerName |string | Invoiced customer|Microsoft Corp|
193+
| CustomerId |string | Customer reference ID |CID-12345 |
194+
| PurchaseOrder |string | Purchase order reference number |PO-3333 |
195+
| InvoiceId |string | ID for this specific invoice (often Invoice Number) |INV-100 |
196+
| InvoiceDate |date |date the invoice was issued | mm-dd-yyyy|
197+
| DueDate |date |date payment for this invoice is due |mm-dd-yyyy|
198+
| VendorName |string | Vendor who created this invoice |CONTOSO LTD.|
199+
| VendorAddress |address| Vendor mailing address| 123 456th St, New York, NY 10001 |
200+
| VendorAddressRecipient |string | Name associated with the VendorAddress |Contoso Headquarters |
201+
| CustomerAddress |address | Mailing address for the Customer | 123 Other St, Redmond WA, 98052|
202+
| CustomerAddressRecipient |string | Name associated with the CustomerAddress |Microsoft Corp |
203+
| BillingAddress |address | Explicit billing address for the customer | 123 Bill St, Redmond WA, 98052 |
204+
| BillingAddressRecipient |string | Name associated with the BillingAddress |Microsoft Services |
205+
| ShippingAddress |address | Explicit shipping address for the customer | 123 Ship St, Redmond WA, 98052|
206+
| ShippingAddressRecipient |string | Name associated with the ShippingAddress |Microsoft Delivery |
207+
|Sub​Total| currency| Subtotal field identified on this invoice | $100.00 |
208+
| TotalDiscount | currency | The total discount applied to an invoice | $5.00 |
209+
| TotalTax | currency| Total tax field identified on this invoice | $10.00 |
210+
| InvoiceTotal | currency | Total new charges associated with this invoice | $10.00 |
211+
| AmountDue | currency | Total Amount Due to the vendor | $610 |
212+
| PreviousUnpaidBalance | currency| Explicit previously unpaid balance | $500.00 |
213+
| RemittanceAddress |address| Explicit remittance or payment address for the customer |123 Remit St New York, NY, 10001 |
214+
| RemittanceAddressRecipient |string | Name associated with the RemittanceAddress |Contoso Billing |
215+
| ServiceAddress |address | Explicit service address or property address for the customer |123 Service St, Redmond WA, 98052 |
216+
| ServiceAddressRecipient |string | Name associated with the ServiceAddress |Microsoft Services |
217+
| ServiceStartDate |date | First date for the service period (for example, a utility bill service period) | mm-dd-yyyy |
218+
| ServiceEndDate |date | End date for the service period (for example, a utility bill service period) | mm-dd-yyyy|
219+
| VendorTaxId |string | The taxpayer number associated with the vendor |123456-7 |
220+
|CustomerTaxId|string|The taxpayer number associated with the customer|765432-1|
221+
| PaymentTerm |string | The terms of payment for the invoice |Net90 |
222+
| KVKNumber |string | A unique identifier for businesses registered in the Netherlands (NL-only)|12345678|
223+
| CurrencyCode |string | The currency code associated with the extracted amount | |
224+
| PaymentDetails | array | An array that holds Payment Option details such as `IBAN`,`SWIFT`, `BPayBillerCode(AU)`, `BPayReference(AU)` | |
225+
|TaxDetails|array|An array that holds tax details like amount and rate||
226+
| TaxDetails | array | AN array that holds added tax information such as `CGST`, `IGST`, and `SGST`. This line item is currently only available for the Germany (`de`), Spain (`es`), Portugal (`pt`), and English Canada (`en-CA`) locales| |
227+
228+
### Line items array
228229

229230
Following are the line items extracted from an invoice in the JSON output response (the following output uses this [sample invoice](media/sample-invoice.jpg):
230231

231-
|Name| Type | Description | Text (line item #1) | Value (standardized output) |
232-
|:-----|:----|:----|:----| :----|
233-
| Items | String | Full string text line of the line item | 3/4/2021 A123 Consulting Services 2 hours $30.00 10% $60.00 | |
234-
| Amount | Number | The amount of the line item | $60.00 | 100 |
235-
| Description | String | The text description for the invoice line item | Consulting service | Consulting service |
236-
| Quantity | Number | The quantity for this invoice line item | 2 | 2 |
237-
| OrderQuantity | Number | The ordered quantity for this line item. May differ from the quantity shipped and invoiced | 3 | 3 |
238-
| UnitPrice | Number | The net or gross price (depending on the gross invoice setting of the invoice) of one unit of this item | $30.00 | 30 |
239-
| ProductCode | String| Product code, product number, or SKU associated with the specific line item | A123 | |
240-
| Unit | String| The unit of the line item, e.g, kg, lb etc. | Hours | |
241-
| Date | Date| Date corresponding to each line item. Often it's a date the line item was shipped | 3/4/2021| 2021-03-04 |
242-
| Tax | Number | Tax associated with each line item. Possible values include tax amount and tax Y/N | 10.00 | |
243-
| TaxRate | Number | Tax Rate associated with each line item. | 10% | |
232+
|Name| Type | Description | Value (standardized output) |
233+
|:-----|:----|:----|:----|
234+
| Amount | currency | The amount of the line item | $60.00 |
235+
| Date | date| Date corresponding to each line item. Often it's a date the line item was shipped | 3/4/2021|
236+
| Description | string | The text description for the invoice line item | Consulting service|
237+
| Quantity | number | The quantity for this invoice line item | 2 |
238+
| ProductCode | string| Product code, product number, or SKU associated with the specific line item | A123|
239+
| Tax | currency | Tax associated with each line item. Possible values include tax amount and tax Y/N | $6.00 |
240+
| TaxRate | string | Tax Rate associated with each line item. | 18%|
241+
| Unit | string| The unit of the line item, e.g, kg, lb etc. | Hours|
242+
| UnitPrice | number | The net or gross price (depending on the gross invoice setting of the invoice) of one unit of this item | $30.00 |
244243

245244
The invoice key-value pairs and line items extracted are in the `documentResults` section of the JSON output.
246245

247-
:::moniker range="<=doc-intel-3.1.0"
246+
:::moniker range=">=doc-intel-3.1.0"
248247

249248
### Key-value pairs
250249

0 commit comments

Comments
 (0)