Skip to content
Sandbox

Declare what was supplied for an account, over a period

View as Markdown

Coverage is a fact about an account and a period, not about a transaction. It answers "have all the operations on this account between these two dates been supplied to you?", and it exists precisely when there is NO transaction to send: a month with no direct debit is the case where the declaration matters most. That is why it has its own resource rather than a field on the enrichment. Without it, we will never say that a series is late: a missing due date proves nothing as long as we do not know whether the account was being observed, and lifecycle.state stays unknown. And we verify nothing: what you declare is recorded as a caller assertion (caller_asserted). Provenance is not a field you choose. The call is idempotent by construction: intervals that touch are merged, so an hourly synchronisation does not manufacture intervals.

Request

application/jsonCoverageWindow
  • covered_fromstring · daterequired

Response

Coverage recorded, or merged with a neighbour.

application/jsonCoverageWindowResult
  • covered_fromstring · daterequired
  • covered_tostring · daterequired
  • merged_intervalsinteger ≥ 0required
  • policy_versionstringrequired
  • notestring
  • request_idstringrequired

Rate limit

debit_ti_v1operational_burst_protection · token_bucket
120 / min
per key · capacity 120 · refill 2/s
600 / min
per workspace · capacity 600 · refill 10/s

« 120 requetes / minute » est traduit en seau a jetons : capacite 120 (la rafale toleree) rechargee a 2 jetons / seconde (le regime durable). Une clef au repos peut envoyer 120 requetes d'un coup, puis 2 par seconde ; sur la premiere minute apres un repos, jusqu'a 240 passent. Le workspace, lui, borne la somme de toutes ses clefs a 600 / minute (capacite 600, 10 / s) : cent clefs ne font pas cent fois la limite.

This is not: sandbox_lifetime_quota · production_usage_quota · billing_entitlement · commercial_promise

Possible errors

Code
StatusCodeTitle
401invalid_api_keyThe credential presented is not usable.
403account_inactiveThe workspace or organisation is not active.
413request_entity_too_largeThe request body exceeds the limit.
415unsupported_media_typeThe body must be application/json.
429rate_limitedToo many requests.
The rate limit for this key has been reached. Replay after the Retry-After delay.
500internal_errorAn internal error occurred.

All errors

Was this page helpful?