Query payroll
curl --request POST \
--url https://sandbox.tight.com/v6/payroll/query \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cursor": "<string>",
"limit": 123,
"sort": {
"orderBy": "DATE"
},
"filter": {
"search": "<string>",
"description": {
"equal": "<string>",
"notEqual": "<string>",
"greaterThan": "<string>",
"greaterThanEqual": "<string>",
"lessThan": "<string>",
"lessThanEqual": "<string>",
"contain": "<string>"
},
"status": {
"in": [],
"notIn": []
}
}
}
'import requests
url = "https://sandbox.tight.com/v6/payroll/query"
payload = {
"cursor": "<string>",
"limit": 123,
"sort": { "orderBy": "DATE" },
"filter": {
"search": "<string>",
"description": {
"equal": "<string>",
"notEqual": "<string>",
"greaterThan": "<string>",
"greaterThanEqual": "<string>",
"lessThan": "<string>",
"lessThanEqual": "<string>",
"contain": "<string>"
},
"status": {
"in": [],
"notIn": []
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cursor: '<string>',
limit: 123,
sort: {orderBy: 'DATE'},
filter: {
search: '<string>',
description: {
equal: '<string>',
notEqual: '<string>',
greaterThan: '<string>',
greaterThanEqual: '<string>',
lessThan: '<string>',
lessThanEqual: '<string>',
contain: '<string>'
},
status: {in: [], notIn: []}
}
})
};
fetch('https://sandbox.tight.com/v6/payroll/query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.tight.com/v6/payroll/query",
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([
'cursor' => '<string>',
'limit' => 123,
'sort' => [
'orderBy' => 'DATE'
],
'filter' => [
'search' => '<string>',
'description' => [
'equal' => '<string>',
'notEqual' => '<string>',
'greaterThan' => '<string>',
'greaterThanEqual' => '<string>',
'lessThan' => '<string>',
'lessThanEqual' => '<string>',
'contain' => '<string>'
],
'status' => [
'in' => [
],
'notIn' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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 := "https://sandbox.tight.com/v6/payroll/query"
payload := strings.NewReader("{\n \"cursor\": \"<string>\",\n \"limit\": 123,\n \"sort\": {\n \"orderBy\": \"DATE\"\n },\n \"filter\": {\n \"search\": \"<string>\",\n \"description\": {\n \"equal\": \"<string>\",\n \"notEqual\": \"<string>\",\n \"greaterThan\": \"<string>\",\n \"greaterThanEqual\": \"<string>\",\n \"lessThan\": \"<string>\",\n \"lessThanEqual\": \"<string>\",\n \"contain\": \"<string>\"\n },\n \"status\": {\n \"in\": [],\n \"notIn\": []\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("https://sandbox.tight.com/v6/payroll/query")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"cursor\": \"<string>\",\n \"limit\": 123,\n \"sort\": {\n \"orderBy\": \"DATE\"\n },\n \"filter\": {\n \"search\": \"<string>\",\n \"description\": {\n \"equal\": \"<string>\",\n \"notEqual\": \"<string>\",\n \"greaterThan\": \"<string>\",\n \"greaterThanEqual\": \"<string>\",\n \"lessThan\": \"<string>\",\n \"lessThanEqual\": \"<string>\",\n \"contain\": \"<string>\"\n },\n \"status\": {\n \"in\": [],\n \"notIn\": []\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.tight.com/v6/payroll/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cursor\": \"<string>\",\n \"limit\": 123,\n \"sort\": {\n \"orderBy\": \"DATE\"\n },\n \"filter\": {\n \"search\": \"<string>\",\n \"description\": {\n \"equal\": \"<string>\",\n \"notEqual\": \"<string>\",\n \"greaterThan\": \"<string>\",\n \"greaterThanEqual\": \"<string>\",\n \"lessThan\": \"<string>\",\n \"lessThanEqual\": \"<string>\",\n \"contain\": \"<string>\"\n },\n \"status\": {\n \"in\": [],\n \"notIn\": []\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "prl_12345",
"status": "ACTIVE",
"date": "2024-01-15",
"amount": 123,
"description": "Payroll Period 01/01/2024 - 01/15/2024",
"notes": "Check #1234 issued 2024-01-15",
"apiName": "GUSTO",
"apiSourceId": "gst_payroll_20240115",
"children": [
{
"id": "pli_12345",
"type": "STAFF_WAGES",
"glAccount": {
"id": "gla_38560327",
"name": "Officer(s) Salaries and Wages",
"accountNo": "60210",
"type": "EXPENSE",
"iconUrl": "https://cdn.sandbox.tight.com/icons/glAccountTypes/expense.png",
"displayName": "#60210 Officer(s) Salaries and Wages"
},
"amount": 500000,
"reconciliationMatch": {
"id": "<string>",
"apiSourceId": "<string>",
"amount": 123,
"date": "2023-12-25",
"description": "<string>",
"apiInstitutionId": "<string>",
"bankAccount": {
"id": "bka_7542850",
"name": "Business Checking",
"displayName": "Business Checking *1687"
}
}
}
],
"customData": {
"internal_key": "some_internal_key",
"some_other_field": 23434
}
}
],
"cursor": {
"after": "<string>",
"before": "<string>"
}
}{
"result": "FAILURE",
"error": [
{
"type": "REQUIRED",
"message": "Amount is required",
"param": "amount"
}
]
}{
"result": "FAILURE",
"error": [
{
"type": "INVALID_TOKEN",
"message": "Invalid access token"
}
]
}{
"result": "FAILURE",
"error": [
{
"type": "FORBIDDEN",
"message": "Expired access token"
}
]
}{
"result": "FAILURE",
"error": [
{
"type": "BAD_REQUEST",
"message": "Resource not found"
}
]
}{
"result": "FAILURE",
"error": [
{
"type": "UNKNOWN_ERROR",
"message": "Something went wrong. Please try again later."
}
]
}Payroll
Query payroll
Query payroll for the authenticated user
POST
/
v6
/
payroll
/
query
Query payroll
curl --request POST \
--url https://sandbox.tight.com/v6/payroll/query \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"cursor": "<string>",
"limit": 123,
"sort": {
"orderBy": "DATE"
},
"filter": {
"search": "<string>",
"description": {
"equal": "<string>",
"notEqual": "<string>",
"greaterThan": "<string>",
"greaterThanEqual": "<string>",
"lessThan": "<string>",
"lessThanEqual": "<string>",
"contain": "<string>"
},
"status": {
"in": [],
"notIn": []
}
}
}
'import requests
url = "https://sandbox.tight.com/v6/payroll/query"
payload = {
"cursor": "<string>",
"limit": 123,
"sort": { "orderBy": "DATE" },
"filter": {
"search": "<string>",
"description": {
"equal": "<string>",
"notEqual": "<string>",
"greaterThan": "<string>",
"greaterThanEqual": "<string>",
"lessThan": "<string>",
"lessThanEqual": "<string>",
"contain": "<string>"
},
"status": {
"in": [],
"notIn": []
}
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
cursor: '<string>',
limit: 123,
sort: {orderBy: 'DATE'},
filter: {
search: '<string>',
description: {
equal: '<string>',
notEqual: '<string>',
greaterThan: '<string>',
greaterThanEqual: '<string>',
lessThan: '<string>',
lessThanEqual: '<string>',
contain: '<string>'
},
status: {in: [], notIn: []}
}
})
};
fetch('https://sandbox.tight.com/v6/payroll/query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.tight.com/v6/payroll/query",
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([
'cursor' => '<string>',
'limit' => 123,
'sort' => [
'orderBy' => 'DATE'
],
'filter' => [
'search' => '<string>',
'description' => [
'equal' => '<string>',
'notEqual' => '<string>',
'greaterThan' => '<string>',
'greaterThanEqual' => '<string>',
'lessThan' => '<string>',
'lessThanEqual' => '<string>',
'contain' => '<string>'
],
'status' => [
'in' => [
],
'notIn' => [
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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 := "https://sandbox.tight.com/v6/payroll/query"
payload := strings.NewReader("{\n \"cursor\": \"<string>\",\n \"limit\": 123,\n \"sort\": {\n \"orderBy\": \"DATE\"\n },\n \"filter\": {\n \"search\": \"<string>\",\n \"description\": {\n \"equal\": \"<string>\",\n \"notEqual\": \"<string>\",\n \"greaterThan\": \"<string>\",\n \"greaterThanEqual\": \"<string>\",\n \"lessThan\": \"<string>\",\n \"lessThanEqual\": \"<string>\",\n \"contain\": \"<string>\"\n },\n \"status\": {\n \"in\": [],\n \"notIn\": []\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("https://sandbox.tight.com/v6/payroll/query")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"cursor\": \"<string>\",\n \"limit\": 123,\n \"sort\": {\n \"orderBy\": \"DATE\"\n },\n \"filter\": {\n \"search\": \"<string>\",\n \"description\": {\n \"equal\": \"<string>\",\n \"notEqual\": \"<string>\",\n \"greaterThan\": \"<string>\",\n \"greaterThanEqual\": \"<string>\",\n \"lessThan\": \"<string>\",\n \"lessThanEqual\": \"<string>\",\n \"contain\": \"<string>\"\n },\n \"status\": {\n \"in\": [],\n \"notIn\": []\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.tight.com/v6/payroll/query")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"cursor\": \"<string>\",\n \"limit\": 123,\n \"sort\": {\n \"orderBy\": \"DATE\"\n },\n \"filter\": {\n \"search\": \"<string>\",\n \"description\": {\n \"equal\": \"<string>\",\n \"notEqual\": \"<string>\",\n \"greaterThan\": \"<string>\",\n \"greaterThanEqual\": \"<string>\",\n \"lessThan\": \"<string>\",\n \"lessThanEqual\": \"<string>\",\n \"contain\": \"<string>\"\n },\n \"status\": {\n \"in\": [],\n \"notIn\": []\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "prl_12345",
"status": "ACTIVE",
"date": "2024-01-15",
"amount": 123,
"description": "Payroll Period 01/01/2024 - 01/15/2024",
"notes": "Check #1234 issued 2024-01-15",
"apiName": "GUSTO",
"apiSourceId": "gst_payroll_20240115",
"children": [
{
"id": "pli_12345",
"type": "STAFF_WAGES",
"glAccount": {
"id": "gla_38560327",
"name": "Officer(s) Salaries and Wages",
"accountNo": "60210",
"type": "EXPENSE",
"iconUrl": "https://cdn.sandbox.tight.com/icons/glAccountTypes/expense.png",
"displayName": "#60210 Officer(s) Salaries and Wages"
},
"amount": 500000,
"reconciliationMatch": {
"id": "<string>",
"apiSourceId": "<string>",
"amount": 123,
"date": "2023-12-25",
"description": "<string>",
"apiInstitutionId": "<string>",
"bankAccount": {
"id": "bka_7542850",
"name": "Business Checking",
"displayName": "Business Checking *1687"
}
}
}
],
"customData": {
"internal_key": "some_internal_key",
"some_other_field": 23434
}
}
],
"cursor": {
"after": "<string>",
"before": "<string>"
}
}{
"result": "FAILURE",
"error": [
{
"type": "REQUIRED",
"message": "Amount is required",
"param": "amount"
}
]
}{
"result": "FAILURE",
"error": [
{
"type": "INVALID_TOKEN",
"message": "Invalid access token"
}
]
}{
"result": "FAILURE",
"error": [
{
"type": "FORBIDDEN",
"message": "Expired access token"
}
]
}{
"result": "FAILURE",
"error": [
{
"type": "BAD_REQUEST",
"message": "Resource not found"
}
]
}{
"result": "FAILURE",
"error": [
{
"type": "UNKNOWN_ERROR",
"message": "Something went wrong. Please try again later."
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, see Authentication for more detail.
Body
application/json
Response
Success
The result of the action performed.
Available options:
SUCCESS, FAILURE The data generated by the action performed.
Show child attributes
Show child attributes
Cursor to be used in your subsequent paginated request. Only populated if there are more pages available.
Show child attributes
Show child attributes
⌘I