Skip to content
fakturownia-clients logo

fakturownia-clients

Fakturownia CLI clients: list, fetch, create, update, and delete clients, and inspect README-backed client fields and request schemas.

SKILL.md

Full skill instructions

Auto-generated by go run ./​cmd/​gen-skills. Do not edit manually.

Clients

PREREQUISITE: Read fakturownia-shared first.

Use This Skill When

  • The task is about reading or mutating clients, including lookup by external ID.
  • You need to build a client payload from README-backed field definitions and inspect request_body_schema before create or update calls.

Covered Commands

  • fakturownia client list — List clients
  • fakturownia client get — Fetch a single client by ID or external ID
  • fakturownia client create — Create a client
  • fakturownia client update — Update a client
  • fakturownia client delete — Delete a client

Notable Flags

  • --page (default 1): Requested result page
  • --per-page (default 25): Requested result count per page
  • --name: Filter by client name
  • --email: Filter by client email
  • --shortcut: Filter by client shortcut
  • --tax-no: Filter by client tax number
  • --external-id: Filter by external client ID
  • --id: Client ID
  • --input (required): Client JSON input as inline JSON, @file, or - for stdin
  • --yes (required, default false): Confirm client deletion

Environment

  • FAKTUROWNIA_PROFILE: Select a profile unless --profile is provided
  • FAKTUROWNIA_URL: Override the base account URL from any profile
  • FAKTUROWNIA_API_TOKEN: Override the API token from any profile

Output and Request Discovery

  • Use fakturownia schema client list --json and fakturownia schema client get --json before building selectors.
  • Read output.known_fields to discover README-backed client output fields such as name, tax_no, or tag_list[].
  • Use fakturownia schema client create --json and fakturownia schema client update --json to inspect request_body_schema and accepted --input modes.
  • --input accepts inline JSON, @file, or - for stdin, and the CLI wraps the inner object into the upstream client envelope.

Examples

fakturownia client list --json
fakturownia client list --name Acme --columns id,name,email,country
fakturownia client list --external-id ext-123 --json
fakturownia client list --page 2 --per-page 25 --raw
fakturownia client get --id 123
fakturownia client get --external-id ext-123 --json
fakturownia client get --id 123 --fields id,name,email --json
fakturownia client get --id 123 --raw
fakturownia client create --input '{"name":"Acme","email":"[email protected]"}' --json
fakturownia client create --input @client.json
printf '%s\n' '{"name":"Acme","company":"1"}' | fakturownia client create --input - --json
fakturownia client create --input '{"name":"Acme"}' --dry-run --json
fakturownia client update --id 123 --input '{"email":"[email protected]"}' --json
fakturownia client update --id 123 --input @client-update.json
printf '%s\n' '{"phone":"123456789"}' | fakturownia client update --id 123 --input - --json
fakturownia client update --id 123 --input '{"city":"Warsaw"}' --dry-run --json
fakturownia client delete --id 123 --yes --json
fakturownia client delete --id 123 --yes
fakturownia client delete --id 123 --yes --dry-run --json

Related Skills