---
title: "Get sync status flags"
method: POST
path: "/onboarding/getSyncStatus"
tags: ["onboarding", "sync"]
---

# Get sync status flags

`POST /onboarding/getSyncStatus`

Returns whether each resource has changes after the supplied resource cursor. It returns flags only, never records or affected IDs.

## Request body

- object
  - `last_synced_dates` object — Per-resource ISO-8601 UTC timestamps from the last successfully completed pull.
    - `profile` string, date-time
    - `clients` string, date-time
    - `discounts` string, date-time
    - `tax` string, date-time
    - `business_goods` string, date-time
    - `documents` string, date-time
    - `document_items` string, date-time
    - `time_entries` string, date-time
    - `document_preferences` string, date-time
    - `app_version` string, date-time
  - `platform` 'ios' | 'android' — Required to evaluate the platform-specific app_version flag and to update device information when device_id is also supplied.
  - `last_synced_date` string, date-time — Compatibility fallback applied to every resource when per-resource dates are absent.
  - `last_sync_dates` object — Compatibility alias for last_synced_dates.
  - `last_sync_date` string, date-time — Compatibility alias for last_synced_date.

## Response `200`

Sync flags returned.

- SyncStatusEnvelope
  - `status` 'success'
  - `statusCode` integer
  - `message` string
  - `data` object
    - `server_timestamp` string, date-time
    - `sync_required` object
      - `profile` boolean
      - `clients` boolean
      - `discounts` boolean
      - `tax` boolean
      - `business_goods` boolean
      - `documents` boolean
      - `document_items` boolean
      - `time_entries` boolean
      - `document_preferences` boolean
      - `app_version` boolean
  - `error` unknown

## Other responses

- `401` — Standard API error envelope.
- `403` — Standard API error envelope.
- `412` — Standard API error envelope.

---

[API](https://skmtc.dev/wowinvoice/apis/wow-invoice-internal-api.md) · [All operations](https://skmtc.dev/wowinvoice/apis/wow-invoice-internal-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/wowinvoice/wow-invoice-internal-api/revisions/9f6951d767bb/schema)