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
vendor_name	string
vendor_address	string
vendor_postcode	string
vendor_state	string
vendor_country	string
vendor_contact_number	string
vendor_sst_number	string
recipient_name	string
recipient_address	string
recipient_postcode	string
recipient_state	string
recipient_country	string
recipient_contact_number	string
invoice_number	string
reference_number	string
invoice_date	string
invoice_due_date	string
invoice_terms	string
billing_period	string
items	Array of Objects
items[].item_description	string
items[].item_quantity	string
items[].item_per_unit_price	string
items[].item_discount_rate	string
items[].item_discount_amount	string
items[].item_amount_exclude_sst	string
items[].item_tax_rate	string
items[].item_tax_amount	string
items[].item_amount_include_sst	string
subtotal	string
discount	string
tax	string
total	string
currency	string
payment_mode	string
payment_to	string
payment_reference	string

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 Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Body

Example

{
    "success": true,
    "data": [
        {
            "type": "vendor_name",
            "value": "Tech Supplies Inc."
        },
        {
            "type": "vendor_address",
            "value": "789 Industrial Ave"
        },
        {
            "type": "vendor_postcode",
            "value": null
        },
        {
            "type": "vendor_state",
            "value": null
        },
        {
            "type": "vendor_country",
            "value": null
        },
        {
            "type": "vendor_contact_number",
            "value": null
        },
        {
            "type": "vendor_sst_number",
            "value": "SST-987654321"
        },
        {
            "type": "recipient_name",
            "value": "Accounts Payable"
        },
        {
            "type": "recipient_address",
            "value": "456 Main Street"
        },
        {
            "type": "recipient_postcode",
            "value": null
        },
        {
            "type": "recipient_state",
            "value": null
        },
        {
            "type": "recipient_country",
            "value": null
        },
        {
            "type": "recipient_contact_number",
            "value": "555-1234"
        },
        {
            "type": "invoice_number",
            "value": "INV-2024-001"
        },
        {
            "type": "reference_number",
            "value": "PO-123456"
        },
        {
            "type": "invoice_date",
            "value": "2024-01-15"
        },
        {
            "type": "invoice_due_date",
            "value": null
        },
        {
            "type": "invoice_terms",
            "value": "Net 30"
        },
        {
            "type": "billing_period",
            "value": null
        },
        {
            "type": "items",
            "value": [
                {
                    "item_description": "Laptop",
                    "item_quantity": "2",
                    "item_per_unit_price": "800",
                    "item_discount_rate": null,
                    "item_discount_amount": "50",
                    "item_amount_exclude_sst": "1600",
                    "item_tax_rate": "10",
                    "item_tax_amount": "160",
                    "item_amount_include_sst": "1550"
                },
                {
                    "item_description": "Mouse",
                    "item_quantity": "5",
                    "item_per_unit_price": "20",
                    "item_discount_rate": null,
                    "item_discount_amount": "0",
                    "item_amount_exclude_sst": "100",
                    "item_tax_rate": "10",
                    "item_tax_amount": "10",
                    "item_amount_include_sst": "100"
                }
            ]
        },
        {
            "type": "subtotal",
            "value": "1650"
        },
        {
            "type": "discount",
            "value": "50"
        },
        {
            "type": "tax",
            "value": "165"
        },
        {
            "type": "total",
            "value": "1815"
        },
        {
            "type": "currency",
            "value": "USD"
        },
        {
            "type": "payment_mode",
            "value": null
        },
        {
            "type": "payment_to",
            "value": "Tech Supplies Inc."
        },
        {
            "type": "payment_reference",
            "value": null
        }
    ],
    "miscellaneous": {
        "processedTime": 112.345
    }
}

Extract Invoice Data

Extracted Data Types#

Notes#

Request

Request Code Samples

Responses

Extracted Data Types

Notes