Financial holds
You can use financial holds to prevent financial transactions from being included in financial messages, and, consequently, from being paid.
You can attach a financial hold to several entities, including claims, providers and financial transaction sets. Once the hold is attached, it affects all financial transactions that are linked to the entity with the hold. Financial holds do not affect any other process, such as claim finalization or general financial processing.
You can attach financial holds to an entity either through the generic HTTP API or through the user interface.
A financial hold:
-
prevents all financial transactions, waiting to be included in a financial message at the time the hold is attached, from being included in a financial message until the hold is released or expired.
-
prevents financial transactions, created after the hold is attached, from being included in a financial message until the hold is released or expired.
One single financial transaction can be affected by multiple financial holds. Such financial transactions can only be included in a financial message once all financial holds are released or expired.
If a financial hold affects a financial transaction, the application also holds all unprocessed financial transactions in the same base financial object. This prevents the application from sending out financial transactions that are subsequent versions of the version that is still on hold.
The ability to remove a financial hold is controlled through access permission configuration.
Entity | Affected Financial Transactions |
---|---|
Claim |
All financial transactions produced by that claim |
Claim Transaction |
The financial transactions produced by that claim transaction and all subsequent claim transactions |
Provider |
All financial transactions on which this provider is either the counterparty or the payment beneficiary |
Product |
All financial transactions that can be linked back to this product. |
Financial Transaction Set |
All financial transactions in the set. It is not possible to start the Generate Financial Message process for this set. |
In the scenario that a hold only applies to a single detail of a financial transaction, the financial transaction is still on hold in its entirety.
For example, if a financial transaction has three financial transaction details, each with a different provider as the payment beneficiary, then a hold on just one of these providers affects the entire transaction, and consequently the other two providers.