Extract Invoice Data

Extracted Data Types

The following types will always be present in the API response. If a type parameter is not found in the input, its value will be null.

Parameter Name	Variable Type
`document_title`	string \| null
`vendor_name`	string \| null
`vendor_address`	string \| null
`sst_number`	string \| null
`invoice_number`	string \| null
`invoice_date`	string \| null
`invoice_currency`	string \| null
`purchase_order_number`	string \| null
`salesperson`	string \| null
`payment_terms`	string \| null
`vendor_registration_number`	string \| null
`billing`	Array of Objects
`billing[].billing_address`	string \| null
`billing[].billing_phone`	string \| null
`billing[].billing_fax`	string \| null
`billing[].billing_attention`	string \| null
`shipping`	Array of Objects
`shipping[].shipping_address`	string \| null
`shipping[].shipping_phone`	string \| null
`shipping[].shipping_fax`	string \| null
`shipping[].shipping_date`	string \| null
`shipping[].shipping_attention`	string \| null
`item`	Array of Objects
`item[].item_code`	string \| null
`item[].item_description`	string \| null
`item[].item_quantity`	string \| null
`item[].item_unit_of_measurement`	string \| null
`item[].item_unit_price`	string \| null
`item[].item_tax_rate`	string \| null
`item[].item_tax_amount`	string \| null
`item[].item_tax_code`	string \| null
`item[].item_subtotal`	string \| null
`item[].item_discount`	string \| null
`item[].item_total_amount`	string \| null
`invoice_memo`	string \| null
`invoice_subtotal`	string \| null
`invoice_sst_rate`	string \| null
`invoice_sst_amount`	string \| null
`invoice_total`	string \| null

Notes

Each type parameter in the data array will always have the specified type, with the possibility of being null.

If a specific type parameter is not present in the input, its value in the response will be null.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "success": true,
    "data": [
        {
            "type": "document_title",
            "value": "Invoice"
        },
        {
            "type": "vendor_name",
            "value": "Tech Supplies Inc."
        },
        {
            "type": "vendor_address",
            "value": "789 Industrial Ave"
        },
        {
            "type": "sst_number",
            "value": "SST-987654321"
        },
        {
            "type": "invoice_number",
            "value": "INV-2024-001"
        },
        {
            "type": "invoice_date",
            "value": "2024-01-15"
        },
        {
            "type": "invoice_currency",
            "value": "USD"
        },
        {
            "type": "purchase_order_number",
            "value": "PO-123456"
        },
        {
            "type": "salesperson",
            "value": "Alice Johnson"
        },
        {
            "type": "payment_terms",
            "value": "Net 30"
        },
        {
            "type": "vendor_registration_number",
            "value": "REG-123456"
        },
        {
            "type": "billing",
            "value": [
                {
                    "billing_address": "456 Main Street",
                    "billing_phone": "555-1234",
                    "billing_fax": "555-5678",
                    "billing_attention": "Accounts Payable"
                },
                {
                    "billing_address": "789 Secondary St.",
                    "billing_phone": "555-8765",
                    "billing_fax": "555-4321",
                    "billing_attention": "Finance Department"
                }
            ]
        },
        {
            "type": "shipping",
            "value": [
                {
                    "shipping_address": "321 Delivery Lane",
                    "shipping_phone": "555-8765",
                    "shipping_fax": "555-4321",
                    "shipping_date": "2024-01-16",
                    "shipping_attention": "John Doe"
                }
            ]
        },
        {
            "type": "item",
            "value": [
                {
                    "item_code": "ITEM-001",
                    "item_description": "Laptop",
                    "item_quantity": "2",
                    "item_unit_of_measurement": "pcs",
                    "item_unit_price": "800",
                    "item_tax_rate": "10",
                    "item_tax_amount": "160",
                    "item_tax_code": "TAX-001",
                    "item_subtotal": "1600",
                    "item_discount": "50",
                    "item_total_amount": "1550"
                },
                {
                    "item_code": "ITEM-002",
                    "item_description": "Mouse",
                    "item_quantity": "5",
                    "item_unit_of_measurement": "pcs",
                    "item_unit_price": "20",
                    "item_tax_rate": "10",
                    "item_tax_amount": "10",
                    "item_tax_code": "TAX-002",
                    "item_subtotal": "100",
                    "item_discount": "0",
                    "item_total_amount": "100"
                }
            ]
        },
        {
            "type": "invoice_memo",
            "value": "Thank you for your business!"
        },
        {
            "type": "invoice_subtotal",
            "value": "1650"
        },
        {
            "type": "invoice_sst_rate",
            "value": "10"
        },
        {
            "type": "invoice_sst_amount",
            "value": "165"
        },
        {
            "type": "invoice_total",
            "value": "1815"
        }
    ],
    "miscellaneous": {
        "processedTime": 112.345
    }
}

Extract Invoice Data

Extracted Data Types#

Notes#

Request

Request samples

Responses

Extracted Data Types

Notes