reseller
POST /v1/reseller/dunning
Publish the next version of your ladder.
Аутентификација
Пошаљите API кључ као bearer токен. Кључ мора имати дозволу reseller.manage; кључ без ње се одбија уз 403, а не 404.
Где се уноси ID ваше организације
Ова крајња тачка прихвата org_id као параметар упита. Изоставите га и позив ће обухватити цело подстабло вашег закупа; пошаљите га да бисте сузили позив на једну организацију.
Идентификатор ваше организације се налази на екрану са API кључевима на вашој контролној табли, поред самог кључа. То је исти идентификатор у сваком позиву који упутите.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X POST https://api.zinndigital.com/v1/reseller/dunning \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "steps": <DunningStep[]>, "reason": <string> }'Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом API-ју како бисте могли да видите стварни одговор. Отворите ову крајњу тачку у API конзоли
Детаљи
Publishing, never editing. A ladder changed while customers are halfway up it must not change what those customers were already told, so every save is a new immutable version and runs already climbing keep the one they started on. A 422 carries the validator's own sentence, naming which rung is wrong and why - a warn whose grace disagrees with the next rung would tell a customer a deadline that is not the deadline. Requires reseller.manage.
Параметри
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
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… |
Тело захтева
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
steps | DunningStep[] | Да | — |
reason | string | Да | Why it changed. Required: a ladder decides when a paying customer is suspended, and a version with no reason is one nobody can explain a year later. |
Одговор
| Назив | Тип | Обавезно | Шта је ово |
|---|---|---|---|
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 · 422 · 429