Get Available Earnings - Flux Payroll API

Get all available earnings for Mexico

curl --request GET \
  --url https://api.staging.fluxpayroll.ai/api/mexico-payroll/earnings \
  --header 'x-api-key: <api-key>'

[
  {
    "key": "SALARY",
    "name": "Salario Base",
    "description": "<string>"
  }
]

GET

api

mexico-payroll

earnings

Get all available earnings for Mexico

curl --request GET \
  --url https://api.staging.fluxpayroll.ai/api/mexico-payroll/earnings \
  --header 'x-api-key: <api-key>'

[
  {
    "key": "SALARY",
    "name": "Salario Base",
    "description": "<string>"
  }
]

x-api-key

string

header

required

locale

enum<string>

Locale for translated names and descriptions. Defaults to Spanish (es-MX) if not specified.

Available options:

es-MX,

en-US,

en-MX

List of available earning types

key

string

required

Unique earning code

Example:

"SALARY"

name

string

required

Display name of the earning

Example:

"Salario Base"

description

string

required

Detailed description of the earning type