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

    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]

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

    date daterequired

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

    description stringrequired

    Possible values: non-empty

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

    full_description string

    Possible values: non-empty

    The item text including dates, weight, etc.

    normalized_description string

    Possible values: non-empty

    The line item description with expanded words

    discount_price number

    The lower price after discount.

    discount_rate numberrequired

    The discount percentage that was applied to the line item.

    discount numberrequired

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

    price numberrequired

    The unit price for the line item.

    quantity numberrequired

    The amount or number of units for the line item. This value is computable.

    reference stringrequired

    Possible values: non-empty

    section stringrequired

    Possible values: non-empty

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

    sku stringrequired

    Possible values: non-empty

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

    tax_rate numberrequired

    The percent at which the individual or corporation is taxed.

    tax numberrequired

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

    total numberrequired

    The total price for this line item. This value is computable.

    subtotal number

    New, added 2023-07-10. The total of a set of numbers that will later be added to another set of numbers, such as tip and tax. This value is computable.

    unit_of_measure stringrequired

    Possible values: non-empty

    The unit of measurement for this line item.

    category string

    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

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

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

    custom_fields object
    product_details object[]

    Product lookup details

  • Array [
  • ]
    • end_date date

    A service end date identified for the line item. An end date could be a flight arrival date or hotel departure date in ISO 8601 format.

    gross_total number

    The line item total before deductions.

    hsn string

    Possible values: non-empty

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

    lot string

    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. A start date could be a flight departure date or hotel arrival date in ISO 8601 format.

    tax_code string

    Possible values: non-empty

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

    manufacturer string

    Possible values: non-empty

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

    net_total number

    The line item total after deductions.

    upc string

    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

    Possible values: non-empty

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

  • ]
Loading...