Check Financial Authority

Output representation of evaluating whether the current user has sufficient financial authority to approve a claim coverage payment detail, including whether payment is allowed and the user’s maximum approval amount.

JSON Example

1{
2  "errors": [],
3  "hasFinancialAuthority": true,
4  "isFinancialAuthorityConfigured": true,
5  "isPaymentAllowed": true,
6  "isSuccess": true,
7  "maximumApprovalAmount": 500.0,
8  "requestedBy": "005xx000001X7mv"
9}
Property Name Type Description Filter Group and Version Available Version
errors Error Detail[] List of errors, including error codes and messages, returned when the evaluation doesn’t allow payment. Empty when the user has sufficient authority. Typical conditions include no matching User Financial Authority (UFA) record, a maximum approval amount of zero, the payment detail amount exceeding the user’s limit, or no further approver in the management hierarchy. Big, 68.0 68.0
hasFinancial​Authority Boolean Indicates whether the current user has the financial authority to approve payment of the adjusted amount for the claim coverage payment detail record (true) or not (false). Big, 68.0 68.0
isFinancialAuthority​Configured Boolean Indicates whether a UFA record is configured for the current user for the payment detail’s product, financial type, and CCPD evaluation method (true) or not (false). Big, 68.0 68.0
isPaymentAllowed Boolean Indicates whether payment is allowed for the evaluated claim coverage payment detail (true) or not (false), based on the UFA record configuration, the user’s financial authority, and the current payment detail status. Big, 68.0 68.0
isSuccess Boolean Indicates whether the API operation is successful (true) or not (false). Big, 68.0 68.0
maximumApproval​Amount Double Maximum approval amount for the current user from the matched UFA record. This value is null when no matching UFA record is found. Big, 68.0 68.0
requestedBy String ID of the user whose financial authority was evaluated. This is the currently authenticated user who initiated the request. Big, 68.0 68.0