PUT
/
LineItem
/
{lineItemId}
curl --request PUT \
  --url https://api-sandbox.payabli.com/api/LineItem/{lineItemId} \
  --header 'Content-Type: application/json' \
  --header 'requestToken: <api-key>' \
  --data '{
  "itemProductCode": "M-DEPOSIT",
  "itemProductName": "Materials deposit",
  "itemDescription": "Deposit for materials.",
  "itemCommodityCode": "010",
  "itemUnitOfMeasure": "SqFt",
  "itemCost": 12.45,
  "itemQty": 1,
  "itemMode": 0,
  "itemCategories": [
    "<string>"
  ]
}'
{
  "responseText": "Success",
  "responseData": 708,
  "pageIdentifier": null,
  "isSuccess": true
}

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

Body

LineItemData object to modify
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:

12.45

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
enum<integer> | null

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

Available options:
0,
1,
2
itemCategories
(string | null)[]

Array of tags classifying item or product.

Response

200
application/json
Success

Response schema for line item operations.

isSuccess
boolean

Boolean indicating whether the operation was successful. A true value indicates success. A false value indicates failure.

Example:

true

responseText
string | null

Response text for operation: 'Success' or 'Declined'.

Example:

"Success"

pageIdentifier
string | null

Auxiliary validation used internally by payment pages and components.

Example:

null

responseData

If isSuccess = true, this contains the line item identifier. If isSuccess = false, this contains the reason of the error.

Was this page helpful?