TRtrytoku
Sin catalogar

Listar las asignaciones de charge schedule strategies

Changed on

Lista las asignaciones de charge schedule strategies de una Organization.

get/{country_code}/public/charge-schedules/assignments

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/{country_code}/public/charge-schedules/assignments
  • Auth
    API key in header x-api-key

Path parameters

country_code'cl' | 'mx' | 'br' required

Códigos de país admitidos en el prefijo de ruta /{country_code}.

Código de país (ISO alpha-2 en minúsculas) que acota la operación.

Query parameters

accountsinteger[]
statusChargeScheduleStrategyAssignmentStatus[]
periodicityRecurrencePeriodicity[]
strategy_typeStrategyType[]

Headers

x-account-keystring

Llave de API de una Account, para operar sobre esa Account en lugar de la principal.

Response

Successful Response

assignment_status'DRAFT' | 'ACTIVE' | 'PAUSED' | 'DISABLED' | 'DELETED' required

Estado de la asignación entre una estrategia de calendario de cobro y una cuenta: es el interruptor con que se prende y se apaga el cobro recurrente. Solo una asignación ACTIVE genera fechas de cobro.

DRAFT es el estado inicial, que permite dejar una asignación configurada sin cobrar todavía. Pasarla a PAUSED o a DISABLED cancela sus fechas pendientes; la diferencia es quién la apaga y qué pasa después: PAUSED es una pausa pedida por la organización y DISABLED es la que aplica Toku cuando la cuenta u organización deja de estar vigente, que además impide que se vuelva a crear una asignación por defecto. DELETED es terminal.

Las transiciones válidas son DRAFT → ACTIVE, ACTIVE ⇄ PAUSED, ACTIVE/PAUSED → DISABLED, DISABLED/PAUSED → ACTIVE, y cualquiera → DELETED; el resto se rechaza.

associated_accountsinteger[]
id_accountinteger required
id_charge_schedule_strategystring required
id_charge_schedule_strategy_assignmentstring required
is_editableboolean required
next_charge_datestring date-time
process_toku_productstring
strategy_namestring required
strategy_status'DRAFT' | 'ACTIVE' | 'INACTIVE' | 'DEPRECATED' | 'DELETED' required

Estado de una estrategia de calendario de cobro, la definición reutilizable de cuándo cobrar (periodicidad, calendario, offsets, reintentos). Solo una estrategia ACTIVE genera fechas de cobro y solo una ACTIVE puede activarse en una cuenta.

DRAFT es el estado con que nace una estrategia creada por API: se puede editar, pero ninguna asignación suya se puede activar mientras siga ahí. Pasar una estrategia a INACTIVE cancela las fechas de cobro que tenía pendientes y deja de generar nuevas. DELETED es terminal y solo lo aplica Toku cuando se borra la última asignación que apuntaba a una estrategia propia de la organización. DEPRECATED se acepta y se persiste, pero hoy no tiene comportamiento propio: se comporta como cualquier estado distinto de ACTIVE.

type'TOKU' | 'CUSTOM'

Si una asignación usa una estrategia mantenida por Toku (TOKU) o una creada por la propia organización (CUSTOM).

Changes