lineItem

Add item to entrypoint catalog

Adds products and services to an entrypoint's catalog. These are used as line items for invoicing and transactions. In the response, "responseData" displays the item's code.

post/LineItem/{entry}

Request

  • Base URL: https://api-sandbox.payabli.com/api
  • URL: https://api-sandbox.payabli.com/api/LineItem/{entry}
  • Auth: HTTP bearer

Path parameters

entrystring required

The paypoint's entrypoint identifier. Learn more

Headers

idempotencyKeystring

A unique ID you can include to prevent duplicating objects or transactions if a request is sent more than once. This key isn't generated in Payabli, you must generate it yourself.

Request body

itemCategoriesstring[]

Array of tags classifying item or product.

itemCommodityCodestring

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

itemCostnumber double required

Item or product price per unit.

itemDescriptionstring

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' is common for both.

itemProductCodestring

Item or product code. Max length of 250 characters.

itemProductNamestring

Item or product name. Max length of 250 characters.

itemQtyinteger required

Quantity of item or product.

itemUnitOfMeasurestring

Unit of measurement. Max length of 100 characters.

Response

Success

isSuccessboolean

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

pageIdentifierstring

Auxiliary validation used internally by payment pages and components.

responseTextstring required

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

Changes

No recorded changes to this operation across all 1 revision of this API.