PaymentRequest

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

Supported Calls

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

Special Access Rules

This object is available if the add-on license for Claims Management is enabled. 

Fields

ClaimId

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

    This 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 is a polymorphic relationship field.

  • Relationship Name: Facility
  • Relationship Type: Lookup
  • Refers To: Account, Location

InsurancePolicyId

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

    This 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: The name of the Payment Request.

OwnerId

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

    This is a polymorphic relationship field.

  • Relationship Name: Owner
  • Relationship Type: Lookup
  • Refers To: Group, User

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 include:
    • 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 is a polymorphic relationship field.

  • Relationship Name: RemittanceAccount
  • Relationship Type: Lookup
  • Refers To: Account, InsurancePolicyParticipant

ServiceProviderId

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

    This is a polymorphic relationship field.

  • Relationship Name: ServiceProvider
  • Relationship Type: Lookup
  • Refers To: Account, Contact

ServiceRecipientId

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

    This is a polymorphic relationship field.

  • Relationship Name: ServiceRecipient
  • Relationship Type: Lookup
  • Refers To: Account, Contact, InsurancePolicyParticipant

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 include:
    • 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 include:
    • 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 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 is a calculated field.

TotalRequestedAmount

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

    This is a calculated field.

TotalServiceAmount

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

    This is a calculated field.

Usage

Use this object to process inbound requests for payments, such as an inbound invoice submitted to an insurance carrier.

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.

PaymentRequestChangeEvent
Change events are available for the object in API version 63.0 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.