Export salary rows
curl --request POST \
--url http://localhost:3000/v2/salaries/exportSalaryRows \
--header 'Content-Type: application/json' \
--header 'x-API-Key: <api-key>' \
--data '
{
"rowSettings": {},
"rowExportSettings": {}
}
'import requests
url = "http://localhost:3000/v2/salaries/exportSalaryRows"
payload = {
"rowSettings": {},
"rowExportSettings": {}
}
headers = {
"x-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({rowSettings: {}, rowExportSettings: {}})
};
fetch('http://localhost:3000/v2/salaries/exportSalaryRows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v2/salaries/exportSalaryRows",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'rowSettings' => [
],
'rowExportSettings' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/v2/salaries/exportSalaryRows"
payload := strings.NewReader("{\n \"rowSettings\": {},\n \"rowExportSettings\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/v2/salaries/exportSalaryRows")
.header("x-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"rowSettings\": {},\n \"rowExportSettings\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/salaries/exportSalaryRows")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"rowSettings\": {},\n \"rowExportSettings\": {}\n}"
response = http.request(request)
puts response.read_body"<string>"Salaries
Export Salary Rows
Export salary rows data immediately and return as ZIP file. This is the main export method for user salaries using salary rows.
POST
/
salaries
/
exportSalaryRows
Export salary rows
curl --request POST \
--url http://localhost:3000/v2/salaries/exportSalaryRows \
--header 'Content-Type: application/json' \
--header 'x-API-Key: <api-key>' \
--data '
{
"rowSettings": {},
"rowExportSettings": {}
}
'import requests
url = "http://localhost:3000/v2/salaries/exportSalaryRows"
payload = {
"rowSettings": {},
"rowExportSettings": {}
}
headers = {
"x-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({rowSettings: {}, rowExportSettings: {}})
};
fetch('http://localhost:3000/v2/salaries/exportSalaryRows', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v2/salaries/exportSalaryRows",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'rowSettings' => [
],
'rowExportSettings' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"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;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "http://localhost:3000/v2/salaries/exportSalaryRows"
payload := strings.NewReader("{\n \"rowSettings\": {},\n \"rowExportSettings\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("http://localhost:3000/v2/salaries/exportSalaryRows")
.header("x-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"rowSettings\": {},\n \"rowExportSettings\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/v2/salaries/exportSalaryRows")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["x-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"rowSettings\": {},\n \"rowExportSettings\": {}\n}"
response = http.request(request)
puts response.read_body"<string>"Authorizations
API-KeyBearer-Auth
Query Parameters
Start date for the salary period (UTC timestamp)
End date for the salary period (UTC timestamp)
Body
application/json
Export settings and configuration
Response
ZIP file containing salary export
The response is of type file.
Was this page helpful?
⌘I

