Skip to main content

Invoice Extraction​

  • This API extracts information from an invoice file.
  • Note: The file should be in a supported format (e.g., PDF).
Header Parameters
    Content-Type string

    The content type should be multipart/form-data for file upload.

    Example: multipart/form-data
    Authorization string required

    API key for authorization.

Request Body
    file binary required

    The file to extract data from (e.g., invoice document).

Responses

Success

Schema
    result object

    Extracted data from the invoice.

    Vendor Name string

    Vendor who created this invoice.

    Vendor Address string

    Address of the vendor.

    Vendor Address Recipient string

    Name associated with vendor address.

    Customer Name string

    Customer to whom the invoice is given.

    Customer Id string

    Reference id for a customer.

    Customer Address string

    Address of the invoiced customer.

    Customer Address Recipient string

    Name associated with customer address.

    Invoice Id string

    Reference id for the given invoice.

    Invoice Date string

    The date the invoice was given to the customer.

    Invoice Total string

    Total charges issued in the invoice.

    Due Date string

    Due date for the payment.

    Purchase Order string

    A reference number for a purchase order.

    Billing Address string

    Billing address of the customer.

    Billing Address Recipient string

    Name associated with the billing address.

    Shipping Address string

    Shipping address of the customer.

    Shipping Address Recipient string

    Name associated with the shipping address.

    Invoice items object[]
  • Array [
    • Description string

    The item descripiton.

    Quantity string

    Respective Quantity of the invoice item.

    Unit string

    The unit measurement of the invoice item.

    Unit Price string

    The price of one unit of the invoice item.

    Product Code string

    Code associated with the respective invoice item.

    Date string

    Date asscoiated with each invoice item.

    Tax string

    Tax associated with each invoice item.

    Amount string

    Total amount of the invoice item.

  • ]
    • Subtotal string

    Subtotal on the invoice.

    Total Discount string

    Total discount on the invoice.

    Total Tax string

    Total tax on the invoice.

    Previous Unpaid Balance string

    Previous unpaid balance amount.

    Amount Due string

    Total amount to be paid by the customer.

    Service Start Date string

    Starting date of the service.

    Service End Date string

    Ending date of the service.

    Service Address string

    Explicit service address for the customer.

    Service Address Recipient string

    Name associated with the service address.

    Remittance Address string

    Explicit payment address for the customer.

    Remittance Address Recipient string

    Name associated with Remittance address.

    Vendor Tax Id string

    The tax ID associated with vendor.

    Customer Tax Id string

    The tax ID associated with customer.

    Tax Details object
    Amount string

    Amount of the tax detail.

    Rate string

    Rate of the tax detail.

    table_n object

    All the tables extracted. table_n means nth table where n=1,2,3,...

    row_n string[]

    All the rows in the table extracted. row_n means nth row of a table where n=1,2,3,...

    whole_extracted_text string[]

    All the text extracted from the document.

Loading...