Get Available Earnings - Flux Payroll API

Get all available earnings for Mexico

cURL

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

Python

import requests

url = "https://api.staging.fluxpayroll.ai/api/mexico-payroll/earnings"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

JavaScript (Fetch)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.staging.fluxpayroll.ai/api/mexico-payroll/earnings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.staging.fluxpayroll.ai/api/mexico-payroll/earnings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
?>

Go

package main

import (
    "fmt"
    "net/http"
    "io"
)

func main() {

url := "https://api.staging.fluxpayroll.ai/api/mexico-payroll/earnings"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("x-api-key", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))
}

Unirest (Java)

HttpResponse<String> response = Unirest.get("https://api.staging.fluxpayroll.ai/api/mexico-payroll/earnings")
  .header("x-api-key", "<api-key>")
  .asString();

Ruby

require 'uri'
require 'net/http'

url = URI("https://api.staging.fluxpayroll.ai/api/mexico-payroll/earnings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

Response Codes

• 200: Success
• 400: Bad Request
• 401: Unauthorized

Response

application/json

List of available earning types

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

Example Error Response

{
  "error": "VALIDATION_ERROR",
  "message": "Invalid input data provided",
  "details": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

• x-api-key (string) header required

Query Parameters

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

Available options:

• es-MX
• en-US
• en-MX

Response Items

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