Skip to navigation

VAT-registration turnover watch for the workspace

View as Markdown

Assesses documented domestic supplies using the subject’s legal-form country and the selected date. Supports reviewed SK/CZ rule versions; language does not choose the rule. Actual threshold crossings are separate from forecast risk. Decimal amounts are strings. Incomplete or unsupported facts carry concrete review reasons. Full VAT payers have applicable:false for current monitoring while stored obligation history remains available. Alert preferences do not suppress calculation or erase obligations. This endpoint is distinct from the self-employed income-tax and levy forecast.

Authentication

AuthorizationBearer

JWT issued via POST /api/v1/auth/sign_in. Used by mobile and SPA clients. Revoked tokens are rejected.

OR
AuthorizationBearer

Lucanto API key. Two prefixes:

  • lct_pat_<random><checksum> — personal access token (owner: User)
  • lct_live_<random><checksum> — workspace token, live data

Issue keys at /settings/api_keys (personal) or /:workspace_id/settings/api_keys (workspace). Plaintext token is shown once and never again.

Path parameters

workspace_idlongRequired>=1
Workspace ID. The numeric ID shown in your URLs.

Query parameters

as_ofdateOptional

ISO date at or before today; defaults to the current date.

Response

OK
applicableboolean
Whether current domestic turnover monitoring applies.
is_vat_payerboolean

Full payer; limited registrations remain monitored.

statusenum
Allowed values:
countrystring or null
as_ofdate
rule_idstring or null
period_keystring or null
periodobject
completeboolean

Compatibility alias for turnover_complete.

turnover_completeboolean
Confirmed subject completeness with no unresolved supply facts.
reasonslist of strings

Concrete missing or unsupported facts, including non-applicability.

needs_reviewlist of strings

Compatibility with reasons; reasons are identifiers for localized explanation.

primary_crossingobject
secondary_crossingobject
obligationslist of objects

Stored event snapshots across periods and country changes; preserved after registration.

limited_registrationbooleanOptional

Slovak § 7/§ 7a registration: a VAT return is filed only for a month in which tax became payable (§ 78(3)), by the 25th of the following month.

turnoverstring or nullOptional
Recorded supported supply value in the selected statutory period.
thresholdstring or nullOptional
threshold_secondarystring or nullOptional
threshold_comparatorenum or nullOptional
Allowed values:
threshold_secondary_comparatorenum or nullOptional
Allowed values:
projected_year_endstring or nullOptional
projected_crossing_datedate or nullOptional

Forecast only; null when no crossing is projected inside the period.

days_to_crossinginteger or nullOptional
progressstring or nullOptional

Clamped fraction 0..1; does not prove an actual crossing.

alert_levelenumOptional
Allowed values:
confidence_scoreintegerOptional
currencystring or nullOptional
effective_payer_ondate or nullOptional
Overall payer effect from the verified upper crossing or active history for this country and period, otherwise the primary crossing.
effective_payer_basisstring or nullOptional

Legal basis of effective_payer_on; individual obligation dates remain unchanged.

obligation_candidateslist of objectsOptional

Errors

401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error