Salary Payment

These endpoints let you manage salary payment features in the system. It allows you to process salary payments, retrieve payment records, and manage related configurations.

Get Salary Payments

get

Search Query

Supported Keys	Supported Operators	Notes
process	:	Equal operator
salaryPaymentSummary.id	:	Like operator
paymentDate	: > <	Equal operator Greater than or equal to Less than or equal to
employee.id	:	Equal operator

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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/salary-payments

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/salary-payments" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "string",
      "paymentMethod": "CASH",
      "paymentDate": "string",
      "organization": {
        "id": "string",
        "code": "string",
        "name": "string",
        "company": {
          "id": "string",
          "name": "string"
        }
      },
      "jobLevel": {
        "name": "string"
      },
      "jobTitle": {
        "name": "string"
      },
      "location": {
        "name": "string"
      },
      "employee": {
        "id": "string",
        "identificationNumber": "string",
        "name": "string",
        "employmentStatus": {
          "jobTitle": {
            "name": "string"
          },
          "employmentType": {
            "name": "string"
          },
          "costCenter": {
            "code": "string",
            "name": "string"
          }
        }
      },
      "salaryPaymentDetails": [
        {
          "id": "string",
          "bankCode": "string",
          "bankName": "string",
          "accountName": "string",
          "accountNumber": "string",
          "bankAccountPriority": 1,
          "currencyCode": "string",
          "amount": 0,
          "exchangedAmount": 0,
          "companyBankAccount": {
            "id": "550e8400-e29b-41d4-a716-446655440000",
            "name": "string",
            "companyCode": "string",
            "accountNumber": "string",
            "bankBranch": {
              "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
              "name": "string",
              "code": "string",
              "address": "string",
              "bank": {
                "id": "6ba7b811-9dad-11d1-80b4-00c04fd430c9",
                "code": "string",
                "name": "string",
                "llg": "string"
              },
              "currency": {
                "code": "string",
                "name": "string",
                "baseCurrency": true
              }
            }
          }
        }
      ]
    }
  ],
  "totalPages": 1,
  "totalElements": 1,
  "numberOfElements": 1,
  "size": 10,
  "number": 0,
  "first": true,
  "last": true,
  "sort": [
    {
      "direction": "ASC",
      "property": "id"
    }
  ]
}

Get Salary Payments Date

get

Return the salary payment dates.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

yearnumberOptionalExample: 2024

monthnumberOptionalExample: 1

Responses

200

OK

application/json

string[]Optional

400

Bad Request

get

/core/v1/salary-payments/dates

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/salary-payments/dates?year=2024&month=1" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

[
  "2020-01-01",
  "2020-01-20"
]

Deprecated

Get Processed Salary Payments

get

Search Query

Supported Keys	Supported Operators	Notes
year	:	Like operator
month	:	Like operator
salaryPaymentProcess	:	Like operator
salaryPaymentSummaryId	:	Like operator

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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/salary-payments/process/processable/processed

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/salary-payments/process/processable/processed" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "employeeId": "string",
      "locationGroupCode": "string",
      "paymentDate": "string",
      "salaryPaymentDetails": [
        {
          "accountNumber": "string"
        }
      ],
      "totalThp": 0
    }
  ],
  "totalPages": 1,
  "totalElements": 1,
  "numberOfElements": 1,
  "size": 10,
  "number": 0,
  "first": true,
  "last": true,
  "sort": [
    {
      "direction": "ASC",
      "property": "id"
    }
  ]
}

Get Payment Item Groups

get

Return the payment item groups.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequiredExample: f47ac10b-58cc-4372-a567-0e02b2c3d479

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/salary-payments/{id}/payment-item-groups

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/salary-payments/f47ac10b-58cc-4372-a567-0e02b2c3d479/payment-item-groups" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "id": "string",
      "paymentType": "string",
      "startProcessDate": "string",
      "endProcessDate": "string",
      "jobLevel": {
        "id": "string",
        "code": "string",
        "name": "string"
      },
      "location": {
        "id": "string",
        "code": "string",
        "name": "string"
      },
      "paymentItemDetails": [
        {
          "id": "string",
          "amount": 0,
          "salaryItem": {
            "id": "string",
            "code": "string",
            "name": "string",
            "salaryItemCategory": "string",
            "salaryItemType": "string",
            "thp": true
          }
        }
      ]
    }
  ],
  "totalPages": 1,
  "totalElements": 1,
  "numberOfElements": 1,
  "size": 10,
  "number": 0,
  "first": true,
  "last": true,
  "sort": [
    {
      "direction": "ASC",
      "property": "id"
    }
  ]
}

Get Processed Salary Payment Summaries

get

Search Query

Supported Keys	Supported Operators	Notes
exported	:	Like operator
bankId	:	Like operator
companyBankAccountId	:	Like operator
bankName	:	Like operator
year	: > <	Equal Greater than or equal to Less than or equal to
month	: > <	Equal Greater than or equal to Less than or equal to
numberOfProcessedEmployees	: > <	Equal Greater than or equal to Less than or equal to
paymentDate	: > <	Equal Greater than or equal to Less than or equal to

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

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/salary-payment-summaries

cURLPython SDK

curl -X GET \
  "https://api.catapa.com/core/v1/salary-payment-summaries" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Tenant: your-tenant-id"

{
  "content": [
    {
      "accountNumber": "string",
      "amount": 0,
      "id": "string",
      "numberOfProcessedEmployees": 0,
      "numberOfTransferredEmployees": 0,
      "paymentDate": "string",
      "transferredAmount": 0,
      "companyBankAccount": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "accountNumber": "string",
        "bankBranch": {
          "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
          "bank": {
            "id": "6ba7b811-9dad-11d1-80b4-00c04fd430c9",
            "code": "string",
            "name": "string"
          }
        }
      }
    }
  ],
  "totalPages": 1,
  "totalElements": 1,
  "numberOfElements": 1,
  "size": 10,
  "number": 0,
  "first": true,
  "last": true,
  "sort": [
    {
      "direction": "ASC",
      "property": "id"
    }
  ]
}