Guides
Ocrolus.comStart free trialRaise a request

Invoices & Receipts

Suggest Edits

❗️

This feature is no longer supported.

Ocrolus captures Invoice & Receipt data in two parts:

  • invoice header & footer data (e.g. Invoice No, Invoice Date, Total Amount, Amount Paid)
  • itemized line item data (e.g. Item SKU, Price, Quantity)

The form_type parameter INVOICE for the Upload PDF endpoint is required for this Form Type.

Optional invoice/receipt header & footer data captured

Invoice header & footer data (e.g. Invoice No, Invoice Date, Customer Name) is captured as Form Data objects, each one keyed off the following attribute names.

📘

Configuration-Driven Output

All fields below are optionally captured, depending on your order form. To adjust fields captured, please speak with your Ocrolus Account Manager.

JSON AttributeData TypeDescription
invoice-Part1-General:invoiceNumberTextInvoice Number
invoice-Part1-General:purchaseOrderNumber(Po)TextPurchase Order Number (PO)
invoice-Part1-General:invoiceDateDateInvoice Date
invoice-Part1-General:orderDateDateOrder Date
invoice-Part1-General:accountNumberTextAccount Number
invoice-Part1-General:termsTextTerms
invoice-Part2-VendorDetails:vendorNameTextVendor Name
invoice-Part2-VendorDetails:vendorAddress:addressLine1TextVendor Address Line 1
invoice-Part2-VendorDetails:vendorAddress:addressLine2TextVendor Address Line 2
invoice-Part2-VendorDetails:vendorAddress:cityTextVendor Address City
invoice-Part2-VendorDetails:vendorAddress:stateTextVendor Address State (formatted 2 character State code)
invoice-Part2-VendorDetails:vendorAddress:zipTextVendor Address Zip Code (formatted 5 digit code)
invoice-Part2-VendorDetails:vendorAddress:countryTextVendor Address Country
invoice-Part2-VendorDetails:vendorEmailAddressTextVendor Email Address
invoice-Part2-VendorDetails:vendorPhoneNumberTextVendor Phone Number
invoice-Part2-VendorDetails:bankAccountTextBank Account
invoice-Part3-BuyerDetails:buyerName(BillTo)TextBuyer Bill To Name
invoice-Part3-BuyerDetails:buyerAddress(BillTo):addressLine1TextBuyer Bill To Address Line 1
invoice-Part3-BuyerDetails:buyerAddress(BillTo):addressLine2TextBuyer Bill To Address Line 2
invoice-Part3-BuyerDetails:buyerAddress(BillTo):cityTextBuyer Bill To Address City
invoice-Part3-BuyerDetails:buyerAddress(BillTo):stateTextBuyer Bill To Address State (formatted 2 character State code)
invoice-Part3-BuyerDetails:buyerAddress(BillTo):zipTextBuyer Bill To Address Zip Code (formatted 5 digit code)
invoice-Part3-BuyerDetails:buyerAddress(BillTo):countryTextBuyer Bill To Address Country
invoice-Part3-BuyerDetails:buyerName(ShipTo)TextBuyer Ship To Name
invoice-Part3-BuyerDetails:buyerAddress(ShipTo):addressLine1TextBuyer Ship To Address Line 1
invoice-Part3-BuyerDetails:buyerAddress(ShipTo):addressLine2TextBuyer Ship To Address Line 2
invoice-Part3-BuyerDetails:buyerAddress(ShipTo):cityTextBuyer Ship To Address City
invoice-Part3-BuyerDetails:buyerAddress(ShipTo):stateTextBuyer Ship To Address State (formatted 2 character State code)
invoice-Part3-BuyerDetails:buyerAddress(ShipTo):zipTextBuyer Ship To Address Zip Code (formatted 5 digit code)
invoice-Part3-BuyerDetails:buyerAddress(ShipTo):countryTextBuyer Ship To Address Country
invoice-Part3-BuyerDetails:buyerEmailAddress TextBuyer Email Address
invoice-Part3-BuyerDetails:buyerPhoneNumberTextBuyer Phone Number
invoice-Part3-BuyerDetails:buyerTaxIdentifierTypeTextBuyer Tax Identifier Type
invoice-Part3-BuyerDetails:buyerTaxIdentifierValueTextBuyer Tax Identifier
invoice-Part4-Payment:paymentDueDateDatePayment Due Date
invoice-Part4-Payment:deliveryDateDateDelivery Date
invoice-Part4-Payment:freightMoneyFreight
invoice-Part4-Payment:packingMoneyPacking
invoice-Part4-Payment:travelMoneyTravel
invoice-Part4-Payment:handlingMoneyHandling
invoice-Part4-Payment:carriageMoneyCarriage
invoice-Part4-Payment:insuranceMoneyInsurance
invoice-Part4-Payment:fuelMoneyFuel
invoice-Part4-Payment:invoiceSubtotalMoneyInvoice Subtotal
invoice-Part4-Payment:invoiceTaxMoneyInvoice Tax
invoice-Part4-Payment:invoiceTotalMoneyInvoice Total
'invoice-Part4-Payment:amountPaid'MoneyAmount Paid

Optional itemized line item fields captured

Field data attributed to itemized line items in the Invoice is captured as a Table object.

📘

Form-Driven Output

column_ids associated with the Table object will be a subset of the following list that matches the line item headers as they appear on the specific form.

Column IDData TypeDescription
descriptionTextDescription
priceMoneyPrice
quantityTextQuantity
totalMoneyTotal

Sample Form

The below Ocrolus Sample PDF (input) matches the below Sample JSON Result (output).

Ocrolus Sample PDF - Invoice.pdf
drive.google.comdrive.google.com
Ocrolus Sample PDF - Invoice.pdf

Sample JSON Result

{
  "forms": [
    {
      "tables": [
        {
          "pk": 12245,
          "rows": [
            {
              "page_idx": 0,
              "cells": {
                "price": {
                  "value": "100.00"
                },
                "total": {
                  "value": "100.00"
                },
                "description": {
                  "value": "Front and rear brake cables"
                },
                "quantity": {
                  "value": "1.00"
                }
              },
              "page_doc_pk": 82312796
            },
            {
              "page_idx": 0,
              "cells": {
                "price": {
                  "value": "15.00"
                },
                "total": {
                  "value": "30.00"
                },
                "description": {
                  "value": "New set of pedal arms"
                },
                "quantity": {
                  "value": "2.00"
                }
              },
              "page_doc_pk": 82312796
            },
            {
              "page_idx": 0,
              "cells": {
                "price": {
                  "value": "5.00"
                },
                "total": {
                  "value": "15.00"
                },
                "description": {
                  "value": "Labor 3hrs"
                },
                "quantity": {
                  "value": "3.00"
                }
              },
              "page_doc_pk": 82312796
            }
          ],
          "columns": [
            {
              "alias_used": "QTY",
              "column_id": "quantity"
            },
            {
              "alias_used": "DESCRIPTION",
              "column_id": "description"
            },
            {
              "alias_used": "UNIT PRICE",
              "column_id": "price"
            },
            {
              "alias_used": "AMOUNT",
              "column_id": "total"
            }
          ]
        }
      ],
      "type": "INVOICE",
      "form_pk": 9677325,
      "pages": [
        {
          "other_frauds": [],
          "page_idx": 0,
          "uploaded_doc_pk": 10572889,
          "fields": {
            "Buyer Address (Ship To) Address Line 1": {
              "is_empty": false,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "3787 PINEVIEW DRIVE",
              "page_doc_pk": 82312796
            },
            "Buyer Address (Ship To) Address Line 2": {
              "is_empty": true,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "",
              "page_doc_pk": 82312796
            },
            "Buyer Phone Number": {
              "is_empty": true,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "",
              "page_doc_pk": 82312796
            },
            "Buyer Email Address": {
              "is_empty": true,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "",
              "page_doc_pk": 82312796
            },
            "Bank Account ": {
              "is_empty": true,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "",
              "page_doc_pk": 82312796
            },
            "Payment Due Date": {
              "is_empty": false,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "02/26/2019",
              "page_doc_pk": 82312796
            },
            "Fuel": {
              "is_empty": true,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "",
              "page_doc_pk": 82312796
            },
            "Travel": {
              "is_empty": true,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "",
              "page_doc_pk": 82312796
            },
            "Routing Number": {
              "is_empty": true,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "",
              "page_doc_pk": 82312796
            },
            "Invoice Subtotal": {
              "is_empty": false,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "145.00",
              "page_doc_pk": 82312796
            },
            "Terms": {
              "is_empty": true,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "",
              "page_doc_pk": 82312796
            },
            "Buyer Address (Ship To) State": {
              "is_empty": false,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "MA",
              "page_doc_pk": 82312796
            },
            "Invoice Date": {
              "is_empty": false,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "11/02/2019",
              "page_doc_pk": 82312796
            },
            "Vendor Address Address Line 1": {
              "is_empty": false,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "1912 HARVEST LANE",
              "page_doc_pk": 82312796
            },
            "Vendor Address Zip": {
              "is_empty": false,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "12210",
              "page_doc_pk": 82312796
            },
            "Vendor Address Address Line 2": {
              "is_empty": true,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "",
              "page_doc_pk": 82312796
            },
            "Packing": {
              "is_empty": true,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "",
              "page_doc_pk": 82312796
            },
            "Buyer Address (Ship To) City": {
              "is_empty": false,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "CAMBRIDGE",
              "page_doc_pk": 82312796
            },
            "Buyer Tax Identifier ": {
              "is_empty": true,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "",
              "page_doc_pk": 82312796
            },
            "Purchase Order Number (PO)": {
              "is_empty": false,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "2312/2019",
              "page_doc_pk": 82312796
            },
            "Vendor Address Country": {
              "is_empty": true,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "",
              "page_doc_pk": 82312796
            },
            "Handling": {
              "is_empty": true,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "",
              "page_doc_pk": 82312796
            },
            "Buyer Address (Bill To) Address Line 2": {
              "is_empty": true,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "",
              "page_doc_pk": 82312796
            },
            "Vendor Email Address": {
              "is_empty": true,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "",
              "page_doc_pk": 82312796
            },
            "Order Date": {
              "is_empty": true,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "",
              "page_doc_pk": 82312796
            },
            "Buyer Address (Bill To) Address Line 1": {
              "is_empty": false,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "2 COURT SQUARE",
              "page_doc_pk": 82312796
            },
            "Buyer Address (Ship To) Zip": {
              "is_empty": false,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "12210",
              "page_doc_pk": 82312796
            },
            "Buyer Address (Ship To) Country": {
              "is_empty": true,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "",
              "page_doc_pk": 82312796
            },
            "Buyer Address (Bill To) State": {
              "is_empty": false,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "NY",
              "page_doc_pk": 82312796
            },
            "Invoice Total": {
              "is_empty": false,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "154.06",
              "page_doc_pk": 82312796
            },
            "Buyer Name (Bill To)": {
              "is_empty": false,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "JOHN SMITH",
              "page_doc_pk": 82312796
            },
            "Amount Paid": {
              "is_empty": true,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "",
              "page_doc_pk": 82312796
            },
            "Vendor Address City": {
              "is_empty": false,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "NEW YORK",
              "page_doc_pk": 82312796
            },
            "Invoice Tax": {
              "is_empty": false,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "9.06",
              "page_doc_pk": 82312796
            },
            "Vendor Phone Number": {
              "is_empty": true,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "",
              "page_doc_pk": 82312796
            },
            "Buyer Address (Bill To) Country": {
              "is_empty": true,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "",
              "page_doc_pk": 82312796
            },
            "Vendor Address State": {
              "is_empty": false,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "NY",
              "page_doc_pk": 82312796
            },
            "Account Number": {
              "is_empty": true,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "",
              "page_doc_pk": 82312796
            },
            "Buyer Address (Bill To) City": {
              "is_empty": false,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "NEW YORK",
              "page_doc_pk": 82312796
            },
            "Buyer Name (Ship To)": {
              "is_empty": false,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "JOHN SMITH",
              "page_doc_pk": 82312796
            },
            "Delivery Date": {
              "is_empty": true,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "",
              "page_doc_pk": 82312796
            },
            "Buyer Address (Bill To) Zip": {
              "is_empty": false,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "12210",
              "page_doc_pk": 82312796
            },
            "Carriage": {
              "is_empty": true,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "",
              "page_doc_pk": 82312796
            },
            "Freight": {
              "is_empty": true,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "",
              "page_doc_pk": 82312796
            },
            "Vendor Name": {
              "is_empty": false,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "EAST REPAIR INC.",
              "page_doc_pk": 82312796
            },
            "Insurance": {
              "is_empty": true,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "",
              "page_doc_pk": 82312796
            },
            "Invoice Number": {
              "is_empty": false,
              "source_filename": "Ocrolus Sample PDF - Invoice.pdf",
              "alias_used": null,
              "value": "US-001",
              "page_doc_pk": 82312796
            }
          }
        }
      ]
    }
  ],
  "pk": 10572889
}

Updated over 1 year ago