PaymentRequest

Represents a financial compensation request for goods or services provided by a third party. This object is available in API version 60.0 and later.

Supported Calls

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

Special Access Rules

To access this object on your Public Sector org, Benefit Disbursement must be enabled and you must have the Benefit Disbursement Access permission set or the Benefit Disbursement permission set license.

Fields

ClaimId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The claim associated with the payment request.

This field is a relationship field.
Relationship Name: Claim
Relationship Type: Lookup
Refers To: Claim

DueDate

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The due date of the payment request.

EndDateTime

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The end date of services represented in the payment request.

FacilityId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The facility associated with the payment request.

This field is a polymorphic relationship field.
Relationship Name: Facility
Relationship Type: Lookup
Refers To: Account, HealthcareFacility, Location

InsurancePolicyId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The insurance policy associated with the payment request.

This field is a relationship field.
Relationship Name: InsurancePolicy
Relationship Type: Lookup
Refers To: InsurancePolicy

LastReferencedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp for when the current user last viewed a record related to this record.

LastViewedDate

Type: dateTime
Properties: Filter, Nillable, Sort
Description: The timestamp for when the current user last viewed this record. If this value is null, it’s possible that this record was referenced (LastReferencedDate) and not viewed.

Name

Type: string
Properties: Create, Filter, Group, idLookup, Sort, Update
Description: Required. The name of the payment request.

OwnerId

Type: reference
Properties: Create, Defaulted on create, Filter, Group, Sort, Update
Description: ID of the record owner.

This field is a polymorphic relationship field.
Relationship Name: Owner
Relationship Type: Lookup
Refers To: Group, User

PaymentInstructionStatus

Type: picklist
Properties: Filter, Group, Nillable, Restricted picklist, Sort
Description: Payment status from the associated PaymentInstruction. This field is auto-populated.
Possible values:
- NotPaid
- Overpaid
- Paid
- Partial

ReceivedDate

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The date on which the recipient received the payment request.

ReceivedMethod

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The method in which the payment request was received.
Possible values:
- Electronic Submission
- Paper Mail

ReferenceNumber

Type: string
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: External unique identifier from the submitting party, such as an invoice number.

RemittanceAccountId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The account that receives the remittance payment for the services.

This field is a polymorphic relationship field.
Relationship Name: RemittanceAccount
Relationship Type: Lookup
Refers To: Account

ServiceProviderId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The service provider associated with the payment request.

This field is a polymorphic relationship field.
Relationship Name: ServiceProvider
Relationship Type: Lookup
Refers To: Account, Contact, HealthcareProvider

ServiceRecipientId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The account that receives the services in the payment request.

This field is a polymorphic relationship field.
Relationship Name: ServiceRecipient
Relationship Type: Lookup
Refers To: Account, Contact

StartDateTime

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The start date of services represented in the payment request.

Status

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Status of the payment request.
Possible values:
- Paid
- Received

SubmissionType

Type: picklist
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: Type of payment request submission, such as an invoice from a service provider.
Possible values:
- Invoice
- Online Submission

SubmittedDate

Type: dateTime
Properties: Create, Filter, Nillable, Sort, Update
Description: The date on which the service provider submitted the payment request.

SubmittingAccountId

Type: reference
Properties: Create, Filter, Group, Nillable, Sort, Update
Description: The billing account that submits the payment to the service recipient.

This field is a relationship field.
Relationship Name: SubmittingAccount
Relationship Type: Lookup
Refers To: Account

TotalAdjustmentAmount

Type: currency
Properties: Filter, Nillable, Sort
Description: Total amount that is adjusted, such as the collection of a copay onsite.

This field is a calculated field.

TotalRequestedAmount

Type: currency
Properties: Filter, Nillable, Sort
Description: Total amount requested for reimbursement.

This field is a calculated field.

TotalServiceAmount

Type: currency
Properties: Filter, Nillable, Sort
Description: Total amount of the services, such as the total services billed.

This field is a calculated field.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

PaymentRequestFeed: Feed tracking is available for the object.
PaymentRequestHistory: History is available for tracked fields of the object.
PaymentRequestOwnerSharingRule: Sharing rules are available for the object.
PaymentRequestShare: Sharing is available for the object.