Loyalty: bonus commands

Reference for the `revenexx loyalty-bonus` commands — every subcommand with a runnable example.

Auto-generated. This page is generated from the revenexx CLI by tools/sync-cli-reference.mjs. Don't edit it by hand — your changes will be overwritten.

Every revenexx loyalty-bonus subcommand, with a runnable example and the flags it accepts. Each flag is an API field: its type, allowed values and meaning are in the API reference. Some flag names carry a -_ (e.g. --attribute-_values) — that is the exact token the CLI accepts, so copy them verbatim. Run revenexx loyalty-bonus <command> --help for the live options.

approve

Bash

revenexx loyalty-bonus approve \
    --id ''

Flags: --id <id> --checked-by <checked-by> --receivables-cleared [value]

calculate

Bash

revenexx loyalty-bonus calculate \
    --id '' \
    --data '{ "key": "value" }'

Flags: --id <id> --body <body>

create

Bash

revenexx loyalty-bonus create \
    --organization-id '' \
    --program-id ''

Flags: --organization-id <organization-id> --program-id <program-id> --base-turnover <base-turnover> --contact-id <contact-id> --document-ref <document-ref> --period <period>

entries-correct

Bash

revenexx loyalty-bonus entries-correct \
    --agreement-id '' \
    --amount 9.99 \
    --ref ''

Flags: --agreement-id <agreement-id> --amount <amount> --ref <ref> --at <at> --key <key>

entries-get

Bash

revenexx loyalty-bonus entries-get \
    --id ''

Flags: --id <id>

entries-list

Bash

revenexx loyalty-bonus entries-list

Flags: --limit <limit> --offset <offset> --order <order> --id <id> --agreement-id <agreement-id> --entry-key <entry-key> --source <source> --ref <ref> --order-id <order-id> --filter <column=value>

forfeit

Bash

revenexx loyalty-bonus forfeit \
    --id '' \
    --reason ''

Flags: --id <id> --reason <reason>

get

Bash

revenexx loyalty-bonus get \
    --id ''

Flags: --id <id>

import

Bash

revenexx loyalty-bonus import \
    --rows one two three

Flags: --rows [rows...]

list

Bash

revenexx loyalty-bonus list

Flags: --limit <limit> --offset <offset> --order <order> --id <id> --program-id <program-id> --membership-id <membership-id> --organization-id <organization-id> --period <period> --period-start <period-start> --period-end <period-end> --base-source <base-source> --turnover-source <turnover-source> --reached-tier-id <reached-tier-id> --reached-tier-code <reached-tier-code> --projected-tier-code <projected-tier-code> --currency <currency> --state <state> --receivables-cleared <receivables-cleared> --receivables-checked-by <receivables-checked-by> --forfeit-reason <forfeit-reason> --document-ref <document-ref> --payout-ref <payout-ref> --approved-by <approved-by> --external-id <external-id> --filter <column=value>

pay

Bash

revenexx loyalty-bonus pay \
    --id ''

Flags: --id <id> --payout-ref <payout-ref>

progress

Bash

revenexx loyalty-bonus progress \
    --id ''

Flags: --id <id>

rebuild

Bash

revenexx loyalty-bonus rebuild \
    --id '' \
    --data '{ "key": "value" }'

Flags: --id <id> --body <body>

update

Bash

revenexx loyalty-bonus update \
    --id ''

Flags: --id <id> --base-turnover <base-turnover> --document-ref <document-ref> --metadata <metadata> --turnover-source <turnover-source>

Was this page helpful?