reseller

POST `/v1/reseller/dunning`

Publish the next version of your ladder.

Autentizace

Zašlete API klíč jako nosný token (bearer token). Klíč musí mít oprávnění reseller.manage; klíč bez něj je odmítnut s kódem 403, nikoli 404.

Sem patří ID vaší organizace

Tento koncový bod přijímá org_id jako parametr dotazu. Pokud ho vynecháte, volání pokryje celý podstrom vašeho nájemce; jeho odesláním volání zúžíte na jednu organizaci.

ID vaší organizace najdete na obrazovce API klíčů ve vašem přehledu, hned vedle samotného klíče. Je to stále stejné ID v každém volání, které provedete.

Vyzvednout

Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.

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> }'

Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API

Podrobnosti

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`.

Parametry

Název	Typ	Požadováno	Co to je
`org_id (query)`	`Uuid`	Ne	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 r…

Tělo požadavku

Název	Typ	Požadováno	Co to je
`steps`	`DunningStep[]`	Ano	—
`reason`	`string`	Ano	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.

Odpověď

Název	Typ	Požadováno	Co to je
`using_platform_default`	`boolean`	Ano	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 rende…
`max_total_days`	`integer`	Ano	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 mid-cl…
`active_version`	`DunningPolicyVersion`	Ano	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[]`	Ano	Every version this reseller has published, newest first.

Chyby, které může tento koncový bod vrátit

401 · 403 · 404 · 422 · 429