Newer Version Available

This content describes an older version of this product. View Latest

PaymentTermItem

Defines the attributes of a payment term that your company uses. The PaymentTermItem is used to determine the due date on invoices. This object is available in API version 55.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Special Access Rules

This object is available when Subscription Management is enabled.

Fields

Field Details
Description
Type
textarea
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
User-defined field that describes the details of the payment term item.
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 accessed this record, a record related to this record, or a list view.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
An auto-generated sequential number, such as PTI-000001.
PaymentTermId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The ID of the payment term that this payment term item is associated with.
This field is a relationship field.
Relationship Name
PaymentTerm
Relationship Type
Lookup
Refers To
PaymentTerm
PaymentTimeframe
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
Indicates the time period when the payment is expected.
Possible values are:
  • Standard—Indicates that payment is expected by the date specified in the payment term. If payment isn't received by the due date, the payment becomes overdue.
The default value is Standard.
Period
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Specifies the number of units in the payment period. Used with the PeriodUnit field.
For example, to define a payment term of Net 30, enter 30 as the Period and select Days as the PeriodUnit.
PeriodUnit
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Specifies the unit of time for the payment period. Used with the Period field.
For example, to define a payment term of Net 30, enter 30 as the Period and select Days as the PeriodUnit.
Possible values are:
  • Days
Type
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update
Description
Specifies how the payment term and invoice due date are derived.
Possible values are:
  • Period-Based—Tells the system to use the Period and PeriodUnit fields to calculate the invoice due date.
The default value is Period-Based.