API referenceShared resource endpointsLine items

Get item

Gets an item by ID.

Authentication

requestTokenstring
API Key authentication via header

Path parameters

lineItemIdintegerRequired

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

Response

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

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

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

The paypoint’s entryname (entrypoint) value.

PaypointLegalnamestring
The paypoint's legal name.

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error
503
Service Unavailable Error