GET
/
LineItem
/
{lineItemId}
curl --request GET \
  --url https://api-sandbox.payabli.com/api/LineItem/{lineItemId} \
  --header 'requestToken: <api-key>'
{
  "itemProductCode": "M-DEPOSIT",
  "itemProductName": "Materials deposit",
  "itemDescription": "Deposit for materials.",
  "itemCommodityCode": "010",
  "itemUnitOfMeasure": "SqFt",
  "itemCost": 5,
  "itemQty": 1,
  "itemMode": 0,
  "itemCategories": [
    "<string>"
  ],
  "id": 45,
  "lastUpdated": "2022-07-01 15:00:01",
  "createdAt": "2022-07-01 15:00:01",
  "pageidentifier": "null",
  "PaypointLegalname": "Sunshine Services, LLC",
  "PaypointDbaname": "Sunshine Gutters",
  "PaypointEntryname": "d193cf9a46",
  "ParentOrgName": "PropertyManager Pro"
}

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
Success
itemProductName
string | null
required

Item or product name. Max length of 250 characters.

Maximum length: 250
Example:

"Materials deposit"

itemCost
number
required

Item or product price per unit.

Example:

5

itemQty
integer
required

Quantity of item or product.

Example:

1

itemProductCode
string | null

Item or product code. Max length of 250 characters.

Maximum length: 250
Example:

"M-DEPOSIT"

itemDescription
string | null

Item or product description. Max length of 250 characters.

Maximum length: 250
Example:

"Deposit for materials."

itemCommodityCode
string | null

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

Maximum length: 250
Example:

"010"

itemUnitOfMeasure
string | null

Unit of measurement. Max length of 100 characters.

Maximum length: 100
Example:

"SqFt"

itemMode
integer | null

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

Example:

0

itemCategories
(string | null)[]

Array of tags classifying item or product.

id
integer

Identifier of line item.

Example:

45

lastUpdated
string | null

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

Example:

"2022-07-01 15:00:01"

createdAt
string

Timestamp of when line item was created, in UTC.

Example:

"2022-07-01 15:00:01"

pageidentifier
string | null

Auxiliary validation used internally by payment pages and components.

Example:

null

PaypointLegalname
string | null

The paypoint's legal name.

Example:

"Sunshine Services, LLC"

PaypointDbaname
string | null

The paypoint's DBA name.

Example:

"Sunshine Gutters"

PaypointEntryname
string | null

The paypoint's entryname (entrypoint) value.

Maximum length: 50
Example:

"d193cf9a46"

ParentOrgName
string | null

The name of the paypoint's parent organization.

Example:

"PropertyManager Pro"

Was this page helpful?