MuleSoft Accelerator for Life Sciences icon

MuleSoft Accelerator for Life Sciences

(0 reviews)

Use case 2 - Site payment modernization

Automate the process of paying sites for clinical trial services, saving time and reducing technical debt


While clinical trial innovations continues to advance, the typical site payment process remains cumbersome and time-consuming for both sponsors and sites. Having a modern and automated site payment process is an advantage that could aid sponsors in contracting with top sites and retaining them throughout the trial.

This use case enables life sciences organizations to streamline the task of paying sites for the services they deliver during the trial. By automating this process through the use of APIs, these organizations will:

  • Improve sites relations and differentiate from other sponsors
  • Reduce costs associated with manual tracking or reconciliation
  • Decrease time to market of new life saving drugs

Use case description

This use case provides the necessary API specifications and implementation templates to take site payment requests created in Veeva CTMS and generate journal entries in SAP. Once the journal entry is processed and the site has been paid, the integration powered by the MuleSoft applications will update Veeva to reflect relevant payment information.


CTMS (Clinical Trial Management System)Software system used to manage clinical trials in clinical research. Serves as a single, centralized, web-based enterprise resource to support clinical research studies.Veeva CTMS
InvestigatorAn individual who conducts a clinical investigation (that is, under whose immediate direction the drug is dispensed to a subject).Jane Smith
SitesA site refers to the entity that coordinates and collects data from the clinical trial patients, or subjects.Usually a hospital or clinic
StudiesA clinical study involves research using human volunteers (also called participants or subjects) that is intended to add to medical knowledge.New drug clinical study
SubjectAn individual who participates in a clinical trial either as a recipient of the investigational product or as a control. The term is part of the federal regulation and may be used interchangeably with participant.John Doe
CROClinical Research Organization (CRO), is an organization contracted by another company to take the lead in managing that company’s trials and complex medical testing responsibilities.Mythical CRO
Journal EntryJournal Entry is a record of a business transaction in Financial Accounting.Invoices, Receipts, Checks
Vault PaymentsAdd-on application to Veeva Vault CTMS that provides users with the ability to configure fee templates and schedules, generate payable items, and create payment requests within existing trial management workflows.N/A
Fee ScheduleStores negotiated reimbursement rates between the sponsor/CRO and site.N/A

High-level architecture

The following diagram represents the portion of the overall solution that pertains to the Site payment modernization use case.

Architecture diagram for site payment modernization


  1. The Clinical Trials Operations manager creates payment requests in Veeva CTMS comprised of payable items owed to a site.
  2. On a scheduled basis, the process is triggered to retrieve the payment request(s) with Ready for Payment lifecycle state from Veeva CTMS.
  3. For each payment request, create a journal entry in SAP S/4HANA using the SAP S/4HANA Cloud Journal Entry API.
  4. Update the payment request lifecycle state to Extracted for Payment.
  5. User performs the necessary steps to payout the journal entry in SAP S/4HANA.
  6. On a scheduled basis, which can be configured per requirements, the process is triggered to retrieve the payouts from SAP S/4HANA using the Operational Journal Entry Item API.
  7. Update the payment request lifecycle state to Payment Completed along with the payment information.

Sequence diagrams of processing views

The diagrams below illustrate the sequence of site payments processing between Veeva CTMS and SAP S/4HANA.

Create Journal Entry for Payment Requests

The site payment process provides a means for pharmaceutical companies and CROs to pay sites for the services they deliver during the process of a clinical trial. The process triggers on a scheduled run, retrieves the list of payment requests that are in ‘Ready for Payment’ lifecycle state, creates a journal entry in SAP S/4HANA and then updates the lifecycle state to ‘Extracted for Payment’.

Sequence diagram for creating journal entry in SAP

Update payment request payout

The process triggers on a scheduled run, retrieves the list of payments from SAP S/4HANA that have been cleared from last run and updates the payment details and lifecycle state to ‘Payment Completed’.

Sequence diagram for updating payment details in Veeva CTMS

Assumptions and constraints

The following will be used to guide or constrain the solution design at a high level:

  • Vault Connector VQL capabilities are used to retrieve payment requests from the CTMS
  • Vault Connector REST API capabilities are used to update the lifecycle state and payment information into Veeva CTMS
  • This integration is triggered through the creation and approval of a payment request which is made up of payable item(s)
  • SAP S/4HANA will be used to pay study sites using SAP S/4HANA Cloud Journal Entry and Operation Journal Entry Item APIs
  • The ID in Veeva CTMS Payment Request object ( must be 16 or fewer characters due to a limit imposed on external IDs (DocumentReferenceId) in SAP
  • For further setup instructions, refer to Site Payments Process API Prerequisites page

Before you begin

bulb.png The Accelerators set up guide provides general information on getting started with the accelerator components. This includes instructions on setting up your local workstation for configuring and deploying the applications.

Downloadable assets

System APIs

Process APIs


The following are links to related and supporting documentation:

back to top


Published by
MuleSoft Solutions
Published onJul 27, 2022
Contact nameMuleSoft Solutions
Asset overview

Asset versions for 1.1.x

Asset versions


Industry Vertical
HealthcareLife SciencesNo values left to add
Life SciencesNo values left to add