On this page
No Headings
An array of invoice line-item information.
arrayitemsobjectAn array of invoice line item information. The maximum items for an invoice is 100.
idstring^[\S\s]*$The ID of the invoice line item.
namerequiredstring^[\S\s]*$The item name for the invoice line item.
descriptionstring^[\S\s]*$The item description for the invoice line item.
quantityrequiredstring\d+(.\d{1,5})?$The quantity of the item that the invoicer provides to the payer. Value is from -1000000 to 1000000. Supports up to five decimal places.
unit_amountrequiredobjectThe unit price of the item. This does not include tax and discount. Value is from -1000000 to 1000000. Supports up to two decimal places.
currency_coderequiredstringThe three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.taxobjectThe tax associated with the item. The tax amount is added to the item total. Value is from 0 to 100. Supports up to five decimal places.
namerequiredstring^[\s\S]*$The name of the tax applied on the invoice items.
percentrequiredstringppaas_common_percentage_v2^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The tax rate. Value is from 0 to 100. Supports up to five decimal places.
amountobjectThe calculated tax amount. The tax amount is added to the item total.
currency_coderequiredstringThe three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.tax_notestring^[\s\S]*$The tax note used to track the tax related data.
item_datestringppaas_date_notime_v2^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The date when the item or service was provided, in Internet date and time format. For example, yyyy-MM-ddTz.
discountobjectDiscount as a percent or amount at invoice level. The invoice discount amount is subtracted from the item total.
percentstringppaas_common_percentage_v2^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The discount as a percentage value. Value is from 0 to 100. Supports up to five decimal places.
amountobjectThe invoice level discount amount. Value is from 0 to 1000000. Supports up to two decimal places.
currency_coderequiredstringThe three-character ISO-4217 currency code that identifies the currency.
valuerequiredstring^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The value, which might be:
JPY that are not typically fractional.TND that are subdivided into thousandths.unit_of_measurestring"QUANTITY", "HOURS", "AMOUNT"^[\S\s]*$The unit of measure for the invoiced item. For AMOUNT the unit_amount and quantity are not shown on the invoice.
Note: If your specify different unit_of_measure values for the same invoice, the invoice uses the first value.