# Payflow API

## Docs
- Guides [API Integration guide](https://docs.payflow.es/api-integration-guide-2287236m0.md): 
- Definitions > Employees [Employee Statuses](https://docs.payflow.es/employee-statuses-2152772m0.md): 
- Definitions > Employees [Salary Concepts](https://docs.payflow.es/salary-concepts-2152787m0.md): 
- Definitions > Payments [Payment Lifecycle](https://docs.payflow.es/payment-lifecycle-2152794m0.md): 
- Notifications Structure [Payment Updates](https://docs.payflow.es/payment-updates-2152357m0.md): 

## API Docs
- Explore our Public API > Auth & Health [Health](https://docs.payflow.es/health-34906444e0.md): Verifies that the service is operational and able to handle requests.
- Explore our Public API > Auth & Health [Test an API Key](https://docs.payflow.es/test-an-api-key-34906445e0.md): Verifies that the provided API key is valid and returns the associated company name.
- Explore our Public API > Company [Retrieve your Company Details](https://docs.payflow.es/retrieve-your-company-details-34906446e0.md): Retrieves the complete company configuration available to the authenticated integration.
- Explore our Public API > Employee [Retrieve an Employee](https://docs.payflow.es/retrieve-an-employee-34906447e0.md): Retrieves employee information using one of the supported identifiers.
- Explore our Public API > Employee [Retrieve all Employees](https://docs.payflow.es/retrieve-all-employees-34906448e0.md): Retrieves employee information for all employees in the company.
- Explore our Public API > Employee [Retrieve all Employees (V1.1)](https://docs.payflow.es/retrieve-all-employees-v1-1-34906449e0.md): Retrieves employee information for all employees in the company with pagination support.
- Explore our Public API > Employee [Create an Employee](https://docs.payflow.es/create-an-employee-34906450e0.md): Creates a new employee in the company.
- Explore our Public API > Employee [Upsert Employees in Bulk](https://docs.payflow.es/upsert-employees-in-bulk-34906451e0.md): Creates or updates company employees in bulk.
- Explore our Public API > Employee [Update an Employee by Personal ID](https://docs.payflow.es/update-an-employee-by-personal-id-34906453e0.md): Updates an employee identified by their `personalId`. Only include the fields you want to update in the request body.
- Explore our Public API > Employee [Update an Employee by Payflow ID](https://docs.payflow.es/update-an-employee-by-payflow-id-34906454e0.md): Updates an employee identified by their `id` (Payflow internal employee ID). Only include the fields you want to update in the request body.
- Explore our Public API > Employee [Update an Employee by Payroll ID](https://docs.payflow.es/update-an-employee-by-payroll-id-34906455e0.md): Updates an employee identified by their `payrollId`. Only include the fields you want to update in the request body.
- Explore our Public API > Leaves [Retrieve all Employees on Leave](https://docs.payflow.es/retrieve-all-employees-on-leave-34906459e0.md): Retrieves all employees currently marked with the `on_leave` status.
- Explore our Public API > Leaves [Create an Employee Leave](https://docs.payflow.es/create-an-employee-leave-34906460e0.md): Creates a temporary leave for an employee, effective immediately and lasting until the provided `endDate`.
- Explore our Public API > Leaves [Remove an Employee Leave](https://docs.payflow.es/remove-an-employee-leave-34906461e0.md): Cancels the leave for the specified employee using their `personalId`.
- Explore our Public API > Payments [Retrieve a Payment](https://docs.payflow.es/retrieve-a-payment-34906464e0.md): Returns the payment associated with the provided identifier.
- Explore our Public API > Payments [Retrieve all Payments](https://docs.payflow.es/retrieve-all-payments-34906462e0.md): Retrieves all EWA payments requested by company employees during a specific period or payment cycle.
- Explore our Public API > Payments [Retrieve Employee Payments](https://docs.payflow.es/retrieve-employee-payments-34906463e0.md): Retrieves all EWA payments associated with a specific employee, identified by their personalId, during a given period or payment cycle.
- Explore our Public API > Payments [Calculate Employee Available Amount](https://docs.payflow.es/calculate-employee-available-amount-34906470e0.md): Retrieves the amount currently available for an employee to withdraw through Payflow.
- Explore our Public API > Payments [Request a Payment](https://docs.payflow.es/request-a-payment-34906467e0.md): Creates an EWA payment request for a specific employee.
- Explore our Public API > Payments [Subscribe to Payment Updates](https://docs.payflow.es/subscribe-to-payment-updates-34906468e0.md): Configures a webhook URL to receive payment status updates from Payflow.
- Explore our Public API > Payments [Mark Payments as Informed](https://docs.payflow.es/mark-payments-as-informed-34906469e0.md): Marks one or more payments as informed to your payroll software.
- Explore our Public API > Flexflow [Retrieve all Flexflow Transactions](https://docs.payflow.es/retrieve-all-flexflow-transactions-34906471e0.md): Retrieves the total Flexible Compensation transaction amounts per category for employees who used the benefit during the cycle specified in the `cycle` query parameter.
- Explore our Public API > Flexflow [Retrieve Employee Flexflow Transactions](https://docs.payflow.es/retrieve-employee-flexflow-transactions-34906472e0.md): Retrieves the total Flexible Compensation transaction amounts per category for a specific employee during the cycle specified in the `cycle` query parameter.

## Schemas
- Company [Company Response](https://docs.payflow.es/company-response-14956164d0.md): 
- Employee [ES | Create Employee Request](https://docs.payflow.es/es-create-employee-request-14932018d0.md): 
- Employee [ES | Update Employee Request](https://docs.payflow.es/es-update-employee-request-14955557d0.md): 
- Employee [ES | Employee Response](https://docs.payflow.es/es-employee-response-14894335d0.md): 
- Employee [Create Employee Leave Request](https://docs.payflow.es/create-employee-leave-request-14956204d0.md): 
- Payment [Payment Response](https://docs.payflow.es/payment-response-14974000d0.md): 
- Payment [Payment Response Convoluted](https://docs.payflow.es/payment-response-convoluted-14974001d0.md): 
- Payment [Payment Update](https://docs.payflow.es/payment-update-14976685d0.md): 
- Flexflow [Employee Flexflow Transactions](https://docs.payflow.es/employee-flexflow-transactions-14978165d0.md): 
- Error [Generic Error Response](https://docs.payflow.es/generic-error-response-14954817d0.md):