Get employees' salary account balances at a date

Returns each active employee's balance on one salary account at the end of a date (or one employee's, with userId).

For salaryAccountId and balanceDate, returns one row per active employee of the account — user ID, first and last name and AccountBalance (balance at the end of balanceDate, 2 decimals), ordered by user ID and paged. With userId only that employee is returned. Inactive (deactivated) users are never included.

Use it to:

Payroll export: read flex / vacation balances of all employees at period end.
Show one employee's balance in an HR portal (with userId).

Not for:

Posting history — this returns balances only.

Behaviour:

Idempotent.
Safe to retry. Call first: GET /v1/salary-account

See also: POST /v1/salary-account/{salaryAccountId}/posting

curl -X GET "https://app3.timelog.com/your-account/api/v1/salary-account/123/aggregation?balanceDate=2024-12-25T10%3A00%3A00Z&userId=123&$page=1&$pagesize=10" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

import requests
import json

url = "https://app3.timelog.com/your-account/api/v1/salary-account/123/aggregation?balanceDate=2024-12-25T10%3A00%3A00Z&userId=123&$page=1&$pagesize=10"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}

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

const response = await fetch("https://app3.timelog.com/your-account/api/v1/salary-account/123/aggregation?balanceDate=2024-12-25T10%3A00%3A00Z&userId=123&$page=1&$pagesize=10", {
  method: "GET",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
)

func main() {

    req, err := http.NewRequest("GET", "https://app3.timelog.com/your-account/api/v1/salary-account/123/aggregation?balanceDate=2024-12-25T10%3A00%3A00Z&userId=123&$page=1&$pagesize=10", nil)
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://app3.timelog.com/your-account/api/v1/salary-account/123/aggregation?balanceDate=2024-12-25T10%3A00%3A00Z&userId=123&$page=1&$pagesize=10')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'

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

{
  "Properties": {
    "TotalRecord": "example_string",
    "TotalPage": "example_string",
    "PageNumber": "example_string"
  },
  "Entities": [
    {
      "Properties": {
        "SalaryAccountID": 123,
        "UserID": 123,
        "FirstName": "John Doe",
        "LastName": "John Doe",
        "AccountBalance": 3.14
      },
      "Links": [
        {
          "Href": "example_string",
          "Rel": "example_string"
        }
      ],
      "Actions": [
        {}
      ]
    }
  ],
  "Links": [
    {
      "Href": "example_string",
      "Rel": "example_string"
    }
  ]
}

{
  "Code": 200,
  "Details": [
    "The BalanceDate field is required."
  ],
  "Message": "Invalid model state error.",
  "Parameters": "model: {"UserId":null,"BalanceDate":"0001-01-01T00:00:00"}",
  "Url": "https://app{server-number}.timelog.com/{account}/api/v1/salary-account/1/aggregation"
}

{
  "Code": 100,
  "Message": "Unknown error occur in system, please contact system administrator.",
  "Details": [],
  "Parameters": "…",
  "Url": "https://app{server-number}.timelog.com/{account}/api/v1/salary-account/{salaryAccountId}/aggregation"
}

GET

/v1/salary-account/{salaryAccountId}/aggregation

GET

Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token

OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp). The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user.

path

salaryAccountIdinteger

Required

Unknown ID → 200 with no Entities.

Format: int32

query

balanceDatestring

Required

The date whose end-of-day balance is returned. Only the date part is used. Date only — no time component.

Format: date-time

query

userIdinteger

Limit to one employee (must be > 0). Omitted → all active employees.

Format: int32

Page number.

Page size. No maximum enforced in the API layer.

Request Preview

Response

Response will appear here after sending the request

Authentication

header

Authorizationstring

Required

Bearer token. OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp).

The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user.