Employee Bank Account Configuration

These endpoints let you manage bank account configurations specific to employees in the system. It allows you to retrieve, create, update, and delete employee-specific bank account configuration records.

Deprecated

Get Employee Bank Account Configuration

get

This endpoint is deprecated. Please use /v1/employees/{employeeId}/bank-account-configurations/histories instead.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

employeeIdstringRequiredExample: 0ab1c2d3-e4f5-6789-0123-456789abcdef

Responses

200

OK

application/json

idstringOptional

paymentMethodstring · enumOptionalPossible values:

updatedDateinteger · timestamp in millisecondsOptional

effectiveDatestring · dateOptional

YYYY-MM-DD

distributionMethodstringOptional

approvalStatusstring · enumOptionalPossible values:

400

Bad Request

get

/core/v1/employees/{employeeId}/bank-account-configurations

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/employees/0ab1c2d3-e4f5-6789-0123-456789abcdef/bank-account-configurations" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "id": "62b529c7-0cfb-4d34-8ef8-3be3ef0f911d",
  "employee": {
    "id": "62b529c7-0cfb-4d34-8ef8-3be3ef0f911d",
    "identificationNumber": "123456789abc",
    "name": "John Doe",
    "active": true
  },
  "paymentMethod": "TRANSFER",
  "updatedDate": 1700000000000,
  "effectiveDate": "2023-11-01",
  "distributionMethod": "PERCENTAGE",
  "defaultBankAccount": {
    "id": "2b1a24c6-cf5c-47c3-b6a5-df7911a26c51",
    "bankId": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
    "bank": {
      "id": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
      "code": "014",
      "name": "BCA",
      "llg": "146789"
    },
    "bankBranchId": "",
    "bankBranch": {
      "id": "0e5f074c-c929-11e6-9d9d-cec0c932ce01",
      "code": "BCA01",
      "name": "BCA Wisma Asia",
      "address": "Wisma Asia"
    },
    "accountNumber": "68492818391829",
    "accountName": "Bagus Seto",
    "beneficiaryId": "",
    "priority": 1,
    "currency": {
      "id": "d1ea18d8-a691-11e6-80f5-76304dec7066",
      "code": "IDR",
      "name": "Indonesian Rupiah",
      "baseCurrency": true
    },
    "percentage": 100,
    "amount": 0
  },
  "bankAccounts": [
    {
      "id": "2b1a24c6-cf5c-47c3-b6a5-df7911a26c51",
      "bankId": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
      "bank": {
        "id": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
        "code": "014",
        "name": "BCA",
        "llg": "146789"
      },
      "bankBranchId": "",
      "bankBranch": {
        "id": "0e5f074c-c929-11e6-9d9d-cec0c932ce01",
        "code": "BCA01",
        "name": "BCA Wisma Asia",
        "address": "Wisma Asia"
      },
      "accountNumber": "68492818391829",
      "accountName": "Bagus Seto",
      "beneficiaryId": "",
      "priority": 1,
      "currency": {
        "id": "d1ea18d8-a691-11e6-80f5-76304dec7066",
        "code": "IDR",
        "name": "Indonesian Rupiah",
        "baseCurrency": true
      },
      "percentage": 100,
      "amount": 0
    }
  ]
}

Deprecated

Update Bank Account Configuration

put

This endpoint is deprecated. Please use /v1/bank-account-configurations/approvals instead.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

employeeIdstringRequiredExample: 0ab1c2d3-e4f5-6789-0123-456789abcdef

Body

application/json

effectiveDatestring · dateOptional

YYYY-MM-DD

paymentMethodstring · enumRequiredPossible values:

distributionMethodstring · enumOptionalPossible values:

Responses

200

OK

application/json

idstringOptional

paymentMethodstring · enumOptionalPossible values:

updatedDateinteger · timestamp in millisecondsOptional

effectiveDatestring · dateOptional

YYYY-MM-DD

distributionMethodstringOptional

approvalStatusstring · enumOptionalPossible values:

400

Bad Request

put

/core/v1/employees/{employeeId}/bank-account-configurations

cURLPython SDK

curl -X PUT \
  "https://api.catapa.com/core/v1/employees/0ab1c2d3-e4f5-6789-0123-456789abcdef/bank-account-configurations" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id" \
  -H "Content-Type: application/json" \
  -d '...'

{
  "id": "62b529c7-0cfb-4d34-8ef8-3be3ef0f911d",
  "employee": {
    "id": "62b529c7-0cfb-4d34-8ef8-3be3ef0f911d",
    "identificationNumber": "123456789abc",
    "name": "John Doe",
    "active": true
  },
  "paymentMethod": "TRANSFER",
  "updatedDate": 1700000000000,
  "effectiveDate": "2023-11-01",
  "distributionMethod": "PERCENTAGE",
  "defaultBankAccount": {
    "id": "2b1a24c6-cf5c-47c3-b6a5-df7911a26c51",
    "bankId": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
    "bank": {
      "id": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
      "code": "014",
      "name": "BCA",
      "llg": "146789"
    },
    "bankBranchId": "",
    "bankBranch": {
      "id": "0e5f074c-c929-11e6-9d9d-cec0c932ce01",
      "code": "BCA01",
      "name": "BCA Wisma Asia",
      "address": "Wisma Asia"
    },
    "accountNumber": "68492818391829",
    "accountName": "Bagus Seto",
    "beneficiaryId": "",
    "priority": 1,
    "currency": {
      "id": "d1ea18d8-a691-11e6-80f5-76304dec7066",
      "code": "IDR",
      "name": "Indonesian Rupiah",
      "baseCurrency": true
    },
    "percentage": 100,
    "amount": 0
  },
  "bankAccounts": [
    {
      "id": "2b1a24c6-cf5c-47c3-b6a5-df7911a26c51",
      "bankId": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
      "bank": {
        "id": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
        "code": "014",
        "name": "BCA",
        "llg": "146789"
      },
      "bankBranchId": "",
      "bankBranch": {
        "id": "0e5f074c-c929-11e6-9d9d-cec0c932ce01",
        "code": "BCA01",
        "name": "BCA Wisma Asia",
        "address": "Wisma Asia"
      },
      "accountNumber": "68492818391829",
      "accountName": "Bagus Seto",
      "beneficiaryId": "",
      "priority": 1,
      "currency": {
        "id": "d1ea18d8-a691-11e6-80f5-76304dec7066",
        "code": "IDR",
        "name": "Indonesian Rupiah",
        "baseCurrency": true
      },
      "percentage": 100,
      "amount": 0
    }
  ]
}

Get Employee Bank Account Configuration Histories

get

Use this endpoint as a replacement for /v1/employees/{employeeId}/bank-account-configurations.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

employeeIdstringRequiredExample: 0ab1c2d3-e4f5-6789-0123-456789abcdef

Query parameters

pageintegerOptional

Page number

Default: 0Example: 0

sizeinteger · min: 1 · max: 50Optional

Page size

Default: 10Example: 10

Responses

200

OK

application/json

totalPagesintegerRequired

Total number of pages available

lastbooleanRequired

Indicates whether this is the last page

totalElementsintegerRequired

Total number of elements across all pages

numberOfElementsintegerRequired

Number of elements in the current page

firstbooleanRequired

Indicates whether this is the first page

sizeintegerRequired

Size of the page (number of elements per page)

numberintegerRequired

Current page number (zero-indexed)

400

Bad Request

get

/core/v1/employees/{employeeId}/bank-account-configurations/histories

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/employees/0ab1c2d3-e4f5-6789-0123-456789abcdef/bank-account-configurations/histories?page=0&size=10" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "62b529c7-0cfb-4d34-8ef8-3be3ef0f911d",
      "employee": {
        "id": "62b529c7-0cfb-4d34-8ef8-3be3ef0f911d",
        "identificationNumber": "123456789abc",
        "name": "John Doe",
        "active": true
      },
      "paymentMethod": "TRANSFER",
      "updatedDate": 1700000000000,
      "effectiveDate": "2023-11-01",
      "distributionMethod": "PERCENTAGE",
      "defaultBankAccount": {
        "id": "2b1a24c6-cf5c-47c3-b6a5-df7911a26c51",
        "bankId": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
        "bank": {
          "id": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
          "code": "014",
          "name": "BCA",
          "llg": "146789"
        },
        "bankBranchId": "",
        "bankBranch": {
          "id": "0e5f074c-c929-11e6-9d9d-cec0c932ce01",
          "code": "BCA01",
          "name": "BCA Wisma Asia",
          "address": "Wisma Asia",
          "bank": {
            "id": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
            "code": "014",
            "name": "BCA",
            "llg": "146789"
          }
        },
        "accountNumber": "68492818391829",
        "accountName": "Bagus Seto",
        "beneficiaryId": "",
        "priority": 1,
        "currency": {
          "id": "d1ea18d8-a691-11e6-80f5-76304dec7066",
          "code": "IDR",
          "name": "Indonesian Rupiah",
          "baseCurrency": true
        },
        "percentage": 100,
        "amount": 0
      },
      "bankAccounts": [
        {
          "id": "2b1a24c6-cf5c-47c3-b6a5-df7911a26c51",
          "bankId": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
          "bank": {
            "id": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
            "code": "014",
            "name": "BCA",
            "llg": "146789"
          },
          "bankBranchId": "",
          "bankBranch": {
            "id": "0e5f074c-c929-11e6-9d9d-cec0c932ce01",
            "code": "BCA01",
            "name": "BCA Wisma Asia",
            "address": "Wisma Asia",
            "bank": {
              "id": "8bf610cc-c83b-11e6-9d9d-cec0c932ce01",
              "code": "014",
              "name": "BCA",
              "llg": "146789"
            }
          },
          "accountNumber": "68492818391829",
          "accountName": "Bagus Seto",
          "beneficiaryId": "",
          "priority": 1,
          "currency": {
            "id": "d1ea18d8-a691-11e6-80f5-76304dec7066",
            "code": "IDR",
            "name": "Indonesian Rupiah",
            "baseCurrency": true
          },
          "percentage": 100,
          "amount": 0
        }
      ]
    }
  ],
  "pageable": {
    "sort": [],
    "offset": 0,
    "pageSize": 20,
    "pageNumber": 0,
    "paged": true,
    "unpaged": false
  },
  "last": true,
  "totalElements": 1,
  "totalPages": 1,
  "size": 20,
  "number": 0,
  "sort": [],
  "first": true,
  "numberOfElements": 1,
  "empty": false
}