Schemas

Error

error

string

Error message

MerchantInfo

name

string · required

Name of the merchant or store

Example: COFFEE SHOP

address

string | null

Address of the merchant

Example: 123 Main Street, City, State 12345

phone

string | null

Phone number of the merchant

Example: (555) 123-4567

website

string | null

Website of the merchant

Example: null

tax_id

string | null

Tax ID or VAT number of the merchant

Example: 987654321

TransactionInfo

date

string · required

Date of the transaction

Example: 2025-05-13

total_amount

string · required

Total amount including tax

Example: 17.41

receipt_no

string | null

Receipt or transaction number

Example: R-12345

time

string | null

Time of the transaction

Example: 09:30:00

payment_method

string | null

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

Example: CREDIT CARD

card_info

string | null

Partial card information if applicable

Example: VISA **** 1234

currency

string | null

Currency used for the transaction

Example: USD

subtotal

string | null

Subtotal amount before tax

Example: 15.97

tax_amount

string | null

Total tax amount

Example: 1.44

tax_rate

string | null

Tax rate percentage

Example: 9

tip_amount

string | null

Tip amount if applicable

Example: 3.5

discount_amount

string | null

Discount amount if applicable

Example: null

LineItem

name

string · required

Name or description of the item

Example: Cappuccino Large

total_price

string · required

Total price for this item

Example: 5.99

quantity

string | null

Quantity of the item

Example: 1

unit_price

string | null

Price per unit of the item

Example: 5.99

tax_info

string | null

Tax information specific to this item if available

Example: null

discount

string | null

Discount applied to this item if any

Example: null

sku

string | null

Item SKU or identifier if available

Example: null

category

string | null

Category of the item if available

Example: Beverages

CustomerInfo

name

string | null

Customer name if available

Example: null

id

string | null

Customer ID or loyalty number if available

Example: null

membership

string | null

Membership status or type if available

Example: null

AdditionalInfo

return_policy

string | null

Return policy information

Example: No returns on food items

barcode

string | null

Barcode or QR code information if available

Example: null

cashier

string | null

Cashier name or ID

Example: John D.

store_no

string | null

Store number or identifier

Example: ST-45

order_type

string | null

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

Example: Dine-in

notes

string | null

Any additional notes or information

Example: Thank you for your visit!

ParsedReceipt

MerchantInfo · required

TransactionInfo · required

LineItem[] · required

CustomerInfo

AdditionalInfo

ParsedReceiptResponse

success

boolean · required

Indicates if the parsing was successful

Example: true

parsed_at

string · date-time · required

Timestamp when the receipt was parsed

Example: 2025-05-13T07:40:48.000Z

ParsedReceipt · required

MerchantInfo

name

string · required

Name of the merchant or store

Example: COFFEE SHOP

address

string | null

Address of the merchant

Example: 123 Main Street, City, State 12345

phone

string | null

Phone number of the merchant

Example: (555) 123-4567

website

string | null

Website of the merchant

Example: null

tax_id

string | null

Tax ID or VAT number of the merchant

Example: 987654321

TransactionInfo

date

string · required

Date of the transaction

Example: 2025-05-13

total_amount

string · required

Total amount including tax

Example: 17.41

receipt_no

string | null

Receipt or transaction number

Example: R-12345

time

string | null

Time of the transaction

Example: 09:30:00

payment_method

string | null

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

Example: CREDIT CARD

card_info

string | null

Partial card information if applicable

Example: VISA **** 1234

currency

string | null

Currency used for the transaction

Example: USD

subtotal

string | null

Subtotal amount before tax

Example: 15.97

tax_amount

string | null

Total tax amount

Example: 1.44

tax_rate

string | null

Tax rate percentage

Example: 9

tip_amount

string | null

Tip amount if applicable

Example: 3.5

discount_amount

string | null

Discount amount if applicable

Example: null

LineItem

name

string · required

Name or description of the item

Example: Cappuccino Large

total_price

string · required

Total price for this item

Example: 5.99

quantity

string | null

Quantity of the item

Example: 1

unit_price

string | null

Price per unit of the item

Example: 5.99

tax_info

string | null

Tax information specific to this item if available

Example: null

discount

string | null

Discount applied to this item if any

Example: null

sku

string | null

Item SKU or identifier if available

Example: null

category

string | null

Category of the item if available

Example: Beverages

AdditionalInfo

return_policy

string | null

Return policy information

Example: No returns on food items

barcode

string | null

Barcode or QR code information if available

Example: null

cashier

string | null

Cashier name or ID

Example: John D.

store_no

string | null

Store number or identifier

Example: ST-45

order_type

string | null

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

Example: Dine-in

notes

string | null

Any additional notes or information

Example: Thank you for your visit!