Skip to main content
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",
    "direction": "ASC"
  },
  "filter": {
    "description": {
      "equal": "<string>",
      "notEqual": "<string>",
      "greaterThan": "<string>",
      "greaterThanEqual": "<string>",
      "lessThan": "<string>",
      "lessThanEqual": "<string>",
      "contain": "<string>"
    },
    "status": {
      "in": [
        "ACTIVE"
      ],
      "notIn": [
        "ACTIVE"
      ],
      "equal": "ACTIVE",
      "notEqual": "ACTIVE",
      "greaterThan": "ACTIVE",
      "greaterThanEqual": "ACTIVE",
      "lessThan": "ACTIVE",
      "lessThanEqual": "ACTIVE"
    }
  }
}
'
{
  "result": "SUCCESS",
  "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"
          },
          "amount": 500000,
          "reconciliationMatch": {
            "id": "<string>",
            "apiSourceId": "<string>",
            "amount": 123,
            "date": "2023-12-25",
            "description": "<string>",
            "apiName": "BOX",
            "apiInstitutionId": "<string>"
          }
        }
      ],
      "customData": {
        "internal_key": "some_internal_key",
        "some_other_field": 23434
      }
    }
  ],
  "cursor": {
    "after": "<string>",
    "before": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, see Authentication for more detail.

Body

application/json
cursor
string | null

Cursor from the previous paginated response

limit
integer<int32>

Page size, i.e. number of items to return per page

Required range: x <= 250
sort
object

Sort order for the items in the response.

filter
object

Filter for items in the response.

Response

Success

result
enum<string>

The result of the action performed.

Available options:
SUCCESS,
FAILURE
data
object[]

The data generated by the action performed.

cursor
object

Cursor to be used in your subsequent paginated request. Only populated if there are more pages available.