Salary Deduction Confirmation Submission

POST

/deductions/{payroll_id}/upload/{file_id}

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: https://${userPoolDomain}.auth.${region}.amazoncognito.com/oauth2/token

Scopes:

deduction_data_confirmation:submit-Can submit Confirmation Deduction data

Path Params

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --globoff --request POST '/deductions/12345/upload/6789?pay_date={{%24date.isoTimestamp}}' \
--header 'x-api-key: <api-key>' \
--header 'Authorization: Bearer <token>'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "deduction_data_confirmation": {
        "payroll_id": "01573af5-3bd9-489f-b454-2598d3fb5ec1",
        "pay_date": "2025-12-05T19:29:21.053Z",
        "id": "2708202515590000",
        "total_amount": 300,
        "employee_count": 3,
        "currency": "GBP",
        "deduction_data": [
            {
                "salary_deduction": {
                    "employee_id": "1a77f3b3-5102-4ecf-8724-2615b357e029",
                    "requested_deduction_amount": 100,
                    "confirmed_deduction_amount": 100
                }
            },
            {
                "salary_deduction": {
                    "employee_id": "142142cc-e924-4fcc-bf0a-57fd8ce935ba",
                    "requested_deduction_amount": 100,
                    "confirmed_deduction_amount": 0,
                    "deduction_amount_reason": "InsufficientFunds"
                }
            },
            {
                "salary_deduction": {
                    "employee_id": "5cfe2826-6aef-4666-8252-f99569f8bedb",
                    "requested_deduction_amount": 200,
                    "confirmed_deduction_amount": 200
                }
            }
        ]
    }
}

🟠401Unauthorised

🟠403Forbidden

🟠404Not Found

🟠409Conflict

🟠422Unprocessable Entity

Salary Deduction Data Request

Light Availability Check