On this page
No Headings
The conditional rules associated with the payment term of the invoice. Includes early payment discount, late payment surcharge, and auto cancellation details.
objectearly_payment_discountobjectThe early payment discount for the invoice. If the payer pays before the discount end date, the specified discount is applied.
discount_end_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 end date for the early payment discount, in Internet date and time format. For example, yyyy-MM-ddTz.
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 early payment discount percentage value.
amountobjectThe currency and amount for a financial transaction, such as a balance or payment due.
The early payment discount amount value.
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.is_appliedbooleanIndicates whether the particular rule is applied or not.
auto_cancellationobjectThe auto cancellation details for the invoice. If the payer does not pay by the specified date, the invoice is automatically cancelled.
cancel_by_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 by which the invoice is automatically cancelled if unpaid, in Internet date and time format. For example, yyyy-MM-ddTz.
is_appliedbooleanIndicates whether the particular rule is applied or not.