GET
/
LineItem
/
{lineItemId}

Authorizations

requestToken
string
header
required

Most endpoints require an organization token. Some endpoints require an application token, and those endpoints are noted.

Path Parameters

lineItemId
integer
required

ID for the line item (also known as a product, service, or item).

Required range: x > 0

Response

200 - application/json
itemCost
number
required

Item or product price per unit.

itemProductName
string | null
required

Item or product name. Max length of 250 characters.

Maximum length: 250
itemQty
integer
required

Quantity of item or product.

createdAt
string

Timestamp of when line item was created, in UTC.

id
integer

Identifier of line item.

itemCategories
(string | null)[]

Array of tags classifying item or product.

itemCommodityCode
string | null

Item or product commodity code. Max length of 250 characters.

Maximum length: 250
itemDescription
string | null

Item or product description. Max length of 250 characters.

Maximum length: 250
itemMode
integer | null

Internal class of item or product: value '0' is only for invoices , '1' for bills, and '2' common for both.

itemProductCode
string | null

Item or product code. Max length of 250 characters.

Maximum length: 250
itemUnitOfMeasure
string | null

Unit of measurement. Max length of 100 characters.

Maximum length: 100
lastUpdated
string | null

Timestamp of when the line item was updated, in UTC.

pageidentifier
string | null

Auxiliary validation used internally by payment pages and components.

ParentOrgName
string | null

The name of the paypoint's parent organization.

PaypointDbaname
string | null

The paypoint's DBA name.

PaypointEntryname
string | null

The paypoint's entryname (entrypoint) value.

Maximum length: 50
PaypointLegalname
string | null

The paypoint's legal name.

Was this page helpful?