API referenceShared resource endpointsLine items

Get item

Gets an item by ID.

Path parameters

lineItemIdintegerRequired

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

Headers

requestTokenstringRequired

Response

Success
itemCostdouble
Item or product price per unit.
itemQtyinteger
Quantity of item or product.
createdAtdatetime or null
Timestamp of when line item was created, in UTC.
idlong or null
Identifier of line item.
itemCategorieslist of optional strings or null
Array of tags classifying item or product.
itemCommodityCodestring or null<=250 characters
Item or product commodity code. Max length of 250 characters.
itemDescriptionstring or null<=250 characters
Item or product description. Max length of 250 characters.
itemModeinteger or null

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

itemProductCodestring or null<=250 characters
Item or product code. Max length of 250 characters.
itemProductNamestring or null<=250 characters
Item or product name. Max length of 250 characters.
itemUnitOfMeasurestring or null<=100 characters
Unit of measurement. Max length of 100 characters.
lastUpdateddatetime or null
Timestamp of when the line item was updated, in UTC.
pageidentifierstring or null
Auxiliary validation used internally by payment pages and components.
ParentOrgNamestring or null
The name of the paypoint's parent organization.
PaypointDbanamestring or null
The paypoint's DBA name.
PaypointEntrynamestring or null<=50 characters

The paypoint’s entryname (entrypoint) value.

PaypointLegalnamestring or null
The paypoint's legal name.

Errors