Migration from Capture API v1 to Document API v2
This page helps developers migrate existing integrations from the Blu Delta Capture API v1 to the new Document API v2.
It outlines the structural changes, field mappings, and recommended replacements for all key invoice fields.
Why this migration?
The Document API v2 introduces a modernized document model with unified naming, hierarchical grouping, and better consistency across document types.
Migrating ensures continued compatibility, enhanced recognition quality, and access to new features.
Field Mapping: Capture API v1 → Blu Doc
The table below lists how data fields from the legacy Invoice Capture API correspond to fields in the new Document API.
If a v1 field has no equivalent in v2 yet, the Blu Doc field column is left blank.
Mapping Table
| Capture API v1 Invoice Detail | Recommended Blu Doc Detail | Description |
|---|---|---|
| BankGroup.BankAccount | DocumentEssentials.BankAccount.Item.Account.Id | Bank account number (national). |
| BankGroup.BankCode | DocumentEssentials.BankAccount.Item.Bank.Id | Bank code (national). |
| Bic | DocumentEssentials.BankAccount.Item.Bank.Bic | Bank identifier code. |
| CompanyRegistrationNumber | Legal registration number of the supplier company (e.g., commercial register ID). | |
| CostCenter | Internal accounting or cost allocation reference. Often used by the buyer for bookkeeping. | |
| CustomerId | Customer identifier. | |
| DeliveryDate | DocumentEssentials.DeliveryDate.Item.Delivery.Date | Delivery date. |
| DeliveryNoteId | DocumentEssentials.DeliveryNote.Id | Delivery note identifier. |
| DeliveryPeriodGroup.DeliveryPeriodDateEnd | DocumentEssentials.DeliveryDate.Item.DeliveryPeriodEnd.Date | End date of the delivery period covered by the invoice. |
| DeliveryPeriodGroup.DeliveryPeriodDateStart | DocumentEssentials.DeliveryDate.Item.DeliveryPeriodStart.Date | Start date of the delivery period covered by the invoice. |
| DiscountGroup.DiscountDate | DocumentEssentials.Payment.Discount.Item.Due.Item.Due.Date | Date for discount eligibility. |
| DiscountGroup.DiscountDuration | DocumentEssentials.Payment.Discount.Item.Due.Item.Due.Duration | Time period for discount eligibility. |
| DiscountGroup.DiscountPercent | DocumentEssentials.Payment.Discount.Item.Discount.Item.Discount.Rate | Discount percentage for early payment. |
| DocumentType | DocumentEssentials.Invoice.Type | Type of the detected Invoice document. |
| DueDateGroup.DueDateDate | DocumentEssentials.Due.Item.Due.Date | Payment due date. |
| DueDateGroup.DueDateDuration | DocumentEssentials.Due.Item.Due.Duration | General payment term (duration). |
| GrandTotalAmount | DocumentEssentials.GrandTotal.Amount | Total amount including tax. |
| HAWBId | The HAWBId (House Air Waybill Identifier) represents the unique tracking number assigned to a House Air Waybill | |
| Iban | DocumentEssentials.BankAccount.Item.Bank.Iban | International bank account number. |
| InvoiceCurrency | DocumentEssentials.Currency | Currency used on the document. |
| InvoiceDate | DocumentEssentials.Invoice.Date | Date when the invoice was issued. |
| InvoiceId | DocumentEssentials.Invoice.Id | Unique invoice number. |
| IsrReference | Swiss inpayment slip reference number (used for matching payments). | |
| IsrSubscriber | Swiss ISR subscriber number identifying the payee account. | |
| KId | KID (Kundeidentifikasjon) number used in Norway for payment identification and reconciliation. | |
| LineItemTable.LineItems[].DeliveryDate | DocumentEssentials.Line.Item.DeliveryDate.Item.Delivery.Date | Delivery date of the line item. |
| LineItemTable.LineItems[].DeliveryId | DocumentEssentials.Line.Item.DeliveryNote.Id | Delivery reference of the line item. |
| LineItemTable.LineItems[].Description | DocumentEssentials.Line.Item.ArticleDescription.String | Line item description. |
| LineItemTable.LineItems[].Discount | DocumentEssentials.Line.Item.Discount.Item.Discount.Amount, DocumentEssentials.Line.Item.Discount.Item.Discount.Rate | Discount applied to the line item, as absolute amount or percentage. |
| LineItemTable.LineItems[].ItemId | DocumentEssentials.Line.Item.Article.Id | Idendifier of article number |
| LineItemTable.LineItems[].OrderId | DocumentEssentials.Line.Item.Order.Id | Order reference of the line item. |
| LineItemTable.LineItems[].PositionId | DocumentEssentials.Line.Item.Position.Id | Line item position identifier. |
| LineItemTable.LineItems[].PositionNumber | Sequential number for each predicted line item, starting at 1 | |
| LineItemTable.LineItems[].Quantity | DocumentEssentials.Line.Item.Quantity.Decimal | Line item quantity. |
| LineItemTable.LineItems[].TotalAmount | DocumentEssentials.Line.Item.Total.Amount | Total amount of the line item. |
| LineItemTable.LineItems[].Unit | DocumentEssentials.Line.Item.Unit.Type | Unit of measure. |
| LineItemTable.LineItems[].UnitPrice | DocumentEssentials.Line.Item.Unit.SmallAmount | Unit price of the line item. |
| LineItemTable.LineItems[].VatRate | DocumentEssentials.Line.Item.Vat.Rate | VAT rate percentage of the line item. |
| NetTotalAmount | Total amount before tax for all items and charges. | |
| PaymentReferenceId | Unique reference number used by the payer to ensure correct allocation of the payment to the corresponding invoice. | |
| Receiver.Address.City | DocumentEssentials.Receiver.Contact.Item.Contact.City | City name. |
| Receiver.Address.Country | DocumentEssentials.Receiver.Contact.Item.Contact.Country | Country. |
| Receiver.Address.Street | DocumentEssentials.Receiver.Contact.Item.Contact.Street | Street name and number. |
| Receiver.Address.ZipCode | DocumentEssentials.Receiver.Contact.Item.Contact.ZipCode | Postal code. |
| Receiver.Fax | Fax number of the receiver (if present on invoice). | |
| Receiver.Name | DocumentEssentials.Receiver.Contact.Item.Contact.Name | Legal or trade name of the receiving company or customer. |
| Receiver.Phone | DocumentEssentials.Receiver.Contact.Item.Contact.Phone | Phone number. |
| ReceiverOrderDate | DocumentEssentials.ReceiverOrder.Date | Date of the receiver's order. |
| ReceiverOrderId | DocumentEssentials.ReceiverOrder.Id | Order identifier from the receiver. |
| ReceiverTaxId | Receiver tax identifier. | |
| ReceiverVatId | DocumentEssentials.Receiver.VatId | Receiver VAT ID. |
| Sender | Legal or trade name of the sending company or customer. | |
| Sender.Address.City | DocumentEssentials.Sender.Contact.Item.Contact.City | City name. |
| Sender.Address.Country | DocumentEssentials.Sender.Contact.Item.Contact.Country | Country. |
| Sender.Address.Street | DocumentEssentials.Sender.Contact.Item.Contact.Street | Street name and number. |
| Sender.Address.ZipCode | DocumentEssentials.Sender.Contact.Item.Contact.ZipCode | Postal code. |
| Sender.Email | DocumentEssentials.Sender.Contact.Item.Contact.Email | Email address. |
| Sender.Fax | Fax number. | |
| Sender.Name | DocumentEssentials.Sender.Contact.Item.Contact.Name | Party/company name. |
| Sender.Phone | DocumentEssentials.Sender.Contact.Item.Contact.Phone | Phone number. |
| SenderOrderDate | Date of the sender's order. | |
| SenderOrderId | Identifier of the sender’s order. | |
| SenderTaxId | Tax number of the sender, used in some countries instead of VAT ID. | |
| SenderVatId | DocumentEssentials.Sender.VatId | Sender VAT ID. |
| TaxNumber | National tax number of the sender (used in Germany). See also SenderTaxId. | |
| TransportTourId | Unique identifier assigned by the carrier to a specific transport route or delivery tour. | |
| VatExemption | Text or code describing VAT exemption reason (e.g., intra-community supply). | |
| VatGroup.NetAmount | DocumentEssentials.Vat.Item.Net.Amount | Net amount for a specific VAT group. |
| VatGroup.VatAmount | DocumentEssentials.Vat.Item.Vat.Amount | Tax amount for a specific VAT group. |
| VatGroup.VatRate | DocumentEssentials.Vat.Item.Vat.Rate | VAT rate percentage for a specific VAT group. |
| VatTotalAmount | Sum of all VAT amounts applied on the invoice. |