Customers: organizations commands

Reference for the `revenexx customers-organizations` 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 customers-organizations 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 customers-organizations <command> --help for the live options.

block

Bash
revenexx customers-organizations block \
    --id '' \
    --reason payment_overdue

Flags: --id <id> --reason <reason> --actor <actor> --kind <kind> --note <note>

care

Bash
revenexx customers-organizations care \
    --id ''

Flags: --id <id>

change-credit

Bash
revenexx customers-organizations change-credit \
    --id '' \
    --reason rating_changed

Flags: --id <id> --reason <reason> --credit-limit <credit-limit> --credit-limit-mode <credit-limit-mode> --note <note>

create

Bash
revenexx customers-organizations create \
    --name Beispiel Industrietechnik GmbH

Flags: --name <name> --balance <balance> --balance-due <balance-due> --branche <branche> --created-at <created-at> --credit-limit <credit-limit> --credit-limit-mode <credit-limit-mode> --customer-number <customer-number> --delivery-block [value] --lifecycle-stage <lifecycle-stage> --location-code <location-code> --payment-terms <payment-terms> --price-list <price-list> --settings <settings> --shipping-advice <shipping-advice> --status <status> --vat-id <vat-id>

customers-address-format-get

Bash
revenexx customers-organizations customers-address-format-get \
    --country AC

Flags: --country <country>

customers-address-format-list

Bash
revenexx customers-organizations customers-address-format-list

Flags: --filter <column=value>

customers-addresses-create

Bash
revenexx customers-organizations customers-addresses-create

Flags: --address-line1 <address-line1> --address-line2 <address-line2> --address-line3 <address-line3> --administrative-area-code <administrative-area-code> --administrative-area-name <administrative-area-name> --care-of <care-of> --city <city> --company <company> --contact-id <contact-id> --country <country> --country-code <country-code> --created-at <created-at> --delivery-point-id <delivery-point-id> --delivery-point-type <delivery-point-type> --dependent-locality <dependent-locality> --email <email> --external-id <external-id> --house-number <house-number> --house-number-addition <house-number-addition> --is-default [value] --language-code <language-code> --latin <latin> --locality <locality> --name <name> --name2 <name2> --organization-id <organization-id> --organization-name <organization-name> --phone <phone> --postal-code <postal-code> --recipient-name <recipient-name> --region <region> --script <script> --sorting-code <sorting-code> --street <street> --street2 <street2> --street-name <street-name> --type <type> --validated-at <validated-at> --validation-source <validation-source> --validation-status <validation-status> --zip <zip>

customers-addresses-delete

Bash
revenexx customers-organizations customers-addresses-delete \
    --id ''

Flags: --id <id>

customers-addresses-get

Bash
revenexx customers-organizations customers-addresses-get \
    --id ''

Flags: --id <id>

customers-addresses-list

Bash
revenexx customers-organizations customers-addresses-list

Flags: --id <id> --organization-id <organization-id> --contact-id <contact-id> --type <type> --company <company> --name <name> --name2 <name2> --street <street> --street2 <street2> --zip <zip> --city <city> --region <region> --country <country> --phone <phone> --email <email> --address-line3 <address-line3> --dependent-locality <dependent-locality> --administrative-area-code <administrative-area-code> --sorting-code <sorting-code> --street-name <street-name> --house-number <house-number> --house-number-addition <house-number-addition> --delivery-point-type <delivery-point-type> --delivery-point-id <delivery-point-id> --language-code <language-code> --script <script> --validation-status <validation-status> --validated-at <validated-at> --validation-source <validation-source> --is-default [value] --external-id <external-id> --source-synced-at <source-synced-at> --created-at <created-at> --updated-at <updated-at> --limit <limit> --offset <offset> --order <order> --filter <column=value>

customers-addresses-update

Bash
revenexx customers-organizations customers-addresses-update \
    --id ''

Flags: --id <id> --address-line1 <address-line1> --address-line2 <address-line2> --address-line3 <address-line3> --administrative-area-code <administrative-area-code> --administrative-area-name <administrative-area-name> --care-of <care-of> --city <city> --company <company> --contact-id <contact-id> --country <country> --country-code <country-code> --delivery-point-id <delivery-point-id> --delivery-point-type <delivery-point-type> --dependent-locality <dependent-locality> --email <email> --external-id <external-id> --house-number <house-number> --house-number-addition <house-number-addition> --is-default [value] --language-code <language-code> --latin <latin> --locality <locality> --name <name> --name2 <name2> --organization-id <organization-id> --organization-name <organization-name> --phone <phone> --postal-code <postal-code> --recipient-name <recipient-name> --region <region> --script <script> --sorting-code <sorting-code> --street <street> --street2 <street2> --street-name <street-name> --type <type> --validated-at <validated-at> --validation-source <validation-source> --validation-status <validation-status> --zip <zip>

customers-contact-points-create

Bash
revenexx customers-organizations customers-contact-points-create \
    --kind invoice \
    --organization-id ''

Flags: --kind <kind> --organization-id <organization-id> --address-id <address-id> --created-at <created-at> --email <email> --external-id <external-id> --is-primary [value] --phone <phone> --position <position>

customers-contact-points-delete

Bash
revenexx customers-organizations customers-contact-points-delete \
    --id ''

Flags: --id <id>

customers-contact-points-get

Bash
revenexx customers-organizations customers-contact-points-get \
    --id ''

Flags: --id <id>

customers-contact-points-list

Bash
revenexx customers-organizations customers-contact-points-list

Flags: --id <id> --organization-id <organization-id> --address-id <address-id> --kind <kind> --email <email> --phone <phone> --is-primary [value] --position <position> --external-id <external-id> --source-synced-at <source-synced-at> --created-at <created-at> --updated-at <updated-at> --limit <limit> --offset <offset> --order <order> --filter <column=value>

customers-contact-points-update

Bash
revenexx customers-organizations customers-contact-points-update \
    --id ''

Flags: --id <id> --address-id <address-id> --email <email> --external-id <external-id> --is-primary [value] --kind <kind> --organization-id <organization-id> --phone <phone> --position <position>

customers-derived-refresh

Bash
revenexx customers-organizations customers-derived-refresh

customers-organization-metrics-freshness

Bash
revenexx customers-organizations customers-organization-metrics-freshness

customers-organization-metrics-get

Bash
revenexx customers-organizations customers-organization-metrics-get \
    --id ''

Flags: --id <id>

customers-organization-metrics-list

Bash
revenexx customers-organizations customers-organization-metrics-list

Flags: --id <id> --organization-id <organization-id> --order-count <order-count> --order-count-30d <order-count-30d> --order-count-90d <order-count-90d> --order-count-365d <order-count-365d> --revenue-total <revenue-total> --revenue-30d <revenue-30d> --revenue-90d <revenue-90d> --revenue-365d <revenue-365d> --avg-order-value <avg-order-value> --avg-order-value-365d <avg-order-value-365d> --first-order-at <first-order-at> --last-order-at <last-order-at> --currency <currency> --currency-mixed [value] --orders-as-of <orders-as-of> --computed-at <computed-at> --created-at <created-at> --updated-at <updated-at> --limit <limit> --offset <offset> --order <order> --filter <column=value>

customers-organization-metrics-refresh

Bash
revenexx customers-organizations customers-organization-metrics-refresh

Flags: --as-of <as-of> --cursor <cursor> --organization-ids [organization-ids...]

delete

Bash
revenexx customers-organizations delete \
    --id ''

Flags: --id <id>

get

Bash
revenexx customers-organizations get \
    --id ''

Flags: --id <id>

list

Bash
revenexx customers-organizations list

Flags: --id <id> --name <name> --vat-id <vat-id> --branche <branche> --customer-number <customer-number> --status <status> --block-reason <block-reason> --block-note <block-note> --blocked-at <blocked-at> --blocked-by <blocked-by> --lifecycle-stage <lifecycle-stage> --payment-terms <payment-terms> --credit-limit-mode <credit-limit-mode> --credit-limit <credit-limit> --balance <balance> --balance-due <balance-due> --credit-available <credit-available> --credit-utilisation <credit-utilisation> --price-list <price-list> --shipping-advice <shipping-advice> --location-code <location-code> --delivery-block [value] --delivery-block-reason <delivery-block-reason> --delivery-blocked-at <delivery-blocked-at> --delivery-blocked-by <delivery-blocked-by> --primary-contact-id <primary-contact-id> --parent-organization-id <parent-organization-id> --city <city> --account-manager-name <account-manager-name> --revenue-365d <revenue-365d> --last-order-at <last-order-at> --external-team-id <external-team-id> --external-id <external-id> --source-synced-at <source-synced-at> --deleted-at <deleted-at> --deleted-by <deleted-by> --deleted-by-id <deleted-by-id> --trash-batch <trash-batch> --purge-at <purge-at> --purge-blocked-reason <purge-blocked-reason> --created-at <created-at> --updated-at <updated-at> --trashed <trashed> --limit <limit> --offset <offset> --order <order> --filter <column=value>

onboard

Bash
revenexx customers-organizations onboard \
    --name ''

Flags: --name <name> --account-manager <account-manager> --billing-city <billing-city> --billing-country <billing-country> --billing-street <billing-street> --billing-zip <billing-zip> --branche <branche> --contact-email <contact-email> --contact-first-name <contact-first-name> --contact-job-title <contact-job-title> --contact-last-name <contact-last-name> --contact-phone <contact-phone> --contact-role <contact-role> --customer-number <customer-number> --lifecycle-stage <lifecycle-stage> --payment-terms <payment-terms> --send-invite [value] --vat-id <vat-id>

restore

Bash
revenexx customers-organizations restore \
    --id ''

Flags: --id <id>

set-account-manager

Bash
revenexx customers-organizations set-account-manager \
    --id '' \
    --rep-code ''

Flags: --id <id> --rep-code <rep-code>

set-primary-contact

Bash
revenexx customers-organizations set-primary-contact \
    --id '' \
    --contact-id ''

Flags: --id <id> --contact-id <contact-id>

trash-empty

Bash
revenexx customers-organizations trash-empty

unblock-delivery

Bash
revenexx customers-organizations unblock-delivery \
    --id '' \
    --note ''

Flags: --id <id> --note <note>

unblock-order

Bash
revenexx customers-organizations unblock-order \
    --id '' \
    --note ''

Flags: --id <id> --note <note>

update

Bash
revenexx customers-organizations update \
    --id ''

Flags: --id <id> --balance <balance> --balance-due <balance-due> --branche <branche> --credit-limit <credit-limit> --credit-limit-mode <credit-limit-mode> --customer-number <customer-number> --delivery-block [value] --lifecycle-stage <lifecycle-stage> --location-code <location-code> --name <name> --payment-terms <payment-terms> --price-list <price-list> --settings <settings> --shipping-advice <shipping-advice> --status <status> --vat-id <vat-id>

Was this page helpful?