| BillingTreatmentId |
- Type
- reference
- Properties
- Create, Filter, Group, Sort
- Description
- The parent billing treatment for the billing treatment item.
- This field is a relationship field.
- Relationship Name
- BillingTreatment
- Relationship Type
- Lookup
- Refers To
- BillingTreatment
|
| BillingType |
- Type
- picklist
- Properties
- Create, Filter, Group, Restricted picklist, Sort, Update
- Description
- Defines when Subscription Management invoices a product or service
relative to when it’s provided to the customer. Advance billing
invoices a product or service before it's provided, while arrears
billing invoices a product or service after it has provided
Subscription Management evaluates billing type when calculating an
order product’s next billing date.
- Possible values are:
-
Advance – If the
order item is billed in advance, Subscription Management
evaluates the order’s billing day of month to choose the
nearest date on or before the order product’s start date. For
example, if a monthly order product’s start date is January
1, and the order’s billing day of month is 15, the next
billing date is December 15.
-
Arrears – If the
order item is billed in arrears, Subscription Management
evaluates the order’s billing day of month to choose the
nearest date after the order product’s start date. For
example, if a monthly order product’s start date is January 1
and the order’s billing day of month is 15, the order
product’s next billing date is January 15.
Arrears billing isn't available in
Subscription Management API Version 54.0.
|
| Controller |
- Type
- picklist
- Properties
- Create, Filter, Group, Restricted picklist, Sort, Update
- Description
- During the invoicing process, this field determines which value
Subscription Management uses when the billing schedule group and
billing schedule have a shared field with different values. For
example, when Controller has a value of
BillingScheduleGroup, if
the billing schedule's billing day of month is 5 while the billing
schedule group's billing day of month is 10, Subscription
Management uses the value of 10.
- In the Subscription Management API version 54.0, only BillingScheduleGroup is
supported.
- Possible values are:
|
| CurrencyIsoCode |
- Type
- picklist
- Properties
- Defaulted on create, Filter, Group, Restricted picklist, Sort
- Description
- Three-letter ISO 4217 currency code associated with the billing
treatment item.
|
| Description |
- Type
- textarea
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- Optional user-defined description for the billing treatment
item.
|
| FlatAmount |
- Type
- currency
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- The amount in terms of units of currency (such as $10 or $21.52)
to invoice from the order item. Used only when
Type has a value of FlatAmount.
|
| Handling0Amount |
- Type
- picklist
- Properties
- Create, Filter, Group, Restricted picklist, Sort, Update
- Description
- Shows how Subscription Management invoices billing period items
that have an amount of $0.
- Possible values are:
-
CreateInvoice—Create a $0 invoice line.
- Null —No invoice line is created.
|
| LastReferencedDate |
- Type
- dateTime
- Properties
- Filter, Nillable, Sort
- Description
- The timestamp when the current user last accessed this record, a
record related to this record, or a list view.
|
| LastViewedDate |
- Type
- dateTime
- Properties
- Filter, Nillable, Sort
- Description
- The timestamp when the current user last viewed this record or
list view. If this value is null, the user might have only accessed
this record or list view (LastReferencedDate) but not viewed
it.
|
| Name |
- Type
- string
- Properties
- Create, Filter, Group, idLookup, Sort, Update
- Description
- Required. Default name of this record.
|
| Percentage |
- Type
- percent
- Properties
- Create, Filter, Nillable, Sort, Update
- Description
- The percentage (such as 10% or 12.5%) to invoice from the order
item. Used only when Type has a value of
Percentage.
|
| ProcessingOrder |
- Type
- int
- Properties
- Create, Filter, Group, Sort, Update
- Description
- Defines the order in which Subscription Management creates billing
schedules based on each billing treatment item. Lower numbers are
evaluated first. For example, if your billing treatment has a
billing treatment item that invoices at 25
Percentage and a
ProcessingOrder of 1, and another item that
invoices at 75 Percentage and a
ProcessingOrder of 2, your first billing
schedule will be for 25 percent of the order item's total amount,
and your second billing schedule will be for 75% of the order
item's total amount.
|
| Sequencing |
- Type
- picklist
- Properties
- Create, Filter, Group, Restricted picklist, Sort, Update
- Description
- Allows users to define the number used to start invoice numbers on
invoices generated from this billing treatment item.
- Subscription Management API Version 54.0 supports only manual
sequencing.
- Possible values are:
-
Manual—Invoices
created from this billing treatment item begin with an
invoice number of 1.
|
| Status |
- Type
- picklist
- Properties
- Create, Filter, Group, Restricted picklist, Sort, Update
- Description
- Draft billing treatment items aren't evaluated for creating
billing schedules.
- Possible values are:
|
| Type |
- Type
- picklist
- Properties
- Create, Filter, Group, Restricted picklist, Sort, Update
- Description
- Defines whether billing schedules created from this billing
treatment item are based on a flat amount or a percentage of the
order item's total amount.
- Possible values are:
-
FlatAmount—The
billing schedule is for a flat currency amount of the order
item's total amount (for example, $50 or $200.50.)
-
Percentage—The
billing schedule is for a percentage of the order item's
total amount (for example, 12.5% or 54%).
|
j