API Codex
Invoice Parser API

Schemas


Error

  • errorstring

    Error message

VendorInfo

  • namestring · required

    Name of the vendor/supplier

    Example: ACME SUPPLIES LTD
  • addressstring | null

    Complete address of the vendor

    Example: 456 Business Ave, Suite 100, Industry City, NY 10001
  • phonestring | null

    Phone number of the vendor

    Example: (555) 987-6543
  • emailstring | null

    Email address of the vendor

    Example: billing@acmesupplies.example
  • websitestring | null

    Website of the vendor

    Example: www.acmesupplies.example
  • tax_idstring | null

    Tax ID or VAT number of the vendor

    Example: US123456789
  • registration_numberstring | null

    Business registration number

    Example: BRN-987654321

InvoiceDetails

  • invoice_numberstring · required

    Invoice identifier

    Example: INV-2025-0042
  • issue_datestring · required

    Date the invoice was issued

    Example: 2025-05-01
  • purchase_orderstring | null

    Reference to customer's purchase order

    Example: PO-2025-1234
  • due_datestring | null

    Date payment is due

    Example: 2025-05-31
  • payment_termsstring | null

    Payment terms (e.g., Net 30)

    Example: Net 30
  • currencystring | null

    Currency used

    Example: USD
  • languagestring | null

    Language of the invoice

    Example: en-US

LineItem

  • descriptionstring · required

    Description of the item or service

    Example: Premium Office Desk Chair
  • total_amountnumber · required

    Total amount for this line item

    Example: 899.96
  • product_codestring | null

    Product or service code/SKU

    Example: FRN-CH-001
  • quantitynumber | null

    Quantity of items

    Example: 5
  • unit_of_measurestring | null

    Unit of measurement (e.g., hours, pieces)

    Example: pcs
  • unit_pricenumber | null

    Price per unit

    Example: 199.99
  • discountnumber | null

    Discount amount or percentage

    Example: 10
  • tax_ratenumber | null

    Tax rate applied to this item

    Example: 8.25
  • tax_amountnumber | null

    Tax amount for this item

    Example: 74.99

CustomerInfo

  • namestring · required

    Name of the customer/client

    Example: GLOBAL ENTERPRISES INC
  • addressstring | null

    Billing address

    Example: 789 Corporate Park, Downtown, CA 90210
  • shipping_addressstring | null

    Shipping address if different from billing

    Example: 789 Corporate Park, Warehouse 3, Downtown, CA 90210
  • attentionstring | null

    Contact person

    Example: John Smith
  • phonestring | null

    Phone number

    Example: (555) 123-4567
  • emailstring | null

    Email address

    Example: accounts@globalenterprises.example
  • customer_idstring | null

    Customer ID or account number

    Example: CUST-1234
  • tax_idstring | null

    Customer tax ID or VAT number

    Example: CA987654321

TotalsInfo

  • total_amountnumber · required

    Final invoice amount

    Example: 2348.83
  • subtotalnumber | null

    Sum of line items before tax and discounts

    Example: 2199.85
  • discount_totalnumber | null

    Total discount amount

    Example: 100
  • tax_totalnumber | null

    Total tax amount

    Example: 173.98
  • shipping_costnumber | null

    Shipping or delivery charges

    Example: 75
  • amount_paidnumber | null

    Amount already paid if any

    Example: 500
  • amount_duenumber | null

    Remaining amount to be paid

    Example: 1848.83

TaxBreakdown

  • tax_typestring · required

    Type of tax (e.g., VAT, GST, Sales Tax)

    Example: Sales Tax
  • tax_amountnumber · required

    Tax amount

    Example: 173.98
  • tax_ratenumber | null

    Rate of the tax

    Example: 8.25
  • taxable_amountnumber | null

    Amount on which tax is calculated

    Example: 2099.85

PaymentInfo

  • payment_methodstring | null

    Accepted payment methods

    Example: Bank Transfer
  • bank_namestring | null

    Bank name

    Example: First National Bank
  • account_numberstring | null

    Bank account number

    Example: ACCT-12345678
  • routing_numberstring | null

    Bank routing number

    Example: RTG-987654321
  • swift_codestring | null

    SWIFT/BIC code for international transfers

    Example: FNBKUS12
  • ibanstring | null

    International Bank Account Number

    Example: null

AdditionalInfo

  • notesstring | null

    Additional notes or comments

    Example: Please reference invoice number on all payments.
  • terms_conditionsstring | null

    Terms and conditions

    Example: Payment due within 30 days from the invoice date.
  • referencestring | null

    Reference number or code

    Example: REF-2025-Q2-OFFICE
  • attachmentsarray | null

    References to attachments

    Example: null

ParsedInvoice

  • vendorobject · required
  • customerobject · required
  • invoice_detailsobject · required
  • line_itemsobject[] · required
  • totalsobject · required
  • tax_breakdownobject[]
  • payment_informationobject
  • additional_infoobject

ParsedInvoiceResponse

  • successboolean · required

    Indicates if the parsing was successful

    Example: true
  • parsed_atstring · date-time · required

    Timestamp when the invoice was parsed

    Example: 2025-05-13T08:15:32.000Z
  • dataobject · required