Banking

Generated from --help output of fob-zb 0.2.1. Every command also accepts the global options --profile <name> (alias --org), --help and --version.

bank-accounts#

bank-accounts list#

fob-zb bank-accounts list

List bank & credit-card accounts

Options:
      --page      Page number                              [number] [default: 1]
      --per-page  Page size (max 200)                    [number] [default: 200]
      --json      Output raw JSON                                      [boolean]
      --fields    Columns to show, comma-separated                      [string]
      --format    Output format. csv/json auto-paginate the full result set
                                      [string] [choices: "table", "csv", "json"]
      --output    Write output to a file instead of stdout              [string]
      --status    Filter by status
                                 [string] [choices: "all", "active", "inactive"]

bank-accounts show#

fob-zb bank-accounts show <id>

Show a bank account by id

Positionals:
  id  Bank account id                                        [string] [required]

Options:
      --json  Output raw JSON                                          [boolean]

bank-accounts create#

fob-zb bank-accounts create

Create a bank / credit-card account

Options:
      --code            Account code                                    [string]
      --account-number  Account number                                  [string]
      --description     Description                                     [string]
      --json            Output raw JSON of the saved record            [boolean]
      --name            Account name                         [string] [required]
      --type            Account type
                            [string] [required] [choices: "bank", "credit_card"]

bank-accounts edit#

fob-zb bank-accounts edit <id>

Update a bank account (only passed flags change)

Positionals:
  id  Bank account id                                        [string] [required]

Options:
      --code            Account code                                    [string]
      --account-number  Account number                                  [string]
      --description     Description                                     [string]
      --json            Output raw JSON of the saved record            [boolean]
      --name            Account name                                    [string]
      --type            Account type   [string] [choices: "bank", "credit_card"]

bank-accounts delete#

fob-zb bank-accounts delete <id>

Delete a bank account (requires --yes)

Positionals:
  id  Bank account id                                        [string] [required]

Options:
  -y, --yes  Confirm deletion                                          [boolean]

bank-accounts activate#

fob-zb bank-accounts activate <id>

Mark a bank account active

Positionals:
  id  Bank account id                                        [string] [required]

bank-accounts deactivate#

fob-zb bank-accounts deactivate <id>

Mark a bank account inactive

Positionals:
  id  Bank account id                                        [string] [required]

bank-transactions#

bank-transactions list#

fob-zb bank-transactions list

List bank / credit-card feed transactions

Options:
      --page        Page number                            [number] [default: 1]
      --per-page    Page size (max 200)                  [number] [default: 200]
      --json        Output raw JSON                                    [boolean]
      --fields      Columns to show, comma-separated                    [string]
      --format      Output format. csv/json auto-paginate the full result set
                                      [string] [choices: "table", "csv", "json"]
      --output      Write output to a file instead of stdout            [string]
      --account-id  Filter by bank account id                           [string]
      --status      Filter by categorization status
  [string] [choices: "all", "uncategorized", "categorized", "matched", "excluded
                                                                              "]

bank-transactions show#

fob-zb bank-transactions show <id>

Show a bank transaction by id

Positionals:
  id  Transaction id                                         [string] [required]

Options:
      --json  Output raw JSON                                          [boolean]

bank-transactions create#

fob-zb bank-transactions create

Manually add a bank transaction

Options:
      --account-id    Bank account id                        [string] [required]
      --type          Transaction type (deposit, transfer_fund, card_payment, ..
                      .)                                     [string] [required]
      --amount        Amount                                 [number] [required]
      --date          Date (YYYY-MM-DD)                      [string] [required]
      --from-account  From account id (offset/source)                   [string]
      --to-account    To account id (transfers)                         [string]
      --description   Description                                       [string]
      --reference     Reference number                                  [string]
      --payment-mode  Payment mode                                      [string]
      --json          Output raw JSON                                  [boolean]

bank-transactions delete#

fob-zb bank-transactions delete <id>

Delete a bank transaction (requires --yes)

Positionals:
  id  Transaction id                                         [string] [required]

Options:
  -y, --yes  Confirm deletion                                          [boolean]

bank-transactions categorize#

fob-zb bank-transactions categorize <id>

Categorize an uncategorized transaction

Positionals:
  id  Transaction id                                         [string] [required]

Options:
      --as         Categorize as
  [string] [required] [choices: "expense", "vendor-payment", "customer-payment",
   "credit-note-refund", "vendor-credit-refund", "payment-refund", "vendor-payme
                                              nt-refund", "transfer", "deposit"]
      --field      Body field "key=value" (repeatable; ids kept as strings)
                                                                         [array]
      --json-body  Full JSON body (merged over --field)                 [string]

bank-transactions match#

fob-zb bank-transactions match <id>

Match an uncategorized transaction to existing records

Positionals:
  id  Transaction id                                         [string] [required]

Options:
      --field      Body field "key=value" (repeatable)                   [array]
      --json-body  Full JSON body (merged over --field)                 [string]

bank-transactions unmatch#

fob-zb bank-transactions unmatch <id>

Remove a match

Positionals:
  id  Transaction id                                         [string] [required]

bank-transactions uncategorize#

fob-zb bank-transactions uncategorize <id>

Revert a categorization

Positionals:
  id  Transaction id                                         [string] [required]

bank-transactions exclude#

fob-zb bank-transactions exclude <id>

Exclude a transaction from books

Positionals:
  id  Transaction id                                         [string] [required]

bank-transactions restore#

fob-zb bank-transactions restore <id>

Restore an excluded transaction

Positionals:
  id  Transaction id                                         [string] [required]