1. Employees
Payflow API
Spain
  • Spain
  • Colombia
  • Peru
  • Guides
    • API Integration guide
  • Definitions
    • Employees
      • Employee Statuses
      • Salary Concepts
    • Payments
      • Payment Lifecycle
  • Explore our Public API
    • Auth & Health
      • Health
      • Test an API Key
    • Company
      • Retrieve your Company Details
    • Employee
      • Retrieve an Employee
      • Retrieve all Employees
      • Retrieve all Employees (V1.1)
      • Create an Employee
      • Upsert Employees in Bulk
      • Update an Employee by Personal ID
      • Update an Employee by Payflow ID
      • Update an Employee by Payroll ID
    • Leaves
      • Retrieve all Employees on Leave
      • Create an Employee Leave
      • Remove an Employee Leave
    • Payments
      • Retrieve a Payment
      • Retrieve all Payments
      • Retrieve Employee Payments
      • Calculate Employee Available Amount
      • Request a Payment
      • Subscribe to Payment Updates
      • Mark Payments as Informed
    • Flexflow
      • Retrieve all Flexflow Transactions
      • Retrieve Employee Flexflow Transactions
  • Notifications Structure
    • Payment Updates
  • Schemas
    • Company
      • Company Response
    • Employee
      • ES | Create Employee Request
      • ES | Update Employee Request
      • ES | Employee Response
      • Create Employee Leave Request
    • Payment
      • Payment Response
      • Payment Response Convoluted
      • Payment Update
    • Flexflow
      • Employee Flexflow Transactions
    • Error
      • Generic Error Response
  1. Employees

Salary Concepts

Payflow supports two different methods for calculating the amount available for withdrawal through the EWA benefit: Salary-based calculation and Fixed available amount.
Understanding how these methods work is important when integrating employee salary data through the Public API.

Salary-based calculation#

By default, Payflow calculates the employee available amount based on the employee netSalary and the company calculation settings.
The netSalary field is considered the source of truth for available amount calculations.
If netSalary is not provided, Payflow automatically calculates it from the employee grossSalary and uses the calculated value instead.
Because of this behavior, we strongly recommend sending only one salary field (netSalary or grossSalary) when creating or updating employees through the Public API.
Sending both fields may lead to unexpected calculation results if the provided values do not match Payflow internal calculations.

Fixed available amount#

The Public API also allows companies to define a fixed availableAmount for an employee.
When this field is configured:
Payflow skips the standard salary-based calculation.
The employee available amount becomes the fixed configured value.
The amount is available from the first day of the payment cycle.
The available amount does not increase progressively during the cycle.
All employee withdrawals are deducted directly from this fixed amount.
Since salary-based calculations are no longer used in this mode, grossSalary and netSalary are internally cleared and set to 0, as they are no longer required for available amount calculations.

Restricted amount#

The Public API also supports a fixed restrictedAmount.
This value represents a portion of the employee salary that can never be withdrawn through EWA.
For example:
Employee salary: 1500
Restricted amount: 1000
In this case, the employee will never be able to withdraw more than 500.
Modified at 2026-06-05 10:53:52
Previous
Employee Statuses
Next
Payment Lifecycle
Built with