1. Flexflow 2.0
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
    • Flexflow 2.0
      • Retrieve Flexflow Benefits by Cycle
        GET
  • Notifications Structure
    • Payment Updates
  • Raíz
  • 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
    • FlexflowBenefitsResponse
    • EmployeeFlexflowBenefits
    • BenefitLine
    • BenefitTotals
    • PaginationMeta
  1. Flexflow 2.0

Retrieve Flexflow Benefits by Cycle

Production
https://api-public.payflow.es
Production
https://api-public.payflow.es
GET
https://api-public.payflow.es
/v2/flexflow/cycles/{cycle}/consumptions
Retrieves, in a single call, the Flexible Compensation and Social Benefit consumptions of the employees for the cycle specified in the cycle path parameter. Each amount is labeled by category, benefit type and tax treatment (exempt or non-exempt).
The response groups the consumptions by employee. Each employee includes one line per combination of category, benefitType and taxTreatment, plus the totals for that employee.

Filtering behavior#

If no filter is provided, the endpoint returns the whole cycle for all employees in the company.
If a taxId is provided, the endpoint returns data only for employees assigned to that subsidiary.
If a personalId is provided, the endpoint returns data only for that employee. In this case taxId is ignored.
benefitType, taxTreatment and category filter the benefit lines. The totals are calculated only over the lines that remain after filtering.
If an employee has no lines left after filtering, the employee is not included in data.

Response rules#

Each benefit line is unique by category, benefitType and taxTreatment. The same category can appear more than once (for example, food as Flexible Compensation and food as Social Benefit).
Lines with amount 0 are not included.
totals are always returned.
payrollId can be null if the employee has no payroll ID in the company.
Amounts are returned with 2 decimals.
Pagination counts employees, not benefit lines.
Valid combinations
Social Benefit only applies to the food and transport categories. An invalid combination, such as category=nursery with benefitType=social_benefit, returns a 400 error.

Request

Authorization
API Key
Add parameter in header
authorization
Example:
authorization: ********************
or
Path Params

Query Params

Responses

🟢200
application/json
Flexflow benefits for the requested cycle
Bodyapplication/json

🟠400
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://api-public.payflow.es/v2/flexflow/cycles//consumptions?page=&size=&taxId=&personalId=&benefitType=&taxTreatment=&category=' \
--header 'authorization: <api-key>'
Response Response Example
{
    "data": [
        {
            "personalId": "X4004202V",
            "payrollId": "000014",
            "benefits": [
                {
                    "category": "food",
                    "amount": 117.01,
                    "taxTreatment": "exempt",
                    "benefitType": "flexible_remuneration"
                },
                {
                    "category": "transport",
                    "amount": 17.3,
                    "taxTreatment": "exempt",
                    "benefitType": "flexible_remuneration"
                },
                {
                    "category": "nursery",
                    "amount": 150,
                    "taxTreatment": "exempt",
                    "benefitType": "flexible_remuneration"
                },
                {
                    "category": "nursery",
                    "amount": 20,
                    "taxTreatment": "non_exempt",
                    "benefitType": "flexible_remuneration"
                },
                {
                    "category": "education",
                    "amount": 40,
                    "taxTreatment": "exempt",
                    "benefitType": "flexible_remuneration"
                },
                {
                    "category": "education",
                    "amount": 80,
                    "taxTreatment": "non_exempt",
                    "benefitType": "flexible_remuneration"
                },
                {
                    "category": "health_insurance",
                    "amount": 30,
                    "taxTreatment": "exempt",
                    "benefitType": "flexible_remuneration"
                },
                {
                    "category": "health_insurance",
                    "amount": 10,
                    "taxTreatment": "non_exempt",
                    "benefitType": "flexible_remuneration"
                },
                {
                    "category": "food",
                    "amount": 25,
                    "taxTreatment": "exempt",
                    "benefitType": "social_benefit"
                },
                {
                    "category": "food",
                    "amount": 50,
                    "taxTreatment": "non_exempt",
                    "benefitType": "social_benefit"
                },
                {
                    "category": "transport",
                    "amount": 12,
                    "taxTreatment": "exempt",
                    "benefitType": "social_benefit"
                },
                {
                    "category": "transport",
                    "amount": 8,
                    "taxTreatment": "non_exempt",
                    "benefitType": "social_benefit"
                }
            ],
            "totals": {
                "exempt": 391.31,
                "nonExempt": 168,
                "flexibleRemuneration": 464.31,
                "socialBenefit": 95
            }
        }
    ],
    "meta": {
        "total": 1,
        "perPage": 15,
        "currentPage": 1,
        "lastPage": 1
    }
}
Modified at 2026-10-09 02:04:55
Previous
Retrieve Employee Flexflow Transactions
Next
Payment Updates
Built with