Skip to main content

Create a line-item

POST 

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

Create a line-item

Request

Path Parameters

    document_id int64required

    The unique identifier of the document.

Body

    category object

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

    anyOf

    string

    country_of_origin object

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

    anyOf

    string

    date object

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

    anyOf

    string

    description object

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

    anyOf

    string

    discount_price object

    The lower price after discount.

    anyOf

    number

    discount_rate object

    The discount percentage that was applied to the line item.

    anyOf

    number

    discount object

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

    anyOf

    number

    end_date object

    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.

    anyOf

    string

    hsn object

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

    anyOf

    string

    order integer
    lot object

    The batch or lot number for the line item.

    anyOf

    string

    price object

    The unit price for the line item.

    anyOf

    number

    quantity object

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

    anyOf

    number

    reference object
    anyOf

    string

    section object

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

    anyOf

    string

    sku object

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

    anyOf

    string

    start_date object

    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.

    anyOf

    string

    tags string[]

    Possible values: non-empty

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

    tax_code object

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

    anyOf

    string

    manufacturer object

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

    anyOf

    string

    tax_rate object

    The percent at which the individual or corporation is taxed.

    anyOf

    number

    tax object

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

    anyOf

    number

    total object

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

    anyOf

    number

    subtotal object

    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.

    anyOf

    number

    type object

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

    anyOf

    string

    unit_of_measure object

    The unit of measurement for this line item.

    anyOf

    string

    upc object

    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.

    anyOf

    string

    weight object

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

    anyOf

    string

Responses

Document's line-item

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

    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...