List Timesheet Batches

get/public/v1/timesheet-batches

Each batch's payroll_sends reports every attempt to send its shifts to the provider's payroll platform, oldest first.

get/public/v1/timesheet-batches

curl --request GET \
  --url 'https://api.app.astalty.com.au/public/v1/timesheet-batches' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

Response

{
  "data": [
    {
      "id": "t1s2b3a4-t5c6-47h8-9a0b-1c2d3e4f5a6b",
      "start": "2024-01-07T13:00:00+00:00",
      "end": "2024-01-21T12:59:59+00:00",
      "created_at": "2024-01-22T09:30:00+00:00",
      "payroll_sends": [
        {
          "id": "e1m2p3o4-t5h6-47e8-9a0b-1c2d3e4f5a6b",
          "platform": "PayCat",
          "status": "completed",
          "method": "create",
          "total_lines": 42,
          "successful_lines": 42,
          "failed_lines": 0,
          "failed_reason": null,
          "synced_at": "2024-01-22T09:35:00+00:00",
          "created_at": "2024-01-22T09:30:00+00:00"
        }
      ]
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 0,
    "total": 0,
    "allowed_sorts": [
      "string"
    ]
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Query parameters

page[size]integer
Number of results per page. Minimum 1, maximum 100.
Default:25
page[number]integer
The page number to retrieve. Use the last_page value from the meta response to determine the total number of pages available.
Default:1

Response

200application/json

Paginated set of TimesheetBatchResource

dataobject[]required
▶Show 5 child attributesHide child attributes
- idstringrequired
  Example:t1s2b3a4-t5c6-47h8-9a0b-1c2d3e4f5a6b
- startstringrequired
  Example:2024-01-07T13:00:00+00:00
- endstringrequired
  Example:2024-01-21T12:59:59+00:00
- created_atstringrequired
  Example:2024-01-22T09:30:00+00:00
- payroll_sendsobject[]required
  ▶Show 10 child attributesHide child attributes
  idstringrequired
  Example:e1m2p3o4-t5h6-47e8-9a0b-1c2d3e4f5a6b
  platformenum<string>required
  Available options:Employment HeroMYOBPayCatQuickBooks PayrollXeroOther
  statusstringrequired
  Example:completed
  methodstring | nullrequired
  Example:create
  total_linesinteger | nullrequired
  Example:42
  successful_linesinteger | nullrequired
  Example:42
  failed_linesinteger | nullrequired
  Example:0
  failed_reasonstringrequired
  synced_atstring | nullrequired
  Example:2024-01-22T09:35:00+00:00
  created_atstringrequired
  Example:2024-01-22T09:30:00+00:00
metaobjectrequired
▶Show 5 child attributesHide child attributes
- current_pageintegerrequired≥ 1
- last_pageintegerrequired≥ 1
- per_pageintegerrequired≥ 0
  Number of items shown per page.
- totalintegerrequired≥ 0
  Total number of items being paginated.
- allowed_sortsstring[]required
  The list of allowed sorts for this endpoint.

Errors

401Unauthenticated
403Authorization error

Command Palette

Authorization

Query parameters

Response

Errors