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/vXX.X/actions/standard/checkFinancialAuthority

Where XX.X is the latest API version.

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer TOKEN

Where TOKEN is your OAuth access 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.

{
    "inputs": [
        {
            "chkFinancialAuthorityInputRep": {
                "paymentDetailId": "0l2xx000000009hAAA"
            }
        }
    ]
}

This sample response is for the Check Financial Authority action.

[
    {
        "actionName": "checkFinancialAuthority",
        "errors": null,
        "invocationId": null,
        "isSuccess": true,
        "outcome": null,
        "outputValues": {
            "chkFinancialAuthorityOutputRep": {
                "errors": [
                    {
                        "code": "SF-0009-0303",
                        "message": "No User Financial Authority record was found for the current user."
                    }
                ],
                "userHasFinancialAuthority": false,
                "userId": "005xx000001X7oX"
            }
        },
        "sortOrder": -1,
        "version": 1
    }
]