--- schema_version: "1" id: e2d6c734d1c369ef24695f7f8d466afa131d8f387cb0c70243bcdd93ba580e20 title: PaymentRequest collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/financial_services_cloud_object_reference/sforce_api_objects_paymentrequest.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_objects_paymentrequest.htm source_site: developer.salesforce.com content_type: documentation content_hash: 61189439bc4f1762d2d0df0d677651cfc32dd8d7b389869746240bdad2db203f description: 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. --- # 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](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_change_event.htm "A ChangeEvent object is available for each object that supports Change Data Capture. You can subscribe to a stream of change events using Change Data Capture to receive data tied to record changes in Salesforce. Changes include record creation, updates to an existing record, deletion of a record, and undeletion of a record. A change event isn’t a Salesforce object—it doesn’t support CRUD operations or queries. It’s included in the object reference so you can discover which Salesforce objects support change events.") Change events are available for the object in API version 63.0 and later. [PaymentRequestFeed](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_feed.htm "StandardObjectNameFeed is the model for all feed objects associated with standard objects. These objects represent the posts and feed-tracked changes of a standard object.") Feed tracking is available for the object. [PaymentRequestHistory](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_history.htm "StandardObjectNameHistory is the model for all history objects associated with standard objects. These objects represent the history of changes to the values in the fields of a standard object.") History is available for tracked fields of the object. [PaymentRequestOwnerSharingRule](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_ownersharingrule.htm "StandardObjectNameOwnerSharingRule is the model for all owner sharing rule objects associated with standard objects. These objects represent a rule for sharing a standard object with users other than the owner.") Sharing rules are available for the object. [PaymentRequestShare](https://developer.salesforce.com/docs/atlas.en-us.financial_services_cloud_object_reference.meta/financial_services_cloud_object_reference/sforce_api_associated_objects_share.htm "StandardObjectNameShare is the model for all share objects associated with standard objects. These objects represent a sharing entry on the standard object.") Sharing is available for the object.