Skip to main content

Get document Line Items

GET 
/api/v8/partner/documents/:document_id/line-items

Retrieve document Line Items

Request​

Path Parameters

    document_id int64required

    The unique identifier of the document.

Responses​

List of document Line Items

Schema
    line_items object[]required
  • Array [
    • id integerrequired

    The unique number created to identify the Line Item object.

    order integerrequired

    The value indicating the position of where the line item appears on the document.

    tags string[]

    Possible values: non-empty

    A user-defined list of identifiers that help to categorize or flag particular types of line items.

    text stringrequired

    Possible values: non-empty and <= 1000 characters

    The complete text returned for the line item, including prices, dates, etc.

    type stringrequired

    Possible values: [room, tax, parking, service, fee, delivery, product, food, alcohol, tobacco, transportation, fuel, refund, discount, payment, giftcard, donation, toll, lottery]

    The classification of the product. The line type predicted by Veryfi, e.g. food.

    product_info object

    Line item extra product info

    anyOf
    expanded_description (string | null)

    Possible values: non-empty

    brand (string | null)

    Possible values: non-empty

    category string[]

    Possible values: non-empty

    Product Intelligence category for the line item (returned when line_item_expansion enrichment is enabled). Values typically follow this hierarchy:

    • Electronics
      • Computers & Tablets: Tablets, Laptops, Desktop Computers, Computer Accessories
      • Mobile Phones: Wearables, Phone Accessories, Smartphones, Basic Phones
      • TV & Home Theater: Streaming Devices, Projectors, Televisions, Sound Systems
      • Cameras & Photography: DSLR & Mirrorless Cameras, Digital Cameras, Camera Lenses, Camera Accessories
      • Smart Home: Home Security Cameras, Smart Thermostats, Smart Speakers, Smart Lighting
    • Home & Garden
      • Furniture: Kitchen & Dining, Office Furniture, Living Room, Bedroom
      • Kitchen & Dining: Cookware, Utensils, Appliances, Bakeware
      • Garden & Outdoor: Patio Furniture, Gardening Tools, Outdoor Lighting, Outdoor Decor
      • Home Decor: Bedding & Bath, Curtains & Drapes, Rugs, Wall Art
      • Household Essentials: Cleaning Supplies, Laundry Supplies, Paper & Plastic
    • Clothing & Accessories
      • Women's: Bottoms, Dresses, Accessories, Tops, Shoes & Footwear
      • Men's: Suits, Shirts, Accessories, Shoes & Footwear, Pants
      • Children's: Girls, Boys, Infants
      • Unisex: Tops, Bottoms, Shoes & Footwear, Accessories
      • Baby & Toddler: Baby Accessories, Diapers & Potty Training, Baby Clothing
    • Food & Grocery
      • Fresh Food: Produce, Meat & Seafood, Dairy
      • Pantry: Grains & Pasta, Snacks, Canned Goods
      • Beverages: Coffee & Tea, Soft Drinks, Juice, Water
      • Alcoholic Beverages: Wine, Beer, Spirits, Cocktails, Other
      • Bakery: Bread, Pastries, Desserts
      • Frozen Foods: Frozen Produce, Ice Cream, Frozen Meals
    • Health & Beauty
      • Personal Care: Bath & Body, Hair Care, Oral Care, Skin Care
      • Medicine & Treatments: Cold & Flu, Pain Relief, Vitamins & Supplements, First Aid
      • Beauty: Nail Care, Beauty Tools, Fragrances, Makeup
    • Sports & Outdoors
      • Exercise & Fitness: Cardio Equipment, Yoga & Pilates, Weights, Fitness Accessories
      • Sports Equipment: Individual Sports, Team Sports, Recreation
      • Camping & Hiking: Tents, Backpacks, Trekking Poles, Camping Gear
    • Automotive
      • Car Care: Maintenance, Repair, Cleaning
      • Parts & Accessories: Replacement Parts, Performance Parts, Accessories, Car Electronics
      • Tools & Equipment: Garage & Shop, Hand Tools, Power Tools, Diagnostic Tools
    • Toys & Games
      • Games: Board Games, Puzzles, Video Games
      • Toys: Plush & Stuffed Animals, Building Sets, Action Figures, Dolls
      • Educational: Art Supplies, STEM Toys, Learning Toys, Musical Toys
    • Pet Supplies
      • Dog: Dog Food, Dog Toys, Dog Treats, Dog Grooming
      • Cat: Cat Litter & Accessories, Cat Grooming, Cat Toys, Cat Food
      • Fish & Aquatic: Tanks & Aquariums, Aquarium Accessories, Fish Food
      • Bird: Bird Food, Bird Toys, Bird Cages & Accessories
      • Small Pet: Small Pet Food, Small Pet Toys, Small Pet Cages & Accessories
    • Office & School Supplies
      • Writing & Drawing: Markers, Pens, Pencils
      • Paper Products: Printer Paper, Notebooks, Sticky Notes
      • Printers & Ink: Printer Accessories, Printers, Ink & Toner
      • Office Organization: Desk Organizers, Folders & Binders, Labels & Label Makers
    • Books, Music & Movies
      • Books: Children's Books, Non-Fiction, Fiction
      • Music: CDs, Vinyl Records, Digital Music
      • Movies & TV: Digital Movies, DVDs & Blu-ray, TV Series
    • Jewelry & Watches
      • Fine Jewelry: Earrings, Necklaces, Rings
      • Fashion Jewelry: Costume Jewelry, Bracelets
      • Watches: Women's Watches, Smart Watches, Men's Watches
    • Home Improvement
      • Building Materials: Lumber, Drywall, Roofing, Insulation, Cement & Masonry
      • Hardware: Fasteners, Door Hardware, Cabinet Hardware, Security Hardware, Mailboxes
      • Tools: Power Tools, Hand Tools, Power Tool Accessories, Air Tools & Compressors, Tool Storage & Organization
      • Plumbing: Pipes & Fittings, Water Heaters, Pumps, Plumbing Parts & Repair, Filtration
      • Electrical: Wires & Cables, Lighting Controls, Circuit Breakers, Outlets & Switches, Electrical Tools
      • Paint: Interior Paint, Exterior Paint, Spray Paint, Primers, Stains & Finishes, Paint Brushes & Rollers
      • Lighting & Ceiling Fans: Ceiling Fans, Light Fixtures, Outdoor Lighting, Light Bulbs, Lamps & Shades
      • Flooring: Tile, Laminate Flooring, Hardwood Flooring, Vinyl Flooring, Carpet, Flooring Accessories
      • Kitchen & Bath: Kitchen Cabinets, Countertops, Sinks & Faucets, Bathroom Vanities, Showers & Tubs, Toilets & Seats
      • Doors & Windows: Exterior Doors, Interior Doors, Windows, Skylights, Garage Doors & Openers
      • Heating & Cooling: Air Conditioners, Heaters, Thermostats, Fireplaces, Ventilation, Air Filters
      • Outdoor Living: Grills & Accessories, Outdoor Power Equipment, Patio Furniture, Garden Tools, Lawn Care
      • Storage & Organization: Shelving, Closet Systems, Garage Storage, Storage Bins & Containers, Moving Supplies
      • Safety & Security: Smoke & CO Detectors, Fire Extinguishers, Home Security Systems, Safes, Emergency Preparedness
    • Appliances
      • Kitchen Appliances: Refrigerators, Ranges, Microwaves, Dishwashers, Range Hoods
      • Laundry Appliances: Washers, Dryers, Pedestals, Ironing Boards
      • Small Appliances: Vacuums & Floor Care, Blenders & Juicers, Coffee Makers, Toasters & Ovens
      • Appliance Accessories: Water Filters, Appliance Cleaners, Replacement Parts
    custom_categories string[]

    Possible values: non-empty

    The line item's path in the category taxonomy configured for your account, root first. Returned only when a custom taxonomy is configured and this field is enabled. The path may stop above the leaf when the item fits a family but not a single leaf, and is empty when the item could not be placed.

    date date

    The date found on the document and associated with the line item in ISO 8601 format.

    description stringrequired

    Possible values: non-empty and <= 1000 characters

    The product or service's extracted name or description excluding date and price.

    full_description (string | null)

    Possible values: non-empty and <= 1000 characters

    The item text including dates, weight, etc.

    normalized_description (string | null)

    Possible values: non-empty

    The line item description with expanded words

    discount_price (number | null)

    The lower price after discount.

    discount_rate (number | null)

    The discount percentage that was applied to the line item.

    discount (number | null)

    The amount deducted from the total price for the line item.

    price (number | null)

    The unit price for the line item.

    quantity (number | null)

    The amount or number of units for the line item.

    reference (string | null)

    Possible values: non-empty

    section (string | null)

    Possible values: non-empty

    A grouping indicated by formatted text on the receipt or invoice.

    sku (string | null)

    Possible values: non-empty

    The Stock Keeping Unit (SKU) is the unique code associated with the product for the line item.

    tax_rate (number | null)

    The percent at which the individual or corporation is taxed for the line item.

    tax (number | null)

    The amount at which the individual or corporation is taxed for the product on this line item.

    total (number | null)

    The total price for this line item.

    subtotal (number | null)

    Total charges and credits before tip and tax, if applicable.

    unit_of_measure (string | null)

    Possible values: non-empty

    The unit of measurement for this line item.

    category (string | null)

    Possible values: non-empty

    The category is taken from the line item with the same SKU and/or description. Otherwise from the root category field.

    country_of_origin (string | null)

    Possible values: [UG, NF, US, FR, BS, BB, SY, AX, TK, NP, SH, AI, SN, CG, DE, UM, KG, ML, SM, MD, IE, PN, MU, SC, AW, TW, GE, CI, FO, RE, MH, TZ, MW, KM, CX, DK, CZ, BL, PE, ZA, IM, KW, LY, GT, LV, ET, TF, FK, JM, MO, ES, CH, AE, NI, GA, CL, PA, AF, PY, NZ, GI, SK, GB, PF, OM, MG, GF, IN, RS, CC, PW, PM, AT, MY, NE, GS, LK, WF, MP, PH, DZ, IL, PL, NG, RO, MX, LR, LU, SB, TR, FI, AD, CN, CO, AL, MR, ER, BD, AR, MZ, LI, KE, TO, NA, SD, GW, AO, KY, GY, BR, LB, CF, JE, YT, RU, NR, TT, EE, IS, TM, RW, SA, BG, HM, DM, BA, MV, PK, TL, IQ, KR, BI, LC, VU, GP, SI, MK, SL, KN, BM, AU, MM, AQ, BO, ID, TN, MQ, CU, JO, GD, GH, IR, GM, PR, KI, HR, SO, SR, CR, TV, UY, VI, HN, PG, GN, BY, SZ, UA, BZ, SJ, NL, DO, MF, TC, EG, FM, EC, LT, QA, CK, TG, PT, GL, IT, VC, ZM, MA, NC, AN, HT, SE, DJ, VA, FJ, NU, TJ, GG, VE, KZ, VG, KH, BV, BF, CV, UZ, VN, CM, MC, AS, BH, AG, CY, GU, LS, BJ, IO, LA, SG, HU, BN, TH, TD, AZ, GQ, ME, MS, BW, NO, WS, MN, EH, HK, ST, BT, BE, JP, KP, MT, SV, ZW, GR, PS, AM, YE, CA, CD]

    The country of manufacture, production, design, or brand origin where the product comes from.

    custom_fields CustomFields

    A user-defined dictionary that contains all the custom fields generated by applying specific rules and regular expressions to the extracted data.

    product_details object[]

    Product lookup details

  • Array [
    • avg_price (number | null)required

    The average price of the product

    brand (string | null)required

    Possible values: non-empty

    The brand name of the product

    ean (string | null)required

    Possible values: non-empty

    European Article Number (EAN) of the product

    extra_fields (object | null)required

    Additional fields for the product details

    gtin_14 (string | null)required

    Possible values: non-empty

    Global Trade Item Number (GTIN-14) of the product

    match_score (number | null)required

    Possible values: <= 1

    The match score of the product

    image (string | null)required

    Possible values: non-empty

    The image URL of the product

    image_url (string | null)required

    Possible values: non-empty

    Alternative field for the image URL of the product

    product_name stringrequired

    Possible values: non-empty

    The name of the product

    segment (string | null)required

    Possible values: non-empty

    The market segment of the product

    veryn stringrequired

    Possible values: non-empty

    The veryn identifier of the product

  • ]
    • end_date date

    A service end date identified for the line item in ISO 8601 format.

    gross_total (number | null)

    The line item total before deductions.

    hsn (string | null)

    Possible values: non-empty

    The Harmonized System Nomenclature (HSN) found for the line item.

    lot (string | null)

    Possible values: non-empty

    The batch or lot number for the line item.

    start_date date

    A service start date identified for the line item in ISO 8601 format.

    tax_code (string | null)

    Possible values: non-empty

    The classification of goods and services for tax purposes for the line item.

    manufacturer (string | null)

    Possible values: non-empty

    The name of the manufacturer of the product for the line item.

    net_total (number | null)

    The line item total after deductions.

    upc (string | null)

    Possible values: non-empty

    The Universal Product Code (UPC), European Article Number (EAN), or Global Trade Item Number (GTIN) found for the line item on this document will be placed in this field.

    weight (string | null)

    Possible values: non-empty

    The weight of the item for the line item. Usually found on logistic invoices.

  • ]
Loading...