Get document Line Items
GET/api/v8/partner/documents/:document_id/line-items
Retrieve document Line Items
Request
Path Parameters
The unique identifier of the document.
Responses
- 200
- 400
- 404
- 429
- 499
- 503
- 504
- default
List of document Line Items
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- ]
- ]
line_items object[]required
The unique number created to identify the Line Item object.
The value indicating the position of where the line item appears on the document.
Possible values: non-empty
A user-defined list of identifiers that help to categorize or flag particular types of line items.
Possible values: non-empty
and <= 1000 characters
The complete text returned for the line item, including prices, dates, etc.
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
.
The date found on the document and associated with the line item in ISO 8601 format.
Possible values: non-empty
and <= 1000 characters
The product or service's extracted name or description excluding date and price.
Possible values: non-empty
and <= 1000 characters
The item text including dates, weight, etc.
Possible values: non-empty
The line item description with expanded words
The lower price after discount.
The discount percentage that was applied to the line item.
The date found on the document and associated with the line item in ISO 8601 format.
The unit price for the line item.
The amount or number of units for the line item. This value is computable.
Possible values: non-empty
Possible values: non-empty
A grouping indicated by formatted text on the receipt or invoice.
Possible values: non-empty
The Stock Keeping Unit (SKU) is the unique code associated with the product for the line item.
The percent at which the individual or corporation is taxed.
The amount at which the individual or corporation is taxed for the product on this line item.
The total price for this line item. This value is computable.
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.
Possible values: non-empty
The unit of measurement for this line item.
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.
Possible values: [GW
, SR
, VU
, CN
, HN
, CG
, SV
, MD
, KW
, VI
, CO
, ZM
, MC
, LA
, AO
, UY
, HM
, AN
, PT
, MO
, PL
, SC
, CI
, GU
, BA
, AW
, MG
, NZ
, TJ
, BD
, AT
, GE
, GD
, FK
, IN
, RO
, KG
, LK
, NU
, TZ
, YE
, ZW
, CA
, NF
, CK
, BS
, UM
, GA
, GF
, PH
, PM
, SO
, GP
, AM
, SD
, SZ
, MH
, VN
, LV
, SN
, SI
, TH
, AG
, CF
, EC
, DZ
, PY
, ID
, CD
, PK
, GB
, GQ
, RE
, US
, TL
, DK
, UA
, PA
, HR
, MR
, ZA
, IQ
, MF
, BH
, NP
, BI
, JE
, VC
, TT
, DM
, TF
, MK
, KM
, MS
, GG
, TM
, AI
, MM
, AZ
, MT
, AQ
, TG
, NR
, CY
, AE
, CX
, GH
, SA
, KN
, WF
, LI
, EH
, CM
, SK
, AL
, GL
, TR
, KI
, MW
, NA
, CC
, PE
, BY
, MU
, LR
, LU
, SE
, RU
, RS
, ES
, TO
, HU
, MQ
, FJ
, IE
, QA
, RW
, BM
, WS
, TV
, MX
, KP
, BZ
, GR
, TC
, KE
, NG
, GM
, IR
, JM
, NE
, UG
, LY
, HT
, MN
, YT
, SJ
, NI
, AF
, AX
, BB
, SH
, DE
, CR
, GT
, IO
, GN
, NC
, SY
, EG
, FI
, PW
, GI
, BV
, CL
, TN
, IM
, ME
, VE
, AR
, CZ
, TD
, AU
, GS
, BO
, FR
, PF
, LS
, SL
, TW
, UZ
, BE
, BF
, EE
, BT
, BR
, JO
, IL
, MP
, ER
, KR
, OM
, SG
, KH
, FO
, MA
, NL
, JP
, BG
, ML
, NO
, VA
, LC
, CV
, GY
, IS
, LT
, FM
, BN
, MZ
, ST
, TK
, AD
, KY
, BL
, PN
, ET
, HK
, AS
, CU
, LB
, BJ
, DO
, PS
, MV
, PG
, PR
, MY
, SM
, SB
, CH
, VG
, KZ
, BW
, DJ
, IT
]
The country of manufacture, production, design, or brand origin where the product comes from.
custom_fields object
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
The average price of the product
Possible values: non-empty
The brand name of the product
Possible values: non-empty
European Article Number (EAN) of the product
Additional fields for the product details
Possible values: non-empty
Global Trade Item Number (GTIN-14) of the product
Possible values: <= 1
The match score of the product
Possible values: non-empty
The image URL of the product
Possible values: non-empty
Alternative field for the image URL of the product
Possible values: non-empty
The name of the product
Possible values: non-empty
The market segment of the product
Possible values: non-empty
The veryn identifier of the product
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.
The line item total before deductions.
Possible values: non-empty
The Harmonized System Nomenclature (HSN) found for the line item.
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.
Possible values: non-empty
The classification of goods and services for tax purposes for the line item.
Possible values: non-empty
The name of the manufacturer of the product for the line item.
The line item total after deductions.
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.
Possible values: non-empty
The weight of the item for the line item. Usually found on logistic invoices.
{
"line_items": [
{
"id": 0,
"order": 0,
"tags": [
"string"
],
"text": "string",
"type": "room",
"date": "2024-11-03",
"description": "string",
"full_description": "string",
"normalized_description": "string",
"discount_price": 0,
"discount_rate": 0,
"discount": 0,
"price": 0,
"quantity": 0,
"reference": "string",
"section": "string",
"sku": "string",
"tax_rate": 0,
"tax": 0,
"total": 0,
"subtotal": 0,
"unit_of_measure": "string",
"category": "string",
"country_of_origin": "GW",
"custom_fields": {},
"product_details": [
{
"avg_price": 0,
"brand": "string",
"ean": "string",
"extra_fields": {},
"gtin_14": "string",
"match_score": 0,
"image": "string",
"image_url": "string",
"product_name": "string",
"segment": "string",
"veryn": "string"
}
],
"end_date": "2024-11-03",
"gross_total": 0,
"hsn": "string",
"lot": "string",
"start_date": "2024-11-03",
"tax_code": "string",
"manufacturer": "string",
"net_total": 0,
"upc": "string",
"weight": "string"
}
]
}
User error
- application/json
- Schema
- Example (from schema)
Schema
- MALFORMED_PARAMETERS
Default value: fail
Default value: Malformed parameters
Default value: [object Object]
{}
Not found
- application/json
- Schema
- Example (from schema)
Schema
- NOT_FOUND
- DOCUMENT_NOT_FOUND
Default value: fail
Default value: Not found.
Default value: fail
Default value: Document Not Found
{}
Rate limit
- application/json
- Schema
- Example (from schema)
Schema
- YOU_HAVE_BEEN_RATE_LIMITED
Default value: fail
Default value: You have been rate limited
Default value: [object Object]
{}
User error
- application/json
- Schema
- Example (from schema)
Schema
- CLIENT_CLOSED_REQUEST_OR_LOST_CONNECTION
Default value: fail
Default value: Client closed request or lost connection
{}
Service is temporaly unavailable
- application/json
- Schema
- Example (from schema)
Schema
- SERVICE_IS_TEMPORALY_UNAVAILABLE_PLEASE_TRY_AGAIN_LATER
Default value: fail
Default value: Service is temporaly unavailable. Please try again later
{}
Gateway timeout. Returned if request takes more than 150 seconds. The request might finish successfully later.
- application/json
- Schema
- Example (from schema)
Schema
- GATEWAY_TIMEOUT
Default value: fail
Default value: Gateway timeout
{}
OperationStatus
- application/json
- Schema
- Example (from schema)
Schema
Default value: fail
{
"status": "fail",
"error": "string",
"details": [
{}
]
}