Check Financial Authority Action

Check whether the currently authenticated user has sufficient financial authority to approve a claim coverage payment detail record.

This action is available in API version 68.0 and later.

Supported REST HTTP Methods

URI: /services/data/v68.0/actions/standard/checkFinancialAuthority

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer token

Inputs

Input Type Description
chkFinancialAuthorityInputRep Apex-defined Required. An Apex ConnectApi.ChkFinancialAuthorityInputRep record that contains the ID of the claim coverage payment detail record to check the user's financial authority.

Outputs

Output Type Description
chkFinancialAuthorityOutputRep Apex-defined An Apex ConnectApi.ChkFinancialAuthorityOutputRep record that contains the result of the financial authority evaluation.

Example

POST

This sample request is for the Check Financial Authority action.

1{
2    "inputs": [
3        {
4            "chkFinancialAuthorityInputRep": {
5                "paymentDetailId": "0l2xx000000009hAAA"
6            }
7        }
8    ]
9}

This sample response is for the Check Financial Authority action.

1[
2    {
3        "actionName": "checkFinancialAuthority",
4        "errors": null,
5        "invocationId": null,
6        "isSuccess": true,
7        "outcome": null,
8        "outputValues": {
9            "chkFinancialAuthorityOutputRep": {
10                "errors": [
11                    {
12                        "code": "SF-0009-0303",
13                        "message": "No User Financial Authority record was found for the current user."
14                    }
15                ],
16                "userHasFinancialAuthority": false,
17                "userId": "005xx000001X7oX"
18            }
19        },
20        "sortOrder": -1,
21        "version": 1
22    }
23]