API Codex
Receipt Parser API

Schemas


Error

  • errorstring

    Error message

MerchantInfo

  • namestring · required

    Name of the merchant or store

    Example: COFFEE SHOP
  • addressstring | null

    Address of the merchant

    Example: 123 Main Street, City, State 12345
  • phonestring | null

    Phone number of the merchant

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

    Website of the merchant

    Example: null
  • tax_idstring | null

    Tax ID or VAT number of the merchant

    Example: 987654321

TransactionInfo

  • datestring · required

    Date of the transaction

    Example: 2025-05-13
  • total_amountstring · required

    Total amount including tax

    Example: 17.41
  • receipt_nostring | null

    Receipt or transaction number

    Example: R-12345
  • timestring | null

    Time of the transaction

    Example: 09:30:00
  • payment_methodstring | null

    Method of payment (e.g., credit card, cash)

    Example: CREDIT CARD
  • card_infostring | null

    Partial card information if applicable

    Example: VISA **** 1234
  • currencystring | null

    Currency used for the transaction

    Example: USD
  • subtotalstring | null

    Subtotal amount before tax

    Example: 15.97
  • tax_amountstring | null

    Total tax amount

    Example: 1.44
  • tax_ratestring | null

    Tax rate percentage

    Example: 9
  • tip_amountstring | null

    Tip amount if applicable

    Example: 3.5
  • discount_amountstring | null

    Discount amount if applicable

    Example: null

LineItem

  • namestring · required

    Name or description of the item

    Example: Cappuccino Large
  • total_pricestring · required

    Total price for this item

    Example: 5.99
  • quantitystring | null

    Quantity of the item

    Example: 1
  • unit_pricestring | null

    Price per unit of the item

    Example: 5.99
  • tax_infostring | null

    Tax information specific to this item if available

    Example: null
  • discountstring | null

    Discount applied to this item if any

    Example: null
  • skustring | null

    Item SKU or identifier if available

    Example: null
  • categorystring | null

    Category of the item if available

    Example: Beverages

CustomerInfo

  • namestring | null

    Customer name if available

    Example: null
  • idstring | null

    Customer ID or loyalty number if available

    Example: null
  • membershipstring | null

    Membership status or type if available

    Example: null

AdditionalInfo

  • return_policystring | null

    Return policy information

    Example: No returns on food items
  • barcodestring | null

    Barcode or QR code information if available

    Example: null
  • cashierstring | null

    Cashier name or ID

    Example: John D.
  • store_nostring | null

    Store number or identifier

    Example: ST-45
  • order_typestring | null

    Type of order (dine-in, takeout, delivery)

    Example: Dine-in
  • notesstring | null

    Any additional notes or information

    Example: Thank you for your visit!

ParsedReceipt

  • merchantobject · required
  • transactionobject · required
  • itemsobject[] · required
  • customerobject
  • additional_infoobject

ParsedReceiptResponse

  • successboolean · required

    Indicates if the parsing was successful

    Example: true
  • parsed_atstring · date-time · required

    Timestamp when the receipt was parsed

    Example: 2025-05-13T07:40:48.000Z
  • dataobject · required