Extract E-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
`supplier_name`	string \| null
`buyer_name`	string \| null
`supplier_tin`	string \| null
`supplier_registration_number`	string \| null
`supplier_sst_registration_number`	string \| null
`supplier_tourism_tax_registration_number`	string \| null
`supplier_email`	string \| null
`supplier_msic_code`	string \| null
`supplier_business_activity_description`	string \| null
`buyer_tin`	string \| null
`buyer_registration_number`	string \| null
`buyer_sst_registration_number`	string \| null
`buyer_email`	string \| null
`supplier_address`	string \| null
`buyer_address`	string \| null
`supplier_contact_number`	string \| null
`buyer_contact_number`	string \| null
`e_invoice_version`	string \| null
`e_invoice_type`	string \| null
`e_invoice_code`	string \| null
`originale_invoice_reference_number`	string \| null
`e_invoice_date_time`	string \| null
`issuer_digital_signature`	string \| null
`invoice_currency_code`	string \| null
`currency_exchange_rate`	string \| null
`frequency_of_billing`	string \| null
`billing_period`	string \| null
`classification`	string \| null
`product_list[]`	Array of Objects
`product_list[].description_of_product_or_service`	string \| null
`product_list[].unit_price`	string \| null
`product_list[].measurement`	string \| null
`product_list[].quantity`	string \| null
`product_list[].product_total_price`	string \| null
`tax_type`	string \| null
`tax_rate`	string \| null
`tax_amount`	string \| null
`details_of_tax_exemption`	string \| null
`amount_exempted_from_tax`	string \| null
`subtotal`	string \| null
`total_excluding_tax`	string \| null
`total_including_tax`	string \| null
`total_net_amount`	string \| null
`total_payable_amount`	string \| null
`rounding_amount`	string \| null
`total_taxable_amount_per_tax_type`	string \| null
`discount_rate`	string \| null
`discount_amount`	string \| null
`fee_charge_rate`	string \| null
`fee_charge_amount`	string \| null
`payment_mode`	string \| null
`supplier_bank_account_number`	string \| null
`payment_terms`	string \| null
`prepayment_amount`	string \| null
`prepayment_date`	string \| null
`prepayment_reference_number`	string \| null
`bill_reference_number`	string \| null
`customs_form_reference_number`	string \| null
`shipping_recipient_name`	string \| null
`shipping_recipient_address`	string \| null
`shipping_recipient_tin`	string \| null
`shipping_recipient_registration_number`	string \| null
`incoterms`	string \| null
`product_tariff_code`	string \| null
`free_trade_agreement_information`	string \| null
`authorisation_number_for_certified_exporter`	string \| null
`customs_form_reference_number_for_export`	string \| null
`country_of_origin`	string \| null
`details_of_other_charges`	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": "supplier_name",
            "value": "Tech Solutions Ltd."
        },
        {
            "type": "buyer_name",
            "value": "Innovative Enterprises Inc."
        },
        {
            "type": "supplier_tin",
            "value": "123456789"
        },
        {
            "type": "supplier_registration_number",
            "value": "REG-00123456"
        },
        {
            "type": "supplier_sst_registration_number",
            "value": "SST-123456789"
        },
        {
            "type": "supplier_tourism_tax_registration_number",
            "value": "TAX-987654321"
        },
        {
            "type": "supplier_email",
            "value": "contact@techsolutions.com"
        },
        {
            "type": "supplier_msic_code",
            "value": "62012"
        },
        {
            "type": "supplier_business_activity_description",
            "value": "IT Consulting and Software Development"
        },
        {
            "type": "buyer_tin",
            "value": "987654321"
        },
        {
            "type": "buyer_registration_number",
            "value": "BUYER-123456"
        },
        {
            "type": "buyer_sst_registration_number",
            "value": "BUYER-SST-987654321"
        },
        {
            "type": "buyer_email",
            "value": "accounts@innovativeenterprises.com"
        },
        {
            "type": "supplier_address",
            "value": "123 Tech Park, Silicon Valley, CA"
        },
        {
            "type": "buyer_address",
            "value": "789 Business Plaza, New York, NY"
        },
        {
            "type": "supplier_contact_number",
            "value": "555-1234"
        },
        {
            "type": "buyer_contact_number",
            "value": "555-5678"
        },
        {
            "type": "e_invoice_version",
            "value": "1.0"
        },
        {
            "type": "e_invoice_type",
            "value": "Standard"
        },
        {
            "type": "e_invoice_code",
            "value": "EINV-2024-001"
        },
        {
            "type": "originale_invoice_reference_number",
            "value": "INV-2024-123"
        },
        {
            "type": "e_invoice_date_time",
            "value": "2024-01-15T10:30:00Z"
        },
        {
            "type": "issuer_digital_signature",
            "value": "xyzabc123digitalsignature"
        },
        {
            "type": "invoice_currency_code",
            "value": "USD"
        },
        {
            "type": "currency_exchange_rate",
            "value": "1.00"
        },
        {
            "type": "frequency_of_billing",
            "value": "Monthly"
        },
        {
            "type": "billing_period",
            "value": "2024-01-01 to 2024-01-31"
        },
        {
            "type": "classification",
            "value": "Standard"
        },
        {
            "type": "product_list",
            "value": [
                {
                    "description_of_product_or_service": "Software Development Services",
                    "unit_price": "5000",
                    "measurement": "Hours",
                    "quantity": "40",
                    "product_total_price": "200000"
                },
                {
                    "description_of_product_or_service": "IT Consulting",
                    "unit_price": "1500",
                    "measurement": "Hours",
                    "quantity": "20",
                    "product_total_price": "30000"
                }
            ]
        },
        {
            "type": "tax_type",
            "value": "Standard Tax"
        },
        {
            "type": "tax_rate",
            "value": "10"
        },
        {
            "type": "tax_amount",
            "value": "23000"
        },
        {
            "type": "details_of_tax_exemption",
            "value": "None"
        },
        {
            "type": "amount_exempted_from_tax",
            "value": "0"
        },
        {
            "type": "subtotal",
            "value": "230000"
        },
        {
            "type": "total_excluding_tax",
            "value": "230000"
        },
        {
            "type": "total_including_tax",
            "value": "253000"
        },
        {
            "type": "total_net_amount",
            "value": "253000"
        },
        {
            "type": "total_payable_amount",
            "value": "253000"
        },
        {
            "type": "rounding_amount",
            "value": "0"
        },
        {
            "type": "total_taxable_amount_per_tax_type",
            "value": "230000"
        },
        {
            "type": "discount_rate",
            "value": "5"
        },
        {
            "type": "discount_amount",
            "value": "11500"
        },
        {
            "type": "fee_charge_rate",
            "value": "2"
        },
        {
            "type": "fee_charge_amount",
            "value": "4600"
        },
        {
            "type": "payment_mode",
            "value": "Bank Transfer"
        },
        {
            "type": "supplier_bank_account_number",
            "value": "9876543210"
        },
        {
            "type": "payment_terms",
            "value": "Net 30"
        },
        {
            "type": "prepayment_amount",
            "value": "50000"
        },
        {
            "type": "prepayment_date",
            "value": "2024-01-10"
        },
        {
            "type": "prepayment_reference_number",
            "value": "PREP-12345"
        },
        {
            "type": "bill_reference_number",
            "value": "BRN-2024-789"
        },
        {
            "type": "customs_form_reference_number",
            "value": "CFN-2024-001"
        },
        {
            "type": "shipping_recipient_name",
            "value": "Innovative Enterprises"
        },
        {
            "type": "shipping_recipient_address",
            "value": "789 Business Plaza, New York, NY"
        },
        {
            "type": "shipping_recipient_tin",
            "value": "987654321"
        },
        {
            "type": "shipping_recipient_registration_number",
            "value": "SHIP-123456"
        },
        {
            "type": "incoterms",
            "value": "FOB"
        },
        {
            "type": "product_tariff_code",
            "value": "IT1234"
        },
        {
            "type": "free_trade_agreement_information",
            "value": "NAFTA"
        },
        {
            "type": "authorisation_number_for_certified_exporter",
            "value": "A12345"
        },
        {
            "type": "customs_form_reference_number_for_export",
            "value": "CFN-EXP-001"
        },
        {
            "type": "country_of_origin",
            "value": "USA"
        },
        {
            "type": "details_of_other_charges",
            "value": "Shipping Charge: 500"
        }
    ],
    "miscellaneous": {
        "processedTime": 150.123
    }
}

Extract E-Invoice Data

Extracted Data Types#

Notes#

Request

Request samples

Responses

Extracted Data Types

Notes