reseller
GET /v1/reseller/dunning
Your own dunning ladder, and its history.
Аутентификација
Пошаљите API кључ као bearer токен. Кључ мора имати дозволу reseller.view; кључ без ње се одбија уз 403, а не 404.
Где се уноси ID ваше организације
Ова крајња тачка прихвата org_id као параметар упита. Изоставите га и позив ће обухватити цело подстабло вашег закупа; пошаљите га да бисте сузили позив на једну организацију.
Идентификатор ваше организације се налази на екрану са API кључевима на вашој контролној табли, поред самог кључа. То је исти идентификатор у сваком позиву који упутите.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X GET https://api.zinndigital.com/v1/reseller/dunning \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Детаљи
The schedule your clients are chased on when a payment fails - your retry timings, your grace period, your suspension threshold and your own reminder copy. If you have not published one, this answers using_platform_default: true with the rungs your clients actually climb today, because the platform ladder is the fallback. It never returns an empty ladder: that would describe a system in which nobody is chased at all. Requires reseller.view.
Параметри
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
org_id (query) | Uuid | Не | Which of your organizations this applies to. Required only when you belong to more than one here - otherwise it is inferred, and an id outside your direct memberships is a 404… |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
using_platform_default | boolean | Да | True when the reseller has published no ladder of their own. active_version then carries the PLATFORM rungs their clients are chased on today, so the screen never has to render… |
max_total_days | integer | Да | The longest a whole ladder may run. A hard coupling, not a preference: the rebill workflow's execution timeout is derived from it, and a longer ladder would be terminated… |
active_version | DunningPolicyVersion | Да | The ladder in force. On the platform-default view this is synthesised rather than read from a row, so id is null and version is 0. |
versions | DunningPolicyVersion[] | Да | Every version this reseller has published, newest first. |
Грешке које ова крајња тачка може вратити
401 · 403 · 404 · 429