On this page
No Headings
An array of invoice line item information. The maximum items for an invoice is 100.
objectidstring^[\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 currency and amount for a financial transaction, such as a balance or payment due.
The 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_coderequiredstring^[\S\s]*$The 3-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 information. Includes the tax name and tax rate of invoice items. The tax amount is added to the item total.
The 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.
percentrequiredobject^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as 19.99.
The tax rate. Value is from 0 to 100. Supports up to five decimal places.
amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The calculated tax amount. The tax amount is added to the item total.
currency_coderequiredstring^[\S\s]*$The 3-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_dateobject^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$The stand-alone date, in Internet date and time format. To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard date_time type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.
The date when the item or service was provided, in Internet date and time format. For example, yyyy-MM-ddTz.
discountobjectThe discount as a percent or amount at invoice level. The invoice discount amount is subtracted from the item total.
percentobject^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$The percentage, as a fixed-point, signed decimal number. For example, define a 19.99% interest rate as 19.99.
The discount as a percentage value. Value is from 0 to 100. Supports up to five decimal places.
amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The invoice level discount amount. Value is from 0 to 1000000. Supports up to two decimal places.
currency_coderequiredstring^[\S\s]*$The 3-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_measureobject"QUANTITY", "HOURS", "AMOUNT"The unit of measure for the invoiced item.
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.